.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXspectrum.nxdl.xml -- DO NOT EDIT .. index:: ! NXspectrum (base class) ! spectrum (base class) see: spectrum (base class); NXspectrum .. _NXspectrum: ========== NXspectrum ========== **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: 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**: :ref:`NXdata`, :ref:`NXnote`, :ref:`NXprocess`, :ref:`NXprogram` .. index:: NXprocess (base class); used in base class, NXnote (base class); used in base class, NXprogram (base class); used in base class, NXdata (base class); used in base class **Structure**: .. _/NXspectrum/PROCESS-group: :bolditalic:`PROCESS`: (optional) :ref:`NXprocess` Details how spectra were processed from the detector readings. .. _/NXspectrum/PROCESS/mode-field: .. index:: mode (field) **mode**: (optional) :ref:`NX_CHAR ` .. collapse:: Imaging (data collection) mode of the instrument during acquisition ... Imaging (data collection) mode of the instrument during acquisition of the data in this :ref:`NXspectrum` instance. .. _/NXspectrum/PROCESS/detector_identifier-field: .. index:: detector_identifier (field) **detector_identifier**: (optional) :ref:`NX_CHAR ` .. collapse:: Link or name of an :ref:`NXdetector` instance with which the data were ... Link or name of an :ref:`NXdetector` instance with which the data were collected. .. _/NXspectrum/PROCESS/input-group: **input**: (optional) :ref:`NXnote` :ref:`⤆ ` .. collapse:: 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 :ref:`NXdata` instances in this :ref:`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. .. _/NXspectrum/PROCESS/input/context-field: .. index:: context (field) **context**: (optional) :ref:`NX_CHAR ` .. collapse:: 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. .. _/NXspectrum/PROCESS/PROGRAM-group: :bolditalic:`PROGRAM`: (optional) :ref:`NXprogram` .. _/NXspectrum/spectrum_0d-group: **spectrum_0d**: (optional) :ref:`NXdata` :ref:`⤆ ` One spectrum for a point of a 0d ROI. Also known as spot measurement. .. _/NXspectrum/spectrum_0d/intensity-field: .. index:: intensity (field) **intensity**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_UNITLESS `} Counts .. _/NXspectrum/spectrum_0d/intensity@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Counts .. _/NXspectrum/spectrum_0d/axis_energy-field: .. index:: axis_energy (field) **axis_energy**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY `} Energy axis .. _/NXspectrum/spectrum_0d/axis_energy@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Energy .. _/NXspectrum/spectrum_1d-group: **spectrum_1d**: (optional) :ref:`NXdata` :ref:`⤆ ` One spectrum for each point of a 1d ROI. .. _/NXspectrum/spectrum_1d/intensity-field: .. index:: intensity (field) **intensity**: (optional) :ref:`NX_NUMBER ` (Rank: 2, Dimensions: [n_i, n_energy]) {units=\ :ref:`NX_UNITLESS `} Counts .. _/NXspectrum/spectrum_1d/intensity@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Counts .. _/NXspectrum/spectrum_1d/axis_i-field: .. index:: axis_i (field) **axis_i**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_i]) {units=\ :ref:`NX_LENGTH `} Point coordinate along the fast dimension .. _/NXspectrum/spectrum_1d/axis_i@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Point coordinate along the fast dimension .. _/NXspectrum/spectrum_1d/axis_energy-field: .. index:: axis_energy (field) **axis_energy**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY `} Energy axis .. _/NXspectrum/spectrum_1d/axis_energy@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Energy .. _/NXspectrum/spectrum_2d-group: **spectrum_2d**: (optional) :ref:`NXdata` :ref:`⤆ ` One spectrum for each scan point of 2d ROI. .. _/NXspectrum/spectrum_2d/intensity-field: .. index:: intensity (field) **intensity**: (optional) :ref:`NX_NUMBER ` (Rank: 3, Dimensions: [n_j, n_i, n_energy]) {units=\ :ref:`NX_UNITLESS `} Counts .. _/NXspectrum/spectrum_2d/intensity@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Counts .. _/NXspectrum/spectrum_2d/axis_j-field: .. index:: axis_j (field) **axis_j**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_j]) {units=\ :ref:`NX_LENGTH `} Point coordinate along the slow dimension .. _/NXspectrum/spectrum_2d/axis_j@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Point coordinate along the slow dimension .. _/NXspectrum/spectrum_2d/axis_i-field: .. index:: axis_i (field) **axis_i**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_i]) {units=\ :ref:`NX_LENGTH `} Point coordinate along the fast dimension .. _/NXspectrum/spectrum_2d/axis_i@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Point coordinate along the fast dimension .. _/NXspectrum/spectrum_2d/axis_energy-field: .. index:: axis_energy (field) **axis_energy**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY `} Energy axis .. _/NXspectrum/spectrum_2d/axis_energy@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Energy .. _/NXspectrum/spectrum_3d-group: **spectrum_3d**: (optional) :ref:`NXdata` :ref:`⤆ ` One spectrum for point of a 3d ROI. .. _/NXspectrum/spectrum_3d/intensity-field: .. index:: intensity (field) **intensity**: (optional) :ref:`NX_NUMBER ` (Rank: 4, Dimensions: [n_k, n_j, n_i, n_energy]) {units=\ :ref:`NX_UNITLESS `} Counts .. _/NXspectrum/spectrum_3d/intensity@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Counts .. _/NXspectrum/spectrum_3d/axis_k-field: .. index:: axis_k (field) **axis_k**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_k]) {units=\ :ref:`NX_LENGTH `} Point coordinate along the slower dimension .. _/NXspectrum/spectrum_3d/axis_k@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Point coordinate along the slower dimension .. _/NXspectrum/spectrum_3d/axis_j-field: .. index:: axis_j (field) **axis_j**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_j]) {units=\ :ref:`NX_LENGTH `} Point coordinate along the slow dimension .. _/NXspectrum/spectrum_3d/axis_j@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Point coordinate along the slow dimension .. _/NXspectrum/spectrum_3d/axis_i-field: .. index:: axis_i (field) **axis_i**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_i]) {units=\ :ref:`NX_LENGTH `} Point coordinate along the fast dimension .. _/NXspectrum/spectrum_3d/axis_i@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Point coordinate along the fast dimension .. _/NXspectrum/spectrum_3d/axis_energy-field: .. index:: axis_energy (field) **axis_energy**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY `} Energy axis .. _/NXspectrum/spectrum_3d/axis_energy@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Energy .. _/NXspectrum/stack_0d-group: **stack_0d**: (optional) :ref:`NXdata` :ref:`⤆ ` Multiple instances of spectrum_0d. .. _/NXspectrum/stack_0d/intensity-field: .. index:: intensity (field) **intensity**: (optional) :ref:`NX_NUMBER ` (Rank: 2, Dimensions: [n_spc, n_energy]) {units=\ :ref:`NX_UNITLESS `} Counts .. _/NXspectrum/stack_0d/intensity@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Counts .. _/NXspectrum/stack_0d/indices_group-field: .. index:: indices_group (field) **indices_group**: (optional) :ref:`NX_INT ` (Rank: 1, Dimensions: [n_spc]) {units=\ :ref:`NX_UNITLESS `} Group identifier .. _/NXspectrum/stack_0d/indices_group@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Group identifier .. _/NXspectrum/stack_0d/indices_spectrum-field: .. index:: indices_spectrum (field) **indices_spectrum**: (optional) :ref:`NX_INT ` (Rank: 1, Dimensions: [n_spc]) {units=\ :ref:`NX_UNITLESS `} Spectrum identifier .. _/NXspectrum/stack_0d/indices_spectrum@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Spectrum identifier .. _/NXspectrum/stack_0d/axis_energy-field: .. index:: axis_energy (field) **axis_energy**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY `} Energy axis .. _/NXspectrum/stack_0d/axis_energy@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Energy .. _/NXspectrum/stack_2d-group: **stack_2d**: (optional) :ref:`NXdata` :ref:`⤆ ` Multiple instances of spectrum_2d. .. _/NXspectrum/stack_2d/intensity-field: .. index:: intensity (field) **intensity**: (optional) :ref:`NX_NUMBER ` (Rank: 4, Dimensions: [n_spc, n_j, n_i, n_energy]) {units=\ :ref:`NX_UNITLESS `} Counts .. _/NXspectrum/stack_2d/intensity@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Counts .. _/NXspectrum/stack_2d/indices_group-field: .. index:: indices_group (field) **indices_group**: (optional) :ref:`NX_INT ` (Rank: 1, Dimensions: [n_spc]) {units=\ :ref:`NX_UNITLESS `} Group identifier .. _/NXspectrum/stack_2d/indices_group@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Group identifier .. _/NXspectrum/stack_2d/indices_spectrum-field: .. index:: indices_spectrum (field) **indices_spectrum**: (optional) :ref:`NX_INT ` (Rank: 1, Dimensions: [n_spc]) {units=\ :ref:`NX_UNITLESS `} Spectrum identifier .. _/NXspectrum/stack_2d/indices_spectrum@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Spectrum identifier .. _/NXspectrum/stack_2d/axis_j-field: .. index:: axis_j (field) **axis_j**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_j]) {units=\ :ref:`NX_LENGTH `} Point coordinate along the slow dimension .. _/NXspectrum/stack_2d/axis_j@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Point coordinate along the slow dimension .. _/NXspectrum/stack_2d/axis_i-field: .. index:: axis_i (field) **axis_i**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_i]) {units=\ :ref:`NX_LENGTH `} Point coordinate along the fast dimension .. _/NXspectrum/stack_2d/axis_i@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Point coordinate along the fast dimension .. _/NXspectrum/stack_2d/axis_energy-field: .. index:: axis_energy (field) **axis_energy**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY `} Energy axis .. _/NXspectrum/stack_2d/axis_energy@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Energy .. _/NXspectrum/stack_3d-group: **stack_3d**: (optional) :ref:`NXdata` :ref:`⤆ ` Multiple instances of spectrum_3d. .. _/NXspectrum/stack_3d/intensity-field: .. index:: intensity (field) **intensity**: (optional) :ref:`NX_NUMBER ` (Rank: 5, Dimensions: [n_spc, n_k, n_j, n_i, n_energy]) {units=\ :ref:`NX_UNITLESS `} Counts .. _/NXspectrum/stack_3d/intensity@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Counts .. _/NXspectrum/stack_3d/indices_group-field: .. index:: indices_group (field) **indices_group**: (optional) :ref:`NX_INT ` (Rank: 1, Dimensions: [n_spc]) {units=\ :ref:`NX_UNITLESS `} Group identifier .. _/NXspectrum/stack_3d/indices_group@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Group identifier .. _/NXspectrum/stack_3d/indices_spectrum-field: .. index:: indices_spectrum (field) **indices_spectrum**: (optional) :ref:`NX_INT ` (Rank: 1, Dimensions: [n_spc]) {units=\ :ref:`NX_UNITLESS `} Spectrum identifier .. _/NXspectrum/stack_3d/indices_spectrum@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Spectrum identifier .. _/NXspectrum/stack_3d/axis_k-field: .. index:: axis_k (field) **axis_k**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_k]) {units=\ :ref:`NX_LENGTH `} Point coordinate along the slower dimension .. _/NXspectrum/stack_3d/axis_k@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Point coordinate along the slower dimension .. _/NXspectrum/stack_3d/axis_j-field: .. index:: axis_j (field) **axis_j**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_j]) {units=\ :ref:`NX_LENGTH `} Point coordinate along the slow dimension .. _/NXspectrum/stack_3d/axis_j@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Point coordinate along the slow dimension .. _/NXspectrum/stack_3d/axis_i-field: .. index:: axis_i (field) **axis_i**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_i]) {units=\ :ref:`NX_LENGTH `} Point coordinate along the fast dimension .. _/NXspectrum/stack_3d/axis_i@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Point coordinate along the fast dimension .. _/NXspectrum/stack_3d/axis_energy-field: .. index:: axis_energy (field) **axis_energy**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY `} Energy axis .. _/NXspectrum/stack_3d/axis_energy@long_name-attribute: .. index:: long_name (field attribute) **@long_name**: (optional) :ref:`NX_CHAR ` Energy Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXspectrum/PROCESS-group ` * :ref:`/NXspectrum/PROCESS/detector_identifier-field ` * :ref:`/NXspectrum/PROCESS/input-group ` * :ref:`/NXspectrum/PROCESS/input/context-field ` * :ref:`/NXspectrum/PROCESS/mode-field ` * :ref:`/NXspectrum/PROCESS/PROGRAM-group ` * :ref:`/NXspectrum/spectrum_0d-group ` * :ref:`/NXspectrum/spectrum_0d/axis_energy-field ` * :ref:`/NXspectrum/spectrum_0d/axis_energy@long_name-attribute ` * :ref:`/NXspectrum/spectrum_0d/intensity-field ` * :ref:`/NXspectrum/spectrum_0d/intensity@long_name-attribute ` * :ref:`/NXspectrum/spectrum_1d-group ` * :ref:`/NXspectrum/spectrum_1d/axis_energy-field ` * :ref:`/NXspectrum/spectrum_1d/axis_energy@long_name-attribute ` * :ref:`/NXspectrum/spectrum_1d/axis_i-field ` * :ref:`/NXspectrum/spectrum_1d/axis_i@long_name-attribute ` * :ref:`/NXspectrum/spectrum_1d/intensity-field ` * :ref:`/NXspectrum/spectrum_1d/intensity@long_name-attribute ` * :ref:`/NXspectrum/spectrum_2d-group ` * :ref:`/NXspectrum/spectrum_2d/axis_energy-field ` * :ref:`/NXspectrum/spectrum_2d/axis_energy@long_name-attribute ` * :ref:`/NXspectrum/spectrum_2d/axis_i-field ` * :ref:`/NXspectrum/spectrum_2d/axis_i@long_name-attribute ` * :ref:`/NXspectrum/spectrum_2d/axis_j-field ` * :ref:`/NXspectrum/spectrum_2d/axis_j@long_name-attribute ` * :ref:`/NXspectrum/spectrum_2d/intensity-field ` * :ref:`/NXspectrum/spectrum_2d/intensity@long_name-attribute ` * :ref:`/NXspectrum/spectrum_3d-group ` * :ref:`/NXspectrum/spectrum_3d/axis_energy-field ` * :ref:`/NXspectrum/spectrum_3d/axis_energy@long_name-attribute ` * :ref:`/NXspectrum/spectrum_3d/axis_i-field ` * :ref:`/NXspectrum/spectrum_3d/axis_i@long_name-attribute ` * :ref:`/NXspectrum/spectrum_3d/axis_j-field ` * :ref:`/NXspectrum/spectrum_3d/axis_j@long_name-attribute ` * :ref:`/NXspectrum/spectrum_3d/axis_k-field ` * :ref:`/NXspectrum/spectrum_3d/axis_k@long_name-attribute ` * :ref:`/NXspectrum/spectrum_3d/intensity-field ` * :ref:`/NXspectrum/spectrum_3d/intensity@long_name-attribute ` * :ref:`/NXspectrum/stack_0d-group ` * :ref:`/NXspectrum/stack_0d/axis_energy-field ` * :ref:`/NXspectrum/stack_0d/axis_energy@long_name-attribute ` * :ref:`/NXspectrum/stack_0d/indices_group-field ` * :ref:`/NXspectrum/stack_0d/indices_group@long_name-attribute ` * :ref:`/NXspectrum/stack_0d/indices_spectrum-field ` * :ref:`/NXspectrum/stack_0d/indices_spectrum@long_name-attribute ` * :ref:`/NXspectrum/stack_0d/intensity-field ` * :ref:`/NXspectrum/stack_0d/intensity@long_name-attribute ` * :ref:`/NXspectrum/stack_2d-group ` * :ref:`/NXspectrum/stack_2d/axis_energy-field ` * :ref:`/NXspectrum/stack_2d/axis_energy@long_name-attribute ` * :ref:`/NXspectrum/stack_2d/axis_i-field ` * :ref:`/NXspectrum/stack_2d/axis_i@long_name-attribute ` * :ref:`/NXspectrum/stack_2d/axis_j-field ` * :ref:`/NXspectrum/stack_2d/axis_j@long_name-attribute ` * :ref:`/NXspectrum/stack_2d/indices_group-field ` * :ref:`/NXspectrum/stack_2d/indices_group@long_name-attribute ` * :ref:`/NXspectrum/stack_2d/indices_spectrum-field ` * :ref:`/NXspectrum/stack_2d/indices_spectrum@long_name-attribute ` * :ref:`/NXspectrum/stack_2d/intensity-field ` * :ref:`/NXspectrum/stack_2d/intensity@long_name-attribute ` * :ref:`/NXspectrum/stack_3d-group ` * :ref:`/NXspectrum/stack_3d/axis_energy-field ` * :ref:`/NXspectrum/stack_3d/axis_energy@long_name-attribute ` * :ref:`/NXspectrum/stack_3d/axis_i-field ` * :ref:`/NXspectrum/stack_3d/axis_i@long_name-attribute ` * :ref:`/NXspectrum/stack_3d/axis_j-field ` * :ref:`/NXspectrum/stack_3d/axis_j@long_name-attribute ` * :ref:`/NXspectrum/stack_3d/axis_k-field ` * :ref:`/NXspectrum/stack_3d/axis_k@long_name-attribute ` * :ref:`/NXspectrum/stack_3d/indices_group-field ` * :ref:`/NXspectrum/stack_3d/indices_group@long_name-attribute ` * :ref:`/NXspectrum/stack_3d/indices_spectrum-field ` * :ref:`/NXspectrum/stack_3d/indices_spectrum@long_name-attribute ` * :ref:`/NXspectrum/stack_3d/intensity-field ` * :ref:`/NXspectrum/stack_3d/intensity@long_name-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXspectrum.nxdl.xml