2.3.3.1.9. NXapm_ranging¶
Status:
base class, extends NXprocess
Description:
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 certain intervals. The documentation of these steps is based on ideas that have been described in the literature:
Symbols:
No symbol table
Structure:
PROGRAM: (optional) NXprogram
mass_to_charge_distribution: (optional) NXprocess
Specifies the mass-to-charge-state ratio histogram.
min_mass_to_charge: (optional) NX_FLOAT {units=NX_ANY}
Smallest :math:`{\frac{m}{q}}_{min}` mass-to-charge-state ratio value. ...
Smallest \({\frac{m}{q}}_{min}\) mass-to-charge-state ratio value.
The lower (left-hand side) inclusive bound of the interval \([{\frac{m}{q}}_{min}\), {frac{m}{q}}_{max}]`.
max_mass_to_charge: (optional) NX_FLOAT {units=NX_ANY}
Largest :math:`{\frac{m}{q}}_{max}` mass-to-charge-state ratio value. ...
Largest \({\frac{m}{q}}_{max}\) mass-to-charge-state ratio value.
The upper (right-hand side) inclusive bound of the interval \([{\frac{m}{q}}_{min}\), {frac{m}{q}}_{max}]`.
n_mass_to_charge: (optional) NX_POSINT {units=NX_UNITLESS}
The number of bins on the interval :math:`[{\frac{m}{q}}_{min}`, ...
The number of bins on the interval \([{\frac{m}{q}}_{min}\), {frac{m}{q}}_{max}]`.
PROGRAM: (optional) NXprogram
mass_spectrum: (optional) NXdata ⤆
A default histogram aka mass spectrum of ...
A default histogram aka mass spectrum of the mass-to-charge-state ratio values.
background_quantification: (optional) NXprocess
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.
description: (optional) NX_CHAR
Free-text field to describe how atom probers define a background model. ...
Free-text field to describe how atom probers define a background model.
Thereby, community feedback can be collected to inform an improved version of this base class in the future.
PROGRAM: (optional) NXprogram
peak_search_and_deconvolution: (optional) NXprocess
peak_identification: (optional) NXprocess
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.
number_of_ion_types: (optional) NX_UINT {units=NX_UNITLESS}
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 reserved value.
Consequently, start counting iontypes from 1.
maximum_number_of_atoms_per_molecular_ion: (optional) NX_UINT {units=NX_UNITLESS}
Assumed maximum value that suffices to store all relevant molecular ions, ...
Assumed maximum value that suffices to store all relevant molecular ions, even the most complicated ones that one can typically observe and distinguish typically. Currently, a value of 32 is used (see M. Kühbach et al. <https://doi.org/10.1017/S1431927621012241>`_).
PROGRAM: (optional) NXprogram
ATOM: (optional) NXatom
Hypertext Anchors¶
List of hypertext anchors for all groups, fields, attributes, and links defined in this class.
/NXapm_ranging/mass_to_charge_distribution/mass_spectrum-group
/NXapm_ranging/mass_to_charge_distribution/max_mass_to_charge-field
/NXapm_ranging/mass_to_charge_distribution/min_mass_to_charge-field
/NXapm_ranging/mass_to_charge_distribution/n_mass_to_charge-field
/NXapm_ranging/peak_identification/maximum_number_of_atoms_per_molecular_ion-field
/NXapm_ranging/peak_identification/number_of_ion_types-field
