.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXapm_paraprobe_tool_config.nxdl.xml -- DO NOT EDIT .. index:: ! NXapm_paraprobe_tool_config (application definition) ! apm_paraprobe_tool_config (application definition) see: apm_paraprobe_tool_config (application definition); NXapm_paraprobe_tool_config .. _NXapm_paraprobe_tool_config: =========================== NXapm_paraprobe_tool_config =========================== **Status**: *application definition* (contribution), extends :ref:`NXobject` **Description**: .. collapse:: Application definition for a (configuration) file of a tool from the paraprobe-t ... Application definition for a (configuration) file of a tool from the paraprobe-toolbox. The paraprobe-toolbox is a collection of open-source tools for performing efficient analyses of point cloud data where each point can represent atoms or (molecular) ions. A key application of the toolbox has been for research in the field of Atom Probe Tomography (APT) and related Field Ion Microscopy (FIM): * `paraprobe-toolbox `_ * `M. Kühbach et al. `_ The toolbox does not replace but complements existent software tools in this research field. Given its capabilities of handling points as objects with properties and enabling analyses of the spatial arrangement of and inter- sections between geometric primitives, the software can equally be used for analyzing data in Materials Science and Materials Engineering. **Symbols**: No symbol table **Groups cited**: :ref:`NXapm_paraprobe_tool_common`, :ref:`NXapm_paraprobe_tool_parameters`, :ref:`NXcg_cylinder`, :ref:`NXcg_ellipsoid`, :ref:`NXcg_face_list_data_structure`, :ref:`NXcg_hexahedron`, :ref:`NXcg_polyhedron`, :ref:`NXcs_filter_boolean_mask`, :ref:`NXcs_profiling`, :ref:`NXentry`, :ref:`NXmatch_filter`, :ref:`NXnote`, :ref:`NXprogram`, :ref:`NXspatial_filter`, :ref:`NXsubsampling_filter` .. index:: NXentry (base class); used in application definition, NXapm_paraprobe_tool_parameters (base class); used in application definition, NXnote (base class); used in application definition, NXspatial_filter (base class); used in application definition, NXcg_hexahedron (base class); used in application definition, NXcg_face_list_data_structure (base class); used in application definition, NXcg_cylinder (base class); used in application definition, NXcg_ellipsoid (base class); used in application definition, NXcg_polyhedron (base class); used in application definition, NXcs_filter_boolean_mask (base class); used in application definition, NXsubsampling_filter (base class); used in application definition, NXmatch_filter (base class); used in application definition, NXapm_paraprobe_tool_common (base class); used in application definition, NXprogram (base class); used in application definition, NXcs_profiling (base class); used in application definition **Structure**: .. _/NXapm_paraprobe_tool_config/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` .. _/NXapm_paraprobe_tool_config/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/definition@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG-group: :bolditalic:`TASKCONFIG`: (required) :ref:`NXapm_paraprobe_tool_parameters` A specific configuration to achieve a processing result .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/identifier_analysis-field: .. index:: identifier_analysis (field) **identifier_analysis**: (recommended) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction-group: **reconstruction**: (required) :ref:`NXnote` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction/file_name-field: .. index:: file_name (field) **file_name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction/checksum-field: .. index:: checksum (field) **checksum**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction/algorithm-field: .. index:: algorithm (field) **algorithm**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction/position-field: .. index:: position (field) **position**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction/mass_to_charge-field: .. index:: mass_to_charge (field) **mass_to_charge**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/ranging-group: **ranging**: (required) :ref:`NXnote` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/ranging/file_name-field: .. index:: file_name (field) **file_name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/ranging/checksum-field: .. index:: checksum (field) **checksum**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/ranging/algorithm-field: .. index:: algorithm (field) **algorithm**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/ranging/ranging_definitions-field: .. index:: ranging_definitions (field) **ranging_definitions**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter-group: **spatial_filter**: (required) :ref:`NXspatial_filter` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/windowing_method-field: .. index:: windowing_method (field) **windowing_method**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set-group: **hexahedron_set**: (optional) :ref:`NXcg_hexahedron` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set/dimensionality-field: .. index:: dimensionality (field) **dimensionality**: (required) :ref:`NX_POSINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set/index_offset-field: .. index:: index_offset (field) **index_offset**: (required) :ref:`NX_INT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set/hexahedra-group: **hexahedra**: (required) :ref:`NXcg_face_list_data_structure` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set/hexahedra/vertices-field: .. index:: vertices (field) **vertices**: (required) :ref:`NX_UINT ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set-group: **cylinder_set**: (optional) :ref:`NXcg_cylinder` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/dimensionality-field: .. index:: dimensionality (field) **dimensionality**: (required) :ref:`NX_POSINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/index_offset-field: .. index:: index_offset (field) **index_offset**: (required) :ref:`NX_INT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/center-field: .. index:: center (field) **center**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/height-field: .. index:: height (field) **height**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/radii-field: .. index:: radii (field) **radii**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set-group: **ellipsoid_set**: (optional) :ref:`NXcg_ellipsoid` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/dimensionality-field: .. index:: dimensionality (field) **dimensionality**: (required) :ref:`NX_POSINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/index_offset-field: .. index:: index_offset (field) **index_offset**: (required) :ref:`NX_INT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/center-field: .. index:: center (field) **center**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/half_axes_radii-field: .. index:: half_axes_radii (field) **half_axes_radii**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/orientation-field: .. index:: orientation (field) **orientation**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/polyhedron_set-group: **polyhedron_set**: (optional) :ref:`NXcg_polyhedron` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/bitmask-group: **bitmask**: (optional) :ref:`NXcs_filter_boolean_mask` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/bitmask/number_of_objects-field: .. index:: number_of_objects (field) **number_of_objects**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/bitmask/bitdepth-field: .. index:: bitdepth (field) **bitdepth**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/bitmask/mask-field: .. index:: mask (field) **mask**: (required) :ref:`NX_UINT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/evaporation_id_filter-group: **evaporation_id_filter**: (optional) :ref:`NXsubsampling_filter` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/evaporation_id_filter/min-field: .. index:: min (field) **min**: (required) :ref:`NX_INT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/evaporation_id_filter/increment-field: .. index:: increment (field) **increment**: (required) :ref:`NX_INT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/evaporation_id_filter/max-field: .. index:: max (field) **max**: (required) :ref:`NX_INT ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/iontype_filter-group: **iontype_filter**: (optional) :ref:`NXmatch_filter` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/iontype_filter/method-field: .. index:: method (field) **method**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/iontype_filter/match-field: .. index:: match (field) **match**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/hit_multiplicity_filter-group: **hit_multiplicity_filter**: (optional) :ref:`NXmatch_filter` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/hit_multiplicity_filter/method-field: .. index:: method (field) **method**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/hit_multiplicity_filter/match-field: .. index:: match (field) **match**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/common-group: **common**: (required) :ref:`NXapm_paraprobe_tool_common` .. _/NXapm_paraprobe_tool_config/ENTRY/common/status-field: .. index:: status (field) **status**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/common/programID-group: **program**\ :bolditalic:`ID`: (required) :ref:`NXprogram` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/common/programID/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/common/programID/program@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/common/profiling-group: **profiling**: (recommended) :ref:`NXcs_profiling` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/common/profiling/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/common/profiling/end_time-field: .. index:: end_time (field) **end_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXapm_paraprobe_tool_config/ENTRY/common/profiling/total_elapsed_time-field: .. index:: total_elapsed_time (field) **total_elapsed_time**: (required) :ref:`NX_FLOAT ` :ref:`⤆ ` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXapm_paraprobe_tool_config/ENTRY-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/common-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/common/profiling-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/common/profiling/end_time-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/common/profiling/start_time-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/common/profiling/total_elapsed_time-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/common/programID-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/common/programID/program-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/common/programID/program@version-attribute ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/common/status-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/definition-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/definition@version-attribute ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/evaporation_id_filter-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/evaporation_id_filter/increment-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/evaporation_id_filter/max-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/evaporation_id_filter/min-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/hit_multiplicity_filter-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/hit_multiplicity_filter/match-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/hit_multiplicity_filter/method-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/identifier_analysis-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/iontype_filter-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/iontype_filter/match-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/iontype_filter/method-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/ranging-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/ranging/algorithm-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/ranging/checksum-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/ranging/file_name-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/ranging/ranging_definitions-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction/algorithm-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction/checksum-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction/file_name-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction/mass_to_charge-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/reconstruction/position-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/bitmask-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/bitmask/bitdepth-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/bitmask/mask-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/bitmask/number_of_objects-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/cardinality-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/center-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/dimensionality-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/height-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/index_offset-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/cylinder_set/radii-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/cardinality-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/center-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/dimensionality-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/half_axes_radii-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/index_offset-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/ellipsoid_set/orientation-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set/cardinality-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set/dimensionality-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set/hexahedra-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set/hexahedra/vertices-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/hexahedron_set/index_offset-field ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/polyhedron_set-group ` * :ref:`/NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG/spatial_filter/windowing_method-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXapm_paraprobe_tool_config.nxdl.xml