.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXapm_ranging.nxdl.xml -- DO NOT EDIT .. index:: ! NXapm_ranging (base class) ! apm_ranging (base class) see: apm_ranging (base class); NXapm_ranging .. _NXapm_ranging: ============= NXapm_ranging ============= **Status**: base class, extends :ref:`NXprocess` **Description**: .. collapse:: Base class for the configuration and results of ranging definitions. ... Base class for the configuration and results of ranging definitions. Ranging is a data post-processing step used in the research field of atom probe during which elemental, isotopic, and/or molecular identities are assigned to mass-to-charge-state-ratios within a certain interval. The documentation of these steps is based on ideas that have been described in the literature: * `M. K. Miller `_ * `D. Haley et al. `_ * `M. Kühbach et al. `_ **Symbols**: No symbol table **Groups cited**: :ref:`NXdata`, :ref:`NXion`, :ref:`NXpeak`, :ref:`NXprocess`, :ref:`NXprogram`, :ref:`NXserialized` .. index:: NXprogram (base class); used in base class, NXserialized (base class); used in base class, NXprocess (base class); used in base class, NXdata (base class); used in base class, NXpeak (base class); used in base class, NXion (base class); used in base class **Structure**: .. _/NXapm_ranging/number_of_ion_types-field: .. index:: number_of_ion_types (field) **number_of_ion_types**: (optional) :ref:`NX_UINT ` {units=\ :ref:`NX_UNITLESS `} .. collapse:: How many ion types are distinguished. If no ranging was performed, each ... How many ion types are distinguished. If no ranging was performed, each ion is of the special unknown type. The iontype ID of this unknown type is 0 representing a reserve value. Consequently, iontypes start counting from 1. .. _/NXapm_ranging/maximum_number_of_atoms_per_molecular_ion-field: .. index:: maximum_number_of_atoms_per_molecular_ion (field) **maximum_number_of_atoms_per_molecular_ion**: (optional) :ref:`NX_UINT ` {units=\ :ref:`NX_UNITLESS `} .. collapse:: Assumed maximum value that suffices to store all relevant ... Assumed maximum value that suffices to store all relevant molecular ions, even the most complicated ones. Currently, a value of 32 is used (see M. Kühbach et al. `_). .. _/NXapm_ranging/PROGRAM-group: **PROGRAM**: (optional) :ref:`NXprogram` .. _/NXapm_ranging/SERIALIZED-group: **SERIALIZED**: (optional) :ref:`NXserialized` .. _/NXapm_ranging/mass_to_charge_distribution-group: **mass_to_charge_distribution**: (optional) :ref:`NXprocess` Specifies the mass-to-charge-state-ratio histogram. .. _/NXapm_ranging/mass_to_charge_distribution/min_incr_max-field: .. index:: min_incr_max (field) **min_incr_max**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_ANY `} Smallest, increment, and largest mass-to-charge-state ratio value. .. _/NXapm_ranging/mass_to_charge_distribution/PROGRAM-group: **PROGRAM**: (optional) :ref:`NXprogram` .. _/NXapm_ranging/mass_to_charge_distribution/mass_spectrum-group: **mass_spectrum**: (optional) :ref:`NXdata` .. collapse:: A default histogram aka mass spectrum of ... A default histogram aka mass spectrum of the mass-to-charge-state ratio values. .. _/NXapm_ranging/background_quantification-group: **background_quantification**: (optional) :ref:`NXprocess` .. collapse:: Details of the background model that was used to ... Details of the background model that was used to correct the total counts per bin into counts. .. _/NXapm_ranging/background_quantification/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` .. collapse:: To begin with we use a free-text field to learn how ... To begin with we use a free-text field to learn how atom probers define a background model. Future versions of NXapm_ranging can then use this information to parameterize these models. .. _/NXapm_ranging/background_quantification/PROGRAM-group: **PROGRAM**: (optional) :ref:`NXprogram` .. _/NXapm_ranging/peak_search_and_deconvolution-group: **peak_search_and_deconvolution**: (optional) :ref:`NXprocess` .. collapse:: How where peaks in the background-corrected in the histogram ... How where peaks in the background-corrected in the histogram of mass-to-charge-state ratio values identified? .. _/NXapm_ranging/peak_search_and_deconvolution/PROGRAM-group: **PROGRAM**: (optional) :ref:`NXprogram` .. _/NXapm_ranging/peak_search_and_deconvolution/PEAK-group: **PEAK**: (optional) :ref:`NXpeak` .. _/NXapm_ranging/peak_identification-group: **peak_identification**: (optional) :ref:`NXprocess` .. collapse:: Details about how peaks, with taking into account ... Details about how peaks, with taking into account error models, were interpreted as ion types or not. .. _/NXapm_ranging/peak_identification/PROGRAM-group: **PROGRAM**: (optional) :ref:`NXprogram` .. _/NXapm_ranging/peak_identification/ION-group: **ION**: (optional) :ref:`NXion` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXapm_ranging/background_quantification-group ` * :ref:`/NXapm_ranging/background_quantification/description-field ` * :ref:`/NXapm_ranging/background_quantification/PROGRAM-group ` * :ref:`/NXapm_ranging/mass_to_charge_distribution-group ` * :ref:`/NXapm_ranging/mass_to_charge_distribution/mass_spectrum-group ` * :ref:`/NXapm_ranging/mass_to_charge_distribution/min_incr_max-field ` * :ref:`/NXapm_ranging/mass_to_charge_distribution/PROGRAM-group ` * :ref:`/NXapm_ranging/maximum_number_of_atoms_per_molecular_ion-field ` * :ref:`/NXapm_ranging/number_of_ion_types-field ` * :ref:`/NXapm_ranging/peak_identification-group ` * :ref:`/NXapm_ranging/peak_identification/ION-group ` * :ref:`/NXapm_ranging/peak_identification/PROGRAM-group ` * :ref:`/NXapm_ranging/peak_search_and_deconvolution-group ` * :ref:`/NXapm_ranging/peak_search_and_deconvolution/PEAK-group ` * :ref:`/NXapm_ranging/peak_search_and_deconvolution/PROGRAM-group ` * :ref:`/NXapm_ranging/PROGRAM-group ` * :ref:`/NXapm_ranging/SERIALIZED-group ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXapm_ranging.nxdl.xml