.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXspectrum_set.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXspectrum_set (base class)
    ! spectrum_set (base class)
    see: spectrum_set (base class); NXspectrum_set

.. _NXspectrum_set:

==============
NXspectrum_set
==============

**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 regularly sampled ROIs.

      For randomly or dissimilarly spaced scan points use collection instead.

**Symbols**:


  **n_p**: Number of scan points.

  **n_z**: Number of pixel in the slowest direction.

  **n_y**: Number of pixel in the slow direction.

  **n_x**: Number of pixel in the fast direction.

  **n_energy**: Number of energy bins.

**Groups cited**:
  :ref:`NXdata`, :ref:`NXprocess`, :ref:`NXprogram`, :ref:`NXserialized`

.. index:: NXprocess (base class); used in base class, NXserialized (base class); used in base class, NXprogram (base class); used in base class, NXdata (base class); used in base class

**Structure**:

  .. _/NXspectrum_set/PROCESS-group:

  **PROCESS**: (optional) :ref:`NXprocess` 

    Details how spectra were processed from the detector readings.

    .. _/NXspectrum_set/PROCESS/mode-field:

    .. index:: mode (field)

    **mode**: (optional) :ref:`NX_CHAR <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_set` instance.

    .. _/NXspectrum_set/PROCESS/detector_identifier-field:

    .. index:: detector_identifier (field)

    **detector_identifier**: (optional) :ref:`NX_CHAR <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_set/PROCESS/source-group:

    **source**: (optional) :ref:`NXserialized` 

      .. collapse:: Resolvable data artifact (e.g. filename) from which the all values in ...

          Resolvable data artifact (e.g. filename) from which the all values in
          the :ref:`NXdata` instances in this :ref:`NXspectrum_set` were
          loaded during parsing.

    .. _/NXspectrum_set/PROCESS/PROGRAM-group:

    **PROGRAM**: (optional) :ref:`NXprogram` 


  .. _/NXspectrum_set/spectrum_zerod-group:

  **spectrum_zerod**: (optional) :ref:`NXdata` 

    One spectrum for one pixel in a ROI aka spot measurement.

    .. _/NXspectrum_set/spectrum_zerod/intensity-field:

    .. index:: intensity (field)

    **intensity**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [n_x, n_energy]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Counts

      .. _/NXspectrum_set/spectrum_zerod/intensity@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Counts

    .. _/NXspectrum_set/spectrum_zerod/axis_energy-field:

    .. index:: axis_energy (field)

    **axis_energy**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY <NX_ENERGY>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Energy axis

      .. _/NXspectrum_set/spectrum_zerod/axis_energy@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Energy

  .. _/NXspectrum_set/spectrum_oned-group:

  **spectrum_oned**: (optional) :ref:`NXdata` 

    .. collapse:: One spectrum for each pixel of an equidistantly ...

        One spectrum for each pixel of an equidistantly
        sampled one-dimensional ROI.

    .. _/NXspectrum_set/spectrum_oned/intensity-field:

    .. index:: intensity (field)

    **intensity**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [n_x, n_energy]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Counts

      .. _/NXspectrum_set/spectrum_oned/intensity@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Counts

    .. _/NXspectrum_set/spectrum_oned/axis_x-field:

    .. index:: axis_x (field)

    **axis_x**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_x]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Coordinate along x direction.

      .. _/NXspectrum_set/spectrum_oned/axis_x@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Pixel coordinate along x direction

    .. _/NXspectrum_set/spectrum_oned/axis_energy-field:

    .. index:: axis_energy (field)

    **axis_energy**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY <NX_ENERGY>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Energy axis

      .. _/NXspectrum_set/spectrum_oned/axis_energy@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Energy

  .. _/NXspectrum_set/spectrum_twod-group:

  **spectrum_twod**: (optional) :ref:`NXdata` 

    .. collapse:: One spectrum for each pixel of an equidistantly ...

        One spectrum for each pixel of an equidistantly
        sampled two-dimensional ROI.

    .. _/NXspectrum_set/spectrum_twod/intensity-field:

    .. index:: intensity (field)

    **intensity**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 3, Dimensions: [n_y, n_x, n_energy]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Counts

      .. _/NXspectrum_set/spectrum_twod/intensity@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Counts

    .. _/NXspectrum_set/spectrum_twod/axis_y-field:

    .. index:: axis_y (field)

    **axis_y**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_y]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Coordinate along y direction.

      .. _/NXspectrum_set/spectrum_twod/axis_y@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Pixel coordinate along y direction

    .. _/NXspectrum_set/spectrum_twod/axis_x-field:

    .. index:: axis_x (field)

    **axis_x**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_x]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Coordinate along x direction.

      .. _/NXspectrum_set/spectrum_twod/axis_x@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Pixel coordinate along x direction

    .. _/NXspectrum_set/spectrum_twod/axis_energy-field:

    .. index:: axis_energy (field)

    **axis_energy**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY <NX_ENERGY>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Energy axis

      .. _/NXspectrum_set/spectrum_twod/axis_energy@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Energy

  .. _/NXspectrum_set/spectrum_threed-group:

  **spectrum_threed**: (optional) :ref:`NXdata` 

    .. collapse:: One spectrum for each voxel of an equidistantly ...

        One spectrum for each voxel of an equidistantly
        sampled three-dimensional ROI.

    .. _/NXspectrum_set/spectrum_threed/intensity-field:

    .. index:: intensity (field)

    **intensity**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 4, Dimensions: [n_z, n_y, n_x, n_energy]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Counts

      .. _/NXspectrum_set/spectrum_threed/intensity@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Counts

    .. _/NXspectrum_set/spectrum_threed/axis_z-field:

    .. index:: axis_z (field)

    **axis_z**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_z]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Coordinate along z direction.

      .. _/NXspectrum_set/spectrum_threed/axis_z@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Pixel coordinate along z direction

    .. _/NXspectrum_set/spectrum_threed/axis_y-field:

    .. index:: axis_y (field)

    **axis_y**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_y]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Coordinate along y direction.

      .. _/NXspectrum_set/spectrum_threed/axis_y@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Pixel coordinate along y direction

    .. _/NXspectrum_set/spectrum_threed/axis_x-field:

    .. index:: axis_x (field)

    **axis_x**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_x]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Coordinate along x direction.

      .. _/NXspectrum_set/spectrum_threed/axis_x@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Pixel coordinate along x direction

    .. _/NXspectrum_set/spectrum_threed/axis_energy-field:

    .. index:: axis_energy (field)

    **axis_energy**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY <NX_ENERGY>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Energy axis

      .. _/NXspectrum_set/spectrum_threed/axis_energy@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Energy

  .. _/NXspectrum_set/collection-group:

  **collection**: (optional) :ref:`NXdata` 

    .. collapse:: One spectrum for each scan point. This representation supports ...

        One spectrum for each scan point. This representation supports
        equidistant energy bins. For rectangular sampling use respective
        one-, two-, and three-dimensional variants instead.

    .. _/NXspectrum_set/collection/intensity-field:

    .. index:: intensity (field)

    **intensity**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [n_p, n_energy]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Counts

      .. _/NXspectrum_set/collection/intensity@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Counts

    .. _/NXspectrum_set/collection/axis_scan_point_id-field:

    .. index:: axis_scan_point_id (field)

    **axis_scan_point_id**: (optional) :ref:`NX_INT <NX_INT>` (Rank: 1, Dimensions: [n_p]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

      Scan point identifier

      .. _/NXspectrum_set/collection/axis_scan_point_id@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

        Scan point identifier

    .. _/NXspectrum_set/collection/axis_energy-field:

    .. index:: axis_energy (field)

    **axis_energy**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_energy]) {units=\ :ref:`NX_ENERGY <NX_ENERGY>`} :ref:`⤆ </NXdata/AXISNAME-field>`

      Energy axis

      .. _/NXspectrum_set/collection/axis_energy@long_name-attribute:

      .. index:: long_name (field attribute)

      **@long_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXdata/AXISNAME@long_name-attribute>`

        Energy


Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXspectrum_set/collection-group </NXspectrum_set/collection-group>`
* :ref:`/NXspectrum_set/collection/axis_energy-field </NXspectrum_set/collection/axis_energy-field>`
* :ref:`/NXspectrum_set/collection/axis_energy@long_name-attribute </NXspectrum_set/collection/axis_energy@long_name-attribute>`
* :ref:`/NXspectrum_set/collection/axis_scan_point_id-field </NXspectrum_set/collection/axis_scan_point_id-field>`
* :ref:`/NXspectrum_set/collection/axis_scan_point_id@long_name-attribute </NXspectrum_set/collection/axis_scan_point_id@long_name-attribute>`
* :ref:`/NXspectrum_set/collection/intensity-field </NXspectrum_set/collection/intensity-field>`
* :ref:`/NXspectrum_set/collection/intensity@long_name-attribute </NXspectrum_set/collection/intensity@long_name-attribute>`
* :ref:`/NXspectrum_set/PROCESS-group </NXspectrum_set/PROCESS-group>`
* :ref:`/NXspectrum_set/PROCESS/detector_identifier-field </NXspectrum_set/PROCESS/detector_identifier-field>`
* :ref:`/NXspectrum_set/PROCESS/mode-field </NXspectrum_set/PROCESS/mode-field>`
* :ref:`/NXspectrum_set/PROCESS/PROGRAM-group </NXspectrum_set/PROCESS/PROGRAM-group>`
* :ref:`/NXspectrum_set/PROCESS/source-group </NXspectrum_set/PROCESS/source-group>`
* :ref:`/NXspectrum_set/spectrum_oned-group </NXspectrum_set/spectrum_oned-group>`
* :ref:`/NXspectrum_set/spectrum_oned/axis_energy-field </NXspectrum_set/spectrum_oned/axis_energy-field>`
* :ref:`/NXspectrum_set/spectrum_oned/axis_energy@long_name-attribute </NXspectrum_set/spectrum_oned/axis_energy@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_oned/axis_x-field </NXspectrum_set/spectrum_oned/axis_x-field>`
* :ref:`/NXspectrum_set/spectrum_oned/axis_x@long_name-attribute </NXspectrum_set/spectrum_oned/axis_x@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_oned/intensity-field </NXspectrum_set/spectrum_oned/intensity-field>`
* :ref:`/NXspectrum_set/spectrum_oned/intensity@long_name-attribute </NXspectrum_set/spectrum_oned/intensity@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_threed-group </NXspectrum_set/spectrum_threed-group>`
* :ref:`/NXspectrum_set/spectrum_threed/axis_energy-field </NXspectrum_set/spectrum_threed/axis_energy-field>`
* :ref:`/NXspectrum_set/spectrum_threed/axis_energy@long_name-attribute </NXspectrum_set/spectrum_threed/axis_energy@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_threed/axis_x-field </NXspectrum_set/spectrum_threed/axis_x-field>`
* :ref:`/NXspectrum_set/spectrum_threed/axis_x@long_name-attribute </NXspectrum_set/spectrum_threed/axis_x@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_threed/axis_y-field </NXspectrum_set/spectrum_threed/axis_y-field>`
* :ref:`/NXspectrum_set/spectrum_threed/axis_y@long_name-attribute </NXspectrum_set/spectrum_threed/axis_y@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_threed/axis_z-field </NXspectrum_set/spectrum_threed/axis_z-field>`
* :ref:`/NXspectrum_set/spectrum_threed/axis_z@long_name-attribute </NXspectrum_set/spectrum_threed/axis_z@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_threed/intensity-field </NXspectrum_set/spectrum_threed/intensity-field>`
* :ref:`/NXspectrum_set/spectrum_threed/intensity@long_name-attribute </NXspectrum_set/spectrum_threed/intensity@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_twod-group </NXspectrum_set/spectrum_twod-group>`
* :ref:`/NXspectrum_set/spectrum_twod/axis_energy-field </NXspectrum_set/spectrum_twod/axis_energy-field>`
* :ref:`/NXspectrum_set/spectrum_twod/axis_energy@long_name-attribute </NXspectrum_set/spectrum_twod/axis_energy@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_twod/axis_x-field </NXspectrum_set/spectrum_twod/axis_x-field>`
* :ref:`/NXspectrum_set/spectrum_twod/axis_x@long_name-attribute </NXspectrum_set/spectrum_twod/axis_x@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_twod/axis_y-field </NXspectrum_set/spectrum_twod/axis_y-field>`
* :ref:`/NXspectrum_set/spectrum_twod/axis_y@long_name-attribute </NXspectrum_set/spectrum_twod/axis_y@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_twod/intensity-field </NXspectrum_set/spectrum_twod/intensity-field>`
* :ref:`/NXspectrum_set/spectrum_twod/intensity@long_name-attribute </NXspectrum_set/spectrum_twod/intensity@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_zerod-group </NXspectrum_set/spectrum_zerod-group>`
* :ref:`/NXspectrum_set/spectrum_zerod/axis_energy-field </NXspectrum_set/spectrum_zerod/axis_energy-field>`
* :ref:`/NXspectrum_set/spectrum_zerod/axis_energy@long_name-attribute </NXspectrum_set/spectrum_zerod/axis_energy@long_name-attribute>`
* :ref:`/NXspectrum_set/spectrum_zerod/intensity-field </NXspectrum_set/spectrum_zerod/intensity-field>`
* :ref:`/NXspectrum_set/spectrum_zerod/intensity@long_name-attribute </NXspectrum_set/spectrum_zerod/intensity@long_name-attribute>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXspectrum_set.nxdl.xml