2.3.3.3.199. NXspectrum_set¶
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).
- Groups cited:
Structure:
PROCESS: (optional) NXprocess
Details how spectra were processed from the detector readings.
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_set instance.
detector_identifier: (optional) NX_CHAR
Link or name of an :ref:`NXdetector` instance with which the data were ...
Link or name of an NXdetector instance with which the data were collected.
source: (optional) NXserialized
Resolvable data artifact (e.g. filename) from which all values in the :ref:` ...
Resolvable data artifact (e.g. filename) from which all values in the NXdata instances in this NXspectrum_set 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 absolute_path therein adds context.
absolute_path: (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.
PROGRAM: (optional) NXprogram
spectrum_0d: (optional) NXdata
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} ⤆
stack_0d: (optional) NXdata
Multiple instances of spectrum_0d.
intensity: (optional) NX_NUMBER (Rank: 2, Dimensions: [n_spc, n_energy]) {units=NX_UNITLESS} ⤆
group_identifier: (optional) NX_INT (Rank: 1, Dimensions: [n_spc]) {units=NX_UNITLESS}
spectrum_identifier: (optional) NX_INT (Rank: 1, Dimensions: [n_spc]) {units=NX_UNITLESS}
axis_energy: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_energy]) {units=NX_ENERGY} ⤆
stack_2d: (optional) NXdata
Multiple instances of spectrum_2d.
intensity: (optional) NX_NUMBER (Rank: 4, Dimensions: [n_spc, n_j, n_i, n_energy]) {units=NX_UNITLESS} ⤆
group_identifier: (optional) NX_INT (Rank: 1, Dimensions: [n_spc]) {units=NX_UNITLESS}
spectrum_identifier: (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} ⤆
stack_3d: (optional) NXdata
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} ⤆
group_identifier: (optional) NX_INT (Rank: 1, Dimensions: [n_spc]) {units=NX_UNITLESS}
spectrum_identifier: (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 groups, fields, attributes, and links defined in this class.
/NXspectrum_set/stack_0d/group_identifier@long_name-attribute
/NXspectrum_set/stack_0d/spectrum_identifier@long_name-attribute
/NXspectrum_set/stack_2d/group_identifier@long_name-attribute
/NXspectrum_set/stack_2d/spectrum_identifier@long_name-attribute
/NXspectrum_set/stack_3d/group_identifier@long_name-attribute
/NXspectrum_set/stack_3d/spectrum_identifier@long_name-attribute
