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

.. index::
    ! NXimage_set_em (base class)
    ! image_set_em (base class)
    see: image_set_em (base class); NXimage_set_em

.. _NXimage_set_em:

==============
NXimage_set_em
==============

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Container for reporting a set of images taken with an electron microscope.

**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:`NXdata`, :ref:`NXprocess`

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

**Structure**:

  .. _/NXimage_set_em/PROCESS-group:

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


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

    .. index:: mode (field)

    **mode**: (optional) :ref:`NX_CHAR <NX_CHAR>`

      Imaging mode in which the instrument was and with which the images
      were captured.

  .. _/NXimage_set_em/stack-group:

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

    Image (stack).

    .. _/NXimage_set_em/stack/data_counts-field:

    .. index:: data_counts (field)

    **data_counts**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 3, Dimensions: [n_images, n_y, n_x]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      Image intensity values.

    .. _/NXimage_set_em/stack/axis_image_identifier-field:

    .. index:: axis_image_identifier (field)

    **axis_image_identifier**: (optional) :ref:`NX_UINT <NX_UINT>` (Rank: 1, Dimensions: [n_images]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      Image identifier

      .. _/NXimage_set_em/stack/axis_image_identifier@long_name-attribute:

      .. index:: long_name (field attribute)

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

        Image identifier.

    .. _/NXimage_set_em/stack/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>`}

      Pixel coordinate center of mass along y direction.

      .. _/NXimage_set_em/stack/axis_y@long_name-attribute:

      .. index:: long_name (field attribute)

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

        Coordinate along y direction.

    .. _/NXimage_set_em/stack/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>`}

      Pixel coordinate center of mass along x direction.

      .. _/NXimage_set_em/stack/axis_x@long_name-attribute:

      .. index:: long_name (field attribute)

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

        Coordinate along x direction.


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

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


* :ref:`/NXimage_set_em/PROCESS-group </NXimage_set_em/PROCESS-group>`
* :ref:`/NXimage_set_em/PROCESS/mode-field </NXimage_set_em/PROCESS/mode-field>`
* :ref:`/NXimage_set_em/stack-group </NXimage_set_em/stack-group>`
* :ref:`/NXimage_set_em/stack/axis_image_identifier-field </NXimage_set_em/stack/axis_image_identifier-field>`
* :ref:`/NXimage_set_em/stack/axis_image_identifier@long_name-attribute </NXimage_set_em/stack/axis_image_identifier@long_name-attribute>`
* :ref:`/NXimage_set_em/stack/axis_x-field </NXimage_set_em/stack/axis_x-field>`
* :ref:`/NXimage_set_em/stack/axis_x@long_name-attribute </NXimage_set_em/stack/axis_x@long_name-attribute>`
* :ref:`/NXimage_set_em/stack/axis_y-field </NXimage_set_em/stack/axis_y-field>`
* :ref:`/NXimage_set_em/stack/axis_y@long_name-attribute </NXimage_set_em/stack/axis_y@long_name-attribute>`
* :ref:`/NXimage_set_em/stack/data_counts-field </NXimage_set_em/stack/data_counts-field>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXimage_set_em.nxdl.xml