3.3.1.147. NXspectrum¶
Status:
base class, extends NXobject
Description:
Base class container for reporting a set of spectra. …
Base class container for reporting a set of spectra.
The mostly commonly used scanning methods are supported. That is one-, two-, three-dimensional ROIs discretized using regular Euclidean tilings.
Use stack for all other tilings.
Symbols:
n_spc: Number of spectra in the stack, for stacks the slowest dimension.
n_k: Number of image points along the slower dimension (k equivalent to z).
n_j: Number of image points along the slow dimension (j equivalent to y).
n_i: Number of image points along the fast dimension (i equivalent to x).
n_energy: Number of energy bins (always the fastest dimension).
Structure:
@NX_class: (required) NX_CHAR
Type of the NeXus group: the name of its class. …
Type of the NeXus group: the name of its class.
Obligatory value:
NXspectrumPROCESS: (optional) NXprocess
Details how spectra were processed from the detector readings.
Resolvable data artifact (e.g. filename) from which all values in the …
Resolvable data artifact (e.g. filename) from which all values in the NXdata instances in this NXspectrum were loaded during parsing.
Possibility to document from which specific other serialized resource as the source pieces of information were processed when using NeXus as a semantic file format to serialize that information differently.
The group in combination with an added field context therein adds context.
context: (optional) NX_CHAR
Reference to a location inside the artifact that points to the specific gr …
Reference to a location inside the artifact that points to the specific group of values that were processed if the artifacts contains several groups of values and thus further resolving of ambiguities is required.
mode: (optional) NX_CHAR
Imaging (data collection) mode of the instrument during acquisition …
Imaging (data collection) mode of the instrument during acquisition of the data in this NXspectrum instance.
detector_identifier: (optional) NX_CHAR
Link or name of an NXdetector instance with which the data were …
Link or name of an NXdetector instance with which the data were collected.
PROGRAM: (optional) NXprogram
spectrum_0d: (optional) NXdata ⤆
One spectrum for a point of a 0d ROI. Also known as spot measurement.
intensity: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_UNITLESS}
axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY}
spectrum_1d: (optional) NXdata ⤆
spectrum_2d: (optional) NXdata ⤆
One spectrum for each scan point of 2d ROI.
intensity: (optional) NX_NUMBER (Rank: 3, Dimensions: [n_j, n_i, n_energy]) {units=NX_UNITLESS}
axis_j: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_j]) {units=NX_LENGTH}
axis_i: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_i]) {units=NX_LENGTH}
axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY}
spectrum_3d: (optional) NXdata ⤆
One spectrum for point of a 3d ROI.
intensity: (optional) NX_NUMBER (Rank: 4, Dimensions: [n_k, n_j, n_i, n_energy]) {units=NX_UNITLESS}
axis_k: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_k]) {units=NX_LENGTH}
axis_j: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_j]) {units=NX_LENGTH}
axis_i: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_i]) {units=NX_LENGTH}
axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY}
Multiple instances of spectrum_0d.
intensity: (optional) NX_NUMBER (Rank: 2, Dimensions: [n_spc, n_energy]) {units=NX_UNITLESS}
indices_group: (optional) NX_INT (Rank: 1, Dimensions: [n_spc]) {units=NX_UNITLESS}
indices_spectrum: (optional) NX_INT (Rank: 1, Dimensions: [n_spc]) {units=NX_UNITLESS}
axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY}
Multiple instances of spectrum_2d.
intensity: (optional) NX_NUMBER (Rank: 4, Dimensions: [n_spc, n_j, n_i, n_energy]) {units=NX_UNITLESS}
indices_group: (optional) NX_INT (Rank: 1, Dimensions: [n_spc]) {units=NX_UNITLESS}
indices_spectrum: (optional) NX_INT (Rank: 1, Dimensions: [n_spc]) {units=NX_UNITLESS}
axis_j: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_j]) {units=NX_LENGTH}
axis_i: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_i]) {units=NX_LENGTH}
axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY}
Multiple instances of spectrum_3d.
intensity: (optional) NX_NUMBER (Rank: 5, Dimensions: [n_spc, n_k, n_j, n_i, n_energy]) {units=NX_UNITLESS}
indices_group: (optional) NX_INT (Rank: 1, Dimensions: [n_spc]) {units=NX_UNITLESS}
indices_spectrum: (optional) NX_INT (Rank: 1, Dimensions: [n_spc]) {units=NX_UNITLESS}
axis_k: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_k]) {units=NX_LENGTH}
axis_j: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_j]) {units=NX_LENGTH}
axis_i: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_i]) {units=NX_LENGTH}
axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY}
Hypertext Anchors¶
List of hypertext anchors for all NeXus groups, fields, attributes and links documented in this class.