.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXapm_paraprobe_config_clusterer.nxdl.xml .. index:: ! NXapm_paraprobe_config_clusterer (application definition) ! apm_paraprobe_config_clusterer (application definition) see: apm_paraprobe_config_clusterer (application definition); NXapm_paraprobe_config_clusterer .. _NXapm_paraprobe_config_clusterer: ================================ NXapm_paraprobe_config_clusterer ================================ **Status**: application definition, extends :ref:`NXobject` **Description**: Configuration of a paraprobe-clusterer tool run in atom probe microscopy. **Symbols**: The symbols used in the schema to specify e.g. dimensions of arrays. **n_positions**: Number of position values. **n_disjoint_clusters**: Number of disjoint cluster. **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:`NXcs_filter_boolean_mask`, :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, 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 **Structure**: .. _/NXapm_paraprobe_config_clusterer/ENTRY-group: **ENTRY**: (required) :ref:`NXentry` .. _/NXapm_paraprobe_config_clusterer/ENTRY@version-attribute: .. index:: version (group attribute) **@version**: (required) :ref:`NX_CHAR ` Version specifier of this application definition. .. _/NXapm_paraprobe_config_clusterer/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_clusterer`` .. _/NXapm_paraprobe_config_clusterer/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_clusterer/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_clusterer/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_clusterer/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_clusterer/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_clusterer/ENTRY/number_of_processes-field: .. index:: number_of_processes (field) **number_of_processes**: (required) :ref:`NX_UINT ` {units=\ :ref:`NX_UNITLESS `} How many clustering processes should the tool execute. .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus-group: **cameca_to_nexus**: (optional) :ref:`NXprocess` This process maps results from cluster analyses performed with IVAS/APSuite into an interoperable representation. Specifically in this process paraprobe-clusterer takes results from clustering methods from other tools of the APM community, like IVAS/APSuite. These results are usually reported in two ways. Either as an explicit list of reconstructed ion positions. In the case of IVAS these positions are reported through a text file with a cluster label for each position. Alternatively, the list of positions is reported, as it is the case for AMETEK (IVAS/AP Suite) but the cluster labels are specified implicitly only in the following way: The mass-to-charge-state ratio column of a what is effectively a file formatted like POS is used to assign a hypothetical mass-to-charge value which resolves a floating point representation of the cluster ID. Another case can occur where all disjoint floating point values, i.e. here cluster labels, are reported and then a dictionary is created how each value matches to a cluster ID. In general the cluster ID zero is reserved for marking the dataset as to not be assigned to any cluster. Therefore, indices of disjoint clusters start at 1. .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/ion_position_filename-field: .. index:: ion_position_filename (field) **ion_position_filename**: (required) :ref:`NX_CHAR ` Name of HDF5 file which stores reconstructed ion positions. This file should have been generated by from the community or vendor format. This file not necessarily contains all the of the dataset because spatial filters might have been applied in commercial software prior to executing the cluster analysis so that e.g. only positions within a ROI are reported by the commercial software. POS files from IVAS have to be converted first. .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset_name_positions-field: .. index:: dataset_name_positions (field) **dataset_name_positions**: (required) :ref:`NX_CHAR ` Name of the dataset inside the HDF5 file ion_position_filename which refers to the specific positions to use for this analysis. The referred to dataset has to be formatted as an array of shape (n_positions, 3). .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/cluster_indices_filename-field: .. index:: cluster_indices_filename (field) **cluster_indices_filename**: (required) :ref:`NX_CHAR ` Name of the HDF5 file which stores mass-to-charge-state-ratio values (in the case of IVAS/APSuite) or other numbers which can be interpreted as cluster labels. .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset_name_cluster_indices-field: .. index:: dataset_name_cluster_indices (field) **dataset_name_cluster_indices**: (required) :ref:`NX_CHAR ` Name of the dataset inside the HDF5 file cluster_indices_filename which refers to the specifically encoded cluster indices. The referred to dataset has to be formatted as an array of shape (n_positions, 1). .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/mapping_dictionary_keyword-field: .. index:: mapping_dictionary_keyword (field) **mapping_dictionary_keyword**: (required) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_disjoint_clusters]) {units=\ :ref:`NX_UNITLESS `} The list of all keywords of a dictionary which maps implicit cluster indices like those from IVAS/APSuite which were0ass-to-charge-state ratios. .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/mapping_dictionary_value-field: .. index:: mapping_dictionary_value (field) **mapping_dictionary_value**: (required) :ref:`NX_UINT ` (Rank: 1, Dimensions: [n_disjoint_clusters]) {units=\ :ref:`NX_UNITLESS `} The list of all values of a dictionary which maps implicit cluster indices like those from IVAS/APSuite which were0ass-to-charge-state ratios. The sequences of mapping_dictionary_keyword and mapping_dictionary_value have to match. .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/recover_evaporation_id-field: .. index:: recover_evaporation_id (field) **recover_evaporation_id**: (required) :ref:`NX_BOOLEAN ` {units=\ :ref:`NX_UNITLESS `} Specifies if the tool should try to recover for each position the closest matching position from dataset/dataset_name_reconstruction (within floating point accuracy). This can be useful for instance when users wish to recover the original evaporation ID which IVAS/AP Suite drops for instance when writing their *.indexed.* cluster results files. .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/recover_bitmask-field: .. index:: recover_bitmask (field) **recover_bitmask**: (required) :ref:`NX_BOOLEAN ` {units=\ :ref:`NX_UNITLESS `} Specifies if the tool should try to recover, after a recovery of the evaporation IDs a bitmask which identifies which of the positions in dataset/dataset/dataset_name_reconstruction where covered by the IVAS/APSuite cluster analysis. This can be useful to recover the region of interest. .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset-group: **dataset**: (required) :ref:`NXapm_input_reconstruction` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset/filename-field: .. index:: filename (field) **filename**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset/filename@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset/dataset_name_reconstruction-field: .. index:: dataset_name_reconstruction (field) **dataset_name_reconstruction**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/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_clusterer/ENTRY/cameca_to_nexus/iontypes-group: **iontypes**: (required) :ref:`NXapm_input_ranging` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/iontypes/filename-field: .. index:: filename (field) **filename**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/iontypes/filename@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/iontypes/group_name_iontypes-field: .. index:: group_name_iontypes (field) **group_name_iontypes**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter-group: **spatial_filter**: (optional) :ref:`NXspatial_filter` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/windowing_method-field: .. index:: windowing_method (field) **windowing_method**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET-group: **CG_ELLIPSOID_SET**: (optional) :ref:`NXcg_ellipsoid_set` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/dimensionality-field: .. index:: dimensionality (field) **dimensionality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/identifier_offset-field: .. index:: identifier_offset (field) **identifier_offset**: (required) :ref:`NX_INT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/center-field: .. index:: center (field) **center**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/half_axes_radii-field: .. index:: half_axes_radii (field) **half_axes_radii**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/orientation-field: .. index:: orientation (field) **orientation**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET-group: **CG_CYLINDER_SET**: (optional) :ref:`NXcg_cylinder_set` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/dimensionality-field: .. index:: dimensionality (field) **dimensionality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/identifier_offset-field: .. index:: identifier_offset (field) **identifier_offset**: (required) :ref:`NX_INT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/center-field: .. index:: center (field) **center**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/height-field: .. index:: height (field) **height**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/radii-field: .. index:: radii (field) **radii**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_HEXAHEDRON_SET-group: **CG_HEXAHEDRON_SET**: (optional) :ref:`NXcg_hexahedron_set` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_HEXAHEDRON_SET/dimensionality-field: .. index:: dimensionality (field) **dimensionality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_HEXAHEDRON_SET/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_HEXAHEDRON_SET/identifier_offset-field: .. index:: identifier_offset (field) **identifier_offset**: (required) :ref:`NX_INT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_HEXAHEDRON_SET/hexahedra-group: **hexahedra**: (required) :ref:`NXcg_face_list_data_structure` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CS_FILTER_BOOLEAN_MASK-group: **CS_FILTER_BOOLEAN_MASK**: (optional) :ref:`NXcs_filter_boolean_mask` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CS_FILTER_BOOLEAN_MASK/number_of_objects-field: .. index:: number_of_objects (field) **number_of_objects**: (required) :ref:`NX_UINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CS_FILTER_BOOLEAN_MASK/bitdepth-field: .. index:: bitdepth (field) **bitdepth**: (required) :ref:`NX_UINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CS_FILTER_BOOLEAN_MASK/mask-field: .. index:: mask (field) **mask**: (required) :ref:`NX_UINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CS_FILTER_BOOLEAN_MASK/identifier-field: .. index:: identifier (field) **identifier**: (required) :ref:`NX_UINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/evaporation_id_filter-group: **evaporation_id_filter**: (optional) :ref:`NXsubsampling_filter` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/iontype_filter-group: **iontype_filter**: (optional) :ref:`NXmatch_filter` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/hit_multiplicity_filter-group: **hit_multiplicity_filter**: (optional) :ref:`NXmatch_filter` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis-group: **cluster_analysis**: (optional) :ref:`NXprocess` This process performs a cluster analysis on a reconstructed dataset or a portion of the reconstruction. .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/clustering_algorithm-field: .. index:: clustering_algorithm (field) **clustering_algorithm**: (required) :ref:`NX_CHAR ` Name of the algorithm. .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/clustering_parameter-field: .. index:: clustering_parameter (field) **clustering_parameter**: (required) :ref:`NX_CHAR ` A text representation like a JSON/YAML dictionary with the parameter of the clustering_algorithm. .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/dataset-group: **dataset**: (required) :ref:`NXapm_input_reconstruction` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/dataset/filename-field: .. index:: filename (field) **filename**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/dataset/filename@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/dataset/dataset_name_reconstruction-field: .. index:: dataset_name_reconstruction (field) **dataset_name_reconstruction**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/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_clusterer/ENTRY/cluster_analysis/iontypes-group: **iontypes**: (required) :ref:`NXapm_input_ranging` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/iontypes/filename-field: .. index:: filename (field) **filename**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/iontypes/filename@version-attribute: .. index:: version (field attribute) **@version**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/iontypes/group_name_iontypes-field: .. index:: group_name_iontypes (field) **group_name_iontypes**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter-group: **spatial_filter**: (optional) :ref:`NXspatial_filter` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/windowing_method-field: .. index:: windowing_method (field) **windowing_method**: (required) :ref:`NX_CHAR ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET-group: **CG_ELLIPSOID_SET**: (optional) :ref:`NXcg_ellipsoid_set` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/dimensionality-field: .. index:: dimensionality (field) **dimensionality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/identifier_offset-field: .. index:: identifier_offset (field) **identifier_offset**: (required) :ref:`NX_INT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/center-field: .. index:: center (field) **center**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/half_axes_radii-field: .. index:: half_axes_radii (field) **half_axes_radii**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/orientation-field: .. index:: orientation (field) **orientation**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET-group: **CG_CYLINDER_SET**: (optional) :ref:`NXcg_cylinder_set` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/dimensionality-field: .. index:: dimensionality (field) **dimensionality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/identifier_offset-field: .. index:: identifier_offset (field) **identifier_offset**: (required) :ref:`NX_INT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/center-field: .. index:: center (field) **center**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/height-field: .. index:: height (field) **height**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/radii-field: .. index:: radii (field) **radii**: (required) :ref:`NX_NUMBER ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_HEXAHEDRON_SET-group: **CG_HEXAHEDRON_SET**: (optional) :ref:`NXcg_hexahedron_set` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_HEXAHEDRON_SET/dimensionality-field: .. index:: dimensionality (field) **dimensionality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_HEXAHEDRON_SET/cardinality-field: .. index:: cardinality (field) **cardinality**: (required) :ref:`NX_POSINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_HEXAHEDRON_SET/identifier_offset-field: .. index:: identifier_offset (field) **identifier_offset**: (required) :ref:`NX_INT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_HEXAHEDRON_SET/hexahedra-group: **hexahedra**: (required) :ref:`NXcg_face_list_data_structure` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CS_FILTER_BOOLEAN_MASK-group: **CS_FILTER_BOOLEAN_MASK**: (optional) :ref:`NXcs_filter_boolean_mask` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CS_FILTER_BOOLEAN_MASK/number_of_objects-field: .. index:: number_of_objects (field) **number_of_objects**: (required) :ref:`NX_UINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CS_FILTER_BOOLEAN_MASK/bitdepth-field: .. index:: bitdepth (field) **bitdepth**: (required) :ref:`NX_UINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CS_FILTER_BOOLEAN_MASK/mask-field: .. index:: mask (field) **mask**: (required) :ref:`NX_UINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CS_FILTER_BOOLEAN_MASK/identifier-field: .. index:: identifier (field) **identifier**: (required) :ref:`NX_UINT ` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/evaporation_id_filter-group: **evaporation_id_filter**: (optional) :ref:`NXsubsampling_filter` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/iontype_filter-group: **iontype_filter**: (optional) :ref:`NXmatch_filter` .. _/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/hit_multiplicity_filter-group: **hit_multiplicity_filter**: (optional) :ref:`NXmatch_filter` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/analysis_description-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/analysis_identifier-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/cluster_indices_filename-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset/dataset_name_mass_to_charge-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset/dataset_name_reconstruction-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset/filename-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset/filename@version-attribute ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset_name_cluster_indices-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/dataset_name_positions-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/evaporation_id_filter-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/hit_multiplicity_filter-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/ion_position_filename-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/iontype_filter-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/iontypes-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/iontypes/filename-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/iontypes/filename@version-attribute ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/iontypes/group_name_iontypes-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/mapping_dictionary_keyword-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/mapping_dictionary_value-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/recover_bitmask-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/recover_evaporation_id-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/cardinality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/center-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/dimensionality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/height-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/identifier_offset-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_CYLINDER_SET/radii-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/cardinality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/center-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/dimensionality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/half_axes_radii-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/identifier_offset-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_ELLIPSOID_SET/orientation-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_HEXAHEDRON_SET-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_HEXAHEDRON_SET/cardinality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_HEXAHEDRON_SET/dimensionality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_HEXAHEDRON_SET/hexahedra-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CG_HEXAHEDRON_SET/identifier_offset-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CS_FILTER_BOOLEAN_MASK-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CS_FILTER_BOOLEAN_MASK/bitdepth-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CS_FILTER_BOOLEAN_MASK/identifier-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CS_FILTER_BOOLEAN_MASK/mask-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/CS_FILTER_BOOLEAN_MASK/number_of_objects-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cameca_to_nexus/spatial_filter/windowing_method-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/clustering_algorithm-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/clustering_parameter-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/dataset-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/dataset/dataset_name_mass_to_charge-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/dataset/dataset_name_reconstruction-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/dataset/filename-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/dataset/filename@version-attribute ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/evaporation_id_filter-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/hit_multiplicity_filter-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/iontype_filter-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/iontypes-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/iontypes/filename-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/iontypes/filename@version-attribute ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/iontypes/group_name_iontypes-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/cardinality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/center-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/dimensionality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/height-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/identifier_offset-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_CYLINDER_SET/radii-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/cardinality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/center-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/dimensionality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/half_axes_radii-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/identifier_offset-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_ELLIPSOID_SET/orientation-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_HEXAHEDRON_SET-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_HEXAHEDRON_SET/cardinality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_HEXAHEDRON_SET/dimensionality-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_HEXAHEDRON_SET/hexahedra-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CG_HEXAHEDRON_SET/identifier_offset-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CS_FILTER_BOOLEAN_MASK-group ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CS_FILTER_BOOLEAN_MASK/bitdepth-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CS_FILTER_BOOLEAN_MASK/identifier-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CS_FILTER_BOOLEAN_MASK/mask-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/CS_FILTER_BOOLEAN_MASK/number_of_objects-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/cluster_analysis/spatial_filter/windowing_method-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/definition-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/number_of_processes-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/program-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/program@version-attribute ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY/time_stamp-field ` * :ref:`/NXapm_paraprobe_config_clusterer/ENTRY@version-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXapm_paraprobe_config_clusterer.nxdl.xml