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

.. index::
    ! NXaperture (base class)
    ! aperture (base class)
    see: aperture (base class); NXaperture

.. _NXaperture:

==========
NXaperture
==========

**Status**:

  base class, extends :ref:`NXobject`, version 1.0

**Description**:

  Template of a beamline aperture.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXgeometry`, :ref:`NXnote`

.. index:: NXgeometry (base class); used in base class, NXnote (base class); used in base class

**Structure**:

  .. index:: material (data field)

  **material**: :ref:`NX_CHAR <NX_CHAR>`

    Absorbing material of the aperture

  .. index:: description (data field)

  **description**: :ref:`NX_CHAR <NX_CHAR>`

    Description of aperture

  **(geometry)**: :ref:`NXgeometry`

    location and shape of aperture

    .. TODO:
      description of terms is poor and leaves much to interpretation
      Describe what is meant by translation _here_ and ...
      Similar throughout base classes
      Some base classes do this much better
      Such as where is the gap written?

  **(geometry)**: :ref:`NXgeometry`

    location and shape of each blade

  **(note)**: :ref:`NXnote`

    describe an additional information in a note*

**Source**:
  Automatically generated from https://github.com/nexusformat/definitions/blob/master/base_classes/NXaperture.nxdl.xml