2.3.3.3.15. NXapm_charge_state_analysis¶
Status:
base class, extends NXprocess
Description:
Base class to document an algorithm for recovering charge state and nuclide comp ...
Base class to document an algorithm for recovering charge state and nuclide composition of a (molecular) ion.
Currently ranging definitions in the research field of atom probe face have limitations:
A ranging definition maps all signal within a mass-to-charge-state-ratio value interval on one iontype. Facing limited mass-resolving-power, there are mass-to-charge-state-ratio values, though, for which not only multiple (molecular) ions are indistinguishable but also for which the current practice of documenting classical ranging definitions is incomplete.
Indeed, ranging definitions often report only (for each interval) the mass-to-charge-state-ratio intervals surplus the composition of elements that build the (molecular) ion.
Therefore, classical ranging definitions demand a post-processing with an algorithm which can identify nuclides from which the (molecular) ion is constructed and a charge state possibly recovered. Combinatorial algorithms are used for this purpose.
This base class documents the configuration and results of such an algorithm.
Symbols:
The symbols used in the schema to specify e.g. dimensions of arrays.
n_cand: The number of also possible but different (molecular) ions.
n_ivec_max: Maximum number of allowed atoms per (molecular) ion (fragment).
n_variable: Number of entries
- Groups cited:
none
Structure:
nuclides: (optional) NX_UINT (Rank: 1, Dimensions: [n_variable]) {units=NX_UNITLESS}
Input constraint, list of nuclide_hash for typically elements used for the ...
Input constraint, list of nuclide_hash for typically elements used for the ranging definition of the ion whose charge state the analyses covered. The list contains each hash as many times as its multiplicity. Nuclides are encoded using the hashing rule that is defined in NXion.
As an example, a ranging definition H:2 O:1 is configured by setting nuclides to a list with entries \(1 + 0 \cdot 256\), \(1 + 0 \cdot 256\), \(8 + 0 \cdot 256\). An empty list does not release the constraint. Instead, a list with all elements in the periodic table (encoded as nuclide_hash values) should be used, i.e. \(1 + 0 \cdot 256\), \(2 + 0 \cdot 256\), and so on and so forth.
Keep in mind that with a weakly constrained parameter space the combinatorial analysis may become very time consuming!
mass_to_charge_range: (optional) NX_FLOAT (Rank: 2, Dimensions: [1, 2]) {units=NX_ANY}
Input constraint, interval within which (molecular) ions need to have the ...
Input constraint, interval within which (molecular) ions need to have the mass-to-charge-state-ratio such that an ion qualifies as a candidate.
min_half_life: (optional) NX_FLOAT {units=NX_TIME}
Input constraint, minimum half life for how long each nuclide of each ...
Input constraint, minimum half life for how long each nuclide of each (molecular) ion needs to be stable such that the ion qualifies as a candidate.
min_abundance: (optional) NX_FLOAT {units=NX_DIMENSIONLESS}
Input constraint, minimum natural abundance of each nuclide of each ...
Input constraint, minimum natural abundance of each nuclide of each (molecular) ion such that the ion qualifies as a candidate.
sacrifice_isotopic_uniqueness: (optional) NX_BOOLEAN
If the value is false, it means that non-unique solutions are accepted. ...
If the value is false, it means that non-unique solutions are accepted. These are solutions where multiple candidates have been built from different nuclide instances but the charge_state of all the ions is the same.
charge_state: (optional) NX_INT (Rank: 1, Dimensions: [n_cand]) {units=NX_UNITLESS}
Signed charge, i.e. integer multiple of the elementary ...
Signed charge, i.e. integer multiple of the elementary charge of each candidate.
nuclide_hash: (optional) NX_UINT (Rank: 2, Dimensions: [n_cand, n_ivec_max]) {units=NX_UNITLESS}
Table of nuclide instances of which each candidate is composed. ...
Table of nuclide instances of which each candidate is composed. Each row vector is sorted in descending order. Unused values are nullified.
mass: (optional) NX_FLOAT (Rank: 1, Dimensions: [n_cand]) {units=NX_MASS}
Accumulated mass of the nuclides in each candidate. ...
Accumulated mass of the nuclides in each candidate. Not corrected for quantum effects.
natural_abundance_product: (optional) NX_FLOAT (Rank: 1, Dimensions: [n_cand]) {units=NX_DIMENSIONLESS}
The product of the natural abundances of the nuclides for each candidate.
shortest_half_life: (optional) NX_FLOAT (Rank: 1, Dimensions: [n_cand]) {units=NX_TIME}
For each candidate the half life of that nuclide which has the shortest half ...
For each candidate the half life of that nuclide which has the shortest half life.
Hypertext Anchors¶
List of hypertext anchors for all groups, fields, attributes, and links defined in this class.
