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

.. index::
    ! NXimage_set (base class)
    ! image_set (base class)
    see: image_set (base class); NXimage_set

.. _NXimage_set:

===========
NXimage_set
===========

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Base class for reporting a set of images. ...

      Base class for reporting a set of images.

      This class provides a base vocabulary to be used for specialized :ref:`NXimage_set`
      base classes like :ref:`NXimage_r_set` and :ref:`NXimage_c_set`.

**Symbols**:


  **n_images**: Number of images in the stack.

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

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

**Groups cited**:
  :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

**Structure**:

  .. _/NXimage_set/PROCESS-group:

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

    .. collapse:: Details how NXdata instance inside instance of (specialized) ...

        Details how NXdata instance inside instance of (specialized)
        :ref:`NXimage_set` were processed from the detector readings/raw data.

    .. _/NXimage_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:`NXimage_set` instance.

    .. _/NXimage_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.

    .. _/NXimage_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:`NXimage_set` were loaded
          during parsing.

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

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



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

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


* :ref:`/NXimage_set/PROCESS-group </NXimage_set/PROCESS-group>`
* :ref:`/NXimage_set/PROCESS/detector_identifier-field </NXimage_set/PROCESS/detector_identifier-field>`
* :ref:`/NXimage_set/PROCESS/mode-field </NXimage_set/PROCESS/mode-field>`
* :ref:`/NXimage_set/PROCESS/PROGRAM-group </NXimage_set/PROCESS/PROGRAM-group>`
* :ref:`/NXimage_set/PROCESS/source-group </NXimage_set/PROCESS/source-group>`

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