.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXimage_set_em_adf.nxdl.xml

.. index::
    ! NXimage_set_em_adf (base class)
    ! image_set_em_adf (base class)
    see: image_set_em_adf (base class); NXimage_set_em_adf

.. _NXimage_set_em_adf:

==================
NXimage_set_em_adf
==================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Container for reporting a set of annular dark field images.

**Symbols**:


  **n_images**: Number of images

  **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_adf/PROCESS-group:

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

    Details about how the images were processed from the detector readings.

    .. _/NXimage_set_em_adf/PROCESS/program-field:

    .. index:: program (field)

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

      Commercial or otherwise given name to the program which was used
      to process detector data into the adf image(s).

      .. _/NXimage_set_em_adf/PROCESS/program@version-attribute:

      .. index:: version (field attribute)

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

        Program version plus build number, commit hash, or description
        of an ever persistent resource where the source code of the program
        and build instructions can be found so that the program
        can be configured in such a manner that the result file
        is ideally recreatable yielding the same results.

    .. _/NXimage_set_em_adf/PROCESS/adf_inner_half_angle-field:

    .. index:: adf_inner_half_angle (field)

    **adf_inner_half_angle**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

      Annulus inner half angle

    .. _/NXimage_set_em_adf/PROCESS/adf_outer_half_angle-field:

    .. index:: adf_outer_half_angle (field)

    **adf_outer_half_angle**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

      Annulus outer half angle

  .. _/NXimage_set_em_adf/DATA-group:

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

    Annular dark field images.

    .. _/NXimage_set_em_adf/DATA@long_name-attribute:

    .. index:: long_name (group attribute)

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

      Image intensities

    .. _/NXimage_set_em_adf/DATA/intensity-field:

    .. index:: intensity (field)

    **intensity**: (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_adf/DATA/image_id-field:

    .. index:: image_id (field)

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

      Image identifier

      .. _/NXimage_set_em_adf/DATA/image_id@long_name-attribute:

      .. index:: long_name (field attribute)

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

        Image ID.

    .. _/NXimage_set_em_adf/DATA/ypos-field:

    .. index:: ypos (field)

    **ypos**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_y]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

      Pixel center of mass position y-coordinates.

      .. _/NXimage_set_em_adf/DATA/ypos@long_name-attribute:

      .. index:: long_name (field attribute)

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

        Label for the y axis.

    .. _/NXimage_set_em_adf/DATA/xpos-field:

    .. index:: xpos (field)

    **xpos**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_x]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

      Pixel center of mass position x-coordinates.

      .. _/NXimage_set_em_adf/DATA/xpos@long_name-attribute:

      .. index:: long_name (field attribute)

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

        Label for the x axis.


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

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


* :ref:`/NXimage_set_em_adf/DATA-group </NXimage_set_em_adf/DATA-group>`
* :ref:`/NXimage_set_em_adf/DATA/image_id-field </NXimage_set_em_adf/DATA/image_id-field>`
* :ref:`/NXimage_set_em_adf/DATA/image_id@long_name-attribute </NXimage_set_em_adf/DATA/image_id@long_name-attribute>`
* :ref:`/NXimage_set_em_adf/DATA/intensity-field </NXimage_set_em_adf/DATA/intensity-field>`
* :ref:`/NXimage_set_em_adf/DATA/xpos-field </NXimage_set_em_adf/DATA/xpos-field>`
* :ref:`/NXimage_set_em_adf/DATA/xpos@long_name-attribute </NXimage_set_em_adf/DATA/xpos@long_name-attribute>`
* :ref:`/NXimage_set_em_adf/DATA/ypos-field </NXimage_set_em_adf/DATA/ypos-field>`
* :ref:`/NXimage_set_em_adf/DATA/ypos@long_name-attribute </NXimage_set_em_adf/DATA/ypos@long_name-attribute>`
* :ref:`/NXimage_set_em_adf/DATA@long_name-attribute </NXimage_set_em_adf/DATA@long_name-attribute>`
* :ref:`/NXimage_set_em_adf/PROCESS-group </NXimage_set_em_adf/PROCESS-group>`
* :ref:`/NXimage_set_em_adf/PROCESS/adf_inner_half_angle-field </NXimage_set_em_adf/PROCESS/adf_inner_half_angle-field>`
* :ref:`/NXimage_set_em_adf/PROCESS/adf_outer_half_angle-field </NXimage_set_em_adf/PROCESS/adf_outer_half_angle-field>`
* :ref:`/NXimage_set_em_adf/PROCESS/program-field </NXimage_set_em_adf/PROCESS/program-field>`
* :ref:`/NXimage_set_em_adf/PROCESS/program@version-attribute </NXimage_set_em_adf/PROCESS/program@version-attribute>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/base_classes/NXimage_set_em_adf.nxdl.xml