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

.. index::
    ! NXem_img (base class)
    ! em_img (base class)
    see: em_img (base class); NXem_img

.. _NXem_img:

========
NXem_img
========

**Status**:

  base class, extends :ref:`NXprocess`

**Description**:

  .. collapse:: Base class for method-specific generic imaging with electron microscopes. ...

      Base class for method-specific generic imaging with electron microscopes.

      In the majority of cases simple d-dimensional regular scan patterns are used
      to probe regions-of-interest (ROIs). Examples can be single point aka spot
      measurements, line profiles, or (rectangular) surface mappings.
      The latter pattern is the most frequently used.

      For now the base class provides for scans for which the settings,
      binning, and energy resolution is the same for each scan point.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXimage`, :ref:`NXmicrostructure`

.. index:: NXimage (base class); used in base class, NXmicrostructure (base class); used in base class

**Structure**:

  .. _/NXem_img/IMAGE-group:

  :bolditalic:`IMAGE`: (optional) :ref:`NXimage` 


    .. _/NXem_img/IMAGE/imaging_mode-field:

    .. index:: imaging_mode (field)

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

      .. collapse:: Which imaging mode was used? ...

          Which imaging mode was used?

          Any of these values or a custom value (if you use a custom value, also set @custom=True):

            * ``secondary_electron``

            * ``backscattered_electron``

            * ``annular_dark_field``

            * ``cathodoluminescence``


    .. _/NXem_img/IMAGE/half_angle_interval-field:

    .. index:: half_angle_interval (field)

    **half_angle_interval**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} 

      Annulus inner (first value) and outer (second value) half angle.

    .. _/NXem_img/IMAGE/MICROSTRUCTURE-group:

    :bolditalic:`MICROSTRUCTURE`: (optional) :ref:`NXmicrostructure` 

      .. collapse:: A reconstruction of the microstructure or some of its features ...

          A reconstruction of the microstructure or some of its features
          based on image information in the parent class.


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

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


* :ref:`/NXem_img/IMAGE-group </NXem_img/IMAGE-group>`
* :ref:`/NXem_img/IMAGE/half_angle_interval-field </NXem_img/IMAGE/half_angle_interval-field>`
* :ref:`/NXem_img/IMAGE/imaging_mode-field </NXem_img/IMAGE/imaging_mode-field>`
* :ref:`/NXem_img/IMAGE/MICROSTRUCTURE-group </NXem_img/IMAGE/MICROSTRUCTURE-group>`

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