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

.. index::
    ! NXaperture_em (base class)
    ! aperture_em (base class)
    see: aperture_em (base class); NXaperture_em

.. _NXaperture_em:

=============
NXaperture_em
=============

..
    Contributors List

    .. |contrib_name| replace:: Rubel|RubelMozumder|https://avatars.githubusercontent.com/u/32923026?v=4|2023-06-14

    .. |contrib_name| replace:: Kuehbachm|mkuehbach|https://avatars.githubusercontent.com/u/14091504?v=4|2022-09-13

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Details of an individual aperture for beams in electron microscopy.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXfabrication`, :ref:`NXtransformations`

.. index:: NXfabrication (base class); used in base class, NXtransformations (base class); used in base class

**Structure**:

  .. _/NXaperture_em/name-field:

  .. index:: name (field)

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

    Given name/alias of the aperture.

  .. _/NXaperture_em/value-field:

  .. index:: value (field)

  **value**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    .. collapse:: Relevant value from the control software. ...

        Relevant value from the control software.

        This is not always just the diameter of (not even in the case)
        of a circular aperture. Usually it is a mode setting value which
        is selected in the control software.
        Which settings are behind the value should be defined
        for now in the description field, if these are known
        in more detail.

  .. _/NXaperture_em/description-field:

  .. index:: description (field)

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

    .. collapse:: Ideally, a (globally) unique persistent identifier, link, or text to a ...

        Ideally, a (globally) unique persistent identifier, link, or text to a
        resource which gives further details. Alternatively a free-text field.

  .. _/NXaperture_em/FABRICATION-group:

  **FABRICATION**: (optional) :ref:`NXfabrication` 


  .. _/NXaperture_em/TRANSFORMATIONS-group:

  **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` 

    .. collapse:: Affine transformation which detail the arrangement in the  ...

        Affine transformation which detail the arrangement in the 
        microscope relative to the optical axis and beam path.


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

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


* :ref:`/NXaperture_em/description-field </NXaperture_em/description-field>`
* :ref:`/NXaperture_em/FABRICATION-group </NXaperture_em/FABRICATION-group>`
* :ref:`/NXaperture_em/name-field </NXaperture_em/name-field>`
* :ref:`/NXaperture_em/TRANSFORMATIONS-group </NXaperture_em/TRANSFORMATIONS-group>`
* :ref:`/NXaperture_em/value-field </NXaperture_em/value-field>`

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