.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXapm_paraprobe_config_selector.nxdl.xml -- DO NOT EDIT .. index:: ! NXapm_paraprobe_config_selector (application definition) ! apm_paraprobe_config_selector (application definition) see: apm_paraprobe_config_selector (application definition); NXapm_paraprobe_config_selector .. _NXapm_paraprobe_config_selector: =============================== NXapm_paraprobe_config_selector =============================== **Status**: application definition, extends :ref:`NXobject` **Description**: Configuration of a paraprobe-selector tool run in atom probe microscopy. **Symbols**: The symbols used in the schema to specify e.g. dimensions of arrays. **Groups cited**: :ref:`NXapm_input_ranging`, :ref:`NXapm_input_reconstruction`, :ref:`NXcg_cylinder_set`, :ref:`NXcg_ellipsoid_set`, :ref:`NXcg_face_list_data_structure`, :ref:`NXcg_hexahedron_set`, :ref:`NXentry`, :ref:`NXmatch_filter`, :ref:`NXprocess`, :ref:`NXspatial_filter`, :ref:`NXsubsampling_filter` .. index:: NXentry (base class); used in application definition, NXprocess (base class); used in application definition, NXapm_input_reconstruction (base class); used in application definition, NXapm_input_ranging (base class); used in application definition, NXspatial_filter (base class); used in application definition, NXcg_ellipsoid_set (base class); used in application definition, NXcg_cylinder_set (base class); used in application definition, NXcg_hexahedron_set (base class); used in application definition, NXcg_face_list_data_structure (base class); used in application definition, NXsubsampling_filter (base class); used in application definition, NXmatch_filter (base class); used in application definition **Structure**: .. _/NXapm_paraprobe_config_selector/ENTRY-group: **ENTRY**: (required) :ref:`NXentry` .. _/NXapm_paraprobe_config_selector/ENTRY@version-attribute: .. index:: version (group attribute) **@version**: (required) :ref:`NX_CHAR ` Version specifier of this application definition. .. _/NXapm_paraprobe_config_selector/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` Official NeXus NXDL schema with which this file was written. Obligatory value: ``NXapm_paraprobe_config_selector`` .. _/NXapm_paraprobe_config_selector/ENTRY/program-field: .. index:: program (field) **program**: (required) :ref:`NX_CHAR ` Given name of the program/software/tool with which this NeXus (configuration) file was generated. .. _/NXapm_paraprobe_config_selector/ENTRY/program@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` Ideally program version plus build number, or commit hash or description of ever persistent resources where the source code of the program and build instructions can be found so that the program can be configured ideally in such a manner that the result of this computational process is recreatable in the same deterministic manner. .. _/NXapm_paraprobe_config_selector/ENTRY/analysis_identifier-field: .. index:: analysis_identifier (field) **analysis_identifier**: (optional) :ref:`NX_CHAR ` Ideally, a (globally persistent) unique identifier for referring to this analysis. .. _/NXapm_paraprobe_config_selector/ENTRY/analysis_description-field: .. index:: analysis_description (field) **analysis_description**: (optional) :ref:`NX_CHAR ` Possibility for leaving a free-text description about this analysis. .. _/NXapm_paraprobe_config_selector/ENTRY/time_stamp-field: .. index:: time_stamp (field) **time_stamp**: (required) :ref:`NX_DATE_TIME ` ISO 8601 formatted time code with local time zone offset to UTC information included when this configuration file was created. .. _/NXapm_paraprobe_config_selector/ENTRY/number_of_processes-field: .. index:: number_of_processes (field) **number_of_processes**: (required) :ref:`NX_UINT ` {units=\ :ref:`NX_UNITLESS `} How many roi_selection processes should the tool execute. .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection-group: **roi_selection**: (required) :ref:`NXprocess` This process identifies which of the points/ions in the datasets are inside or on the surface of geometric primitives and meet optionally specific other filtering constraints. A typical use case of a roi_selection is to restrict analyses to specific regions of the dataset, eventually regions with a complicated shape. .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/dataset-group: **dataset**: (required) :ref:`NXapm_input_reconstruction` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/dataset/filename-field: .. index:: filename (field) **filename**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/dataset/filename@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/dataset/dataset_name_reconstruction-field: .. index:: dataset_name_reconstruction (field) **dataset_name_reconstruction**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/dataset/dataset_name_mass_to_charge-field: .. index:: dataset_name_mass_to_charge (field) **dataset_name_mass_to_charge**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontypes-group: **iontypes**: (required) :ref:`NXapm_input_ranging` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontypes/filename-field: .. index:: filename (field) **filename**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontypes/filename@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontypes/group_name_iontypes-field: .. index:: group_name_iontypes (field) **group_name_iontypes**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter-group: **spatial_filter**: (required) :ref:`NXspatial_filter` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/windowing_method-field: .. index:: windowing_method (field) **windowing_method**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_ELLIPSOID_SET-group: **CG_ELLIPSOID_SET**: (optional) :ref:`NXcg_ellipsoid_set` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_ELLIPSOID_SET/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_ELLIPSOID_SET/center-field: .. index:: center (field) **center**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_ELLIPSOID_SET/half_axes_radii-field: .. index:: half_axes_radii (field) **half_axes_radii**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_CYLINDER_SET-group: **CG_CYLINDER_SET**: (optional) :ref:`NXcg_cylinder_set` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_CYLINDER_SET/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_CYLINDER_SET/center-field: .. index:: center (field) **center**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_CYLINDER_SET/height-field: .. index:: height (field) **height**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_CYLINDER_SET/radii-field: .. index:: radii (field) **radii**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_HEXAHEDRON_SET-group: **CG_HEXAHEDRON_SET**: (optional) :ref:`NXcg_hexahedron_set` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_HEXAHEDRON_SET/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_HEXAHEDRON_SET/hexahedra-group: **hexahedra**: (required) :ref:`NXcg_face_list_data_structure` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_HEXAHEDRON_SET/hexahedra/vertices-field: .. index:: vertices (field) **vertices**: (required) :ref:`NX_FLOAT ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/evaporation_id_filter-group: **evaporation_id_filter**: (optional) :ref:`NXsubsampling_filter` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/evaporation_id_filter/linear_range_min_incr_max-field: .. index:: linear_range_min_incr_max (field) **linear_range_min_incr_max**: (required) :ref:`NX_UINT ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontype_filter-group: **iontype_filter**: (optional) :ref:`NXmatch_filter` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontype_filter/method-field: .. index:: method (field) **method**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontype_filter/match-field: .. index:: match (field) **match**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/hit_multiplicity_filter-group: **hit_multiplicity_filter**: (optional) :ref:`NXmatch_filter` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/hit_multiplicity_filter/method-field: .. index:: method (field) **method**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_selector/ENTRY/roi_selection/hit_multiplicity_filter/match-field: .. index:: match (field) **match**: (required) :ref:`NX_NUMBER ` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXapm_paraprobe_config_selector/ENTRY-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/analysis_description-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/analysis_identifier-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/definition-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/number_of_processes-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/program-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/program@version-attribute ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/dataset-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/dataset/dataset_name_mass_to_charge-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/dataset/dataset_name_reconstruction-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/dataset/filename-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/dataset/filename@version-attribute ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/evaporation_id_filter-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/evaporation_id_filter/linear_range_min_incr_max-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/hit_multiplicity_filter-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/hit_multiplicity_filter/match-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/hit_multiplicity_filter/method-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontype_filter-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontype_filter/match-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontype_filter/method-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontypes-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontypes/filename-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontypes/filename@version-attribute ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/iontypes/group_name_iontypes-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_CYLINDER_SET-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_CYLINDER_SET/cardinality-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_CYLINDER_SET/center-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_CYLINDER_SET/height-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_CYLINDER_SET/radii-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_ELLIPSOID_SET-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_ELLIPSOID_SET/cardinality-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_ELLIPSOID_SET/center-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_ELLIPSOID_SET/half_axes_radii-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_HEXAHEDRON_SET-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_HEXAHEDRON_SET/cardinality-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_HEXAHEDRON_SET/hexahedra-group ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/CG_HEXAHEDRON_SET/hexahedra/vertices-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/roi_selection/spatial_filter/windowing_method-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY/time_stamp-field ` * :ref:`/NXapm_paraprobe_config_selector/ENTRY@version-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXapm_paraprobe_config_selector.nxdl.xml