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

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

.. _NXaperture:

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

..
    Contributors List

    .. |contrib_name| replace:: Lukas Pielsticker|lukaspie|https://avatars.githubusercontent.com/u/50139597?v=4|2025-02-13

    .. |contrib_name| replace:: Mkuehbach|atomprobe-tc|https://avatars.githubusercontent.com/u/123244704?v=4|2024-09-29

    .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2024-02-18

    .. |contrib_name| replace:: Aaron Brewster|phyy-nx|https://avatars.githubusercontent.com/u/13471434?v=4|2022-06-15

    .. |contrib_name| replace:: Peter Chang|PeterC-DLS|https://avatars.githubusercontent.com/u/1381719?v=4|2020-10-20

    .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  .. collapse:: A beamline aperture. ...

      A beamline aperture.

      Note, the group was incorrectly documented as deprecated, but it is not and it is in common use.

      You can specify the geometry of the aperture using either NXoff_geometry or for simpler geometry shape and size.

**Symbols**:

  No symbol table

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

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

**Structure**:

  .. _/NXaperture/depends_on-field:

  .. index:: depends_on (field)

  **depends_on**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXcomponent/depends_on-field>`

    .. collapse:: The reference point of the aperture is its center in the x and y axis. The ref ...

        The reference point of the aperture is its center in the x and y axis. The reference point on the z axis is the
        surface of the aperture pointing towards the source.

        In complex (asymmetric) geometries an NXoff_geometry group can be used to provide an unambiguous reference.

        .. image:: aperture/aperture.png
            :width: 40%

  .. _/NXaperture/material-field:

  .. index:: material (field)

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

    Absorbing material of the aperture

  .. _/NXaperture/description-field:

  .. index:: description (field)

  **description**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXcomponent/description-field>`

    Description of aperture

  .. _/NXaperture/shape-field:

  .. index:: shape (field)

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

    .. collapse:: Shape of the aperture. ...

        Shape of the aperture.

        Any of these values:

          * ``straight slit``

          * ``curved slit``

          * ``pinhole``

          * ``circle``

          * ``square``

          * ``hexagon``

          * ``octagon``

          * ``bladed``

          * ``open``

          * ``grid``


  .. _/NXaperture/size-field:

  .. index:: size (field)

  **size**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: The relevant dimension for the aperture, i.e. slit width, pinhole and iris ...

        The relevant dimension for the aperture, i.e. slit width, pinhole and iris
        diameter

  .. _/NXaperture/OFF_GEOMETRY-group:

  :bolditalic:`OFF_GEOMETRY`: (optional) :ref:`NXoff_geometry` 

    Use this group to describe the shape of the aperture.

  .. _/NXaperture/POSITIONER-group:

  :bolditalic:`POSITIONER`: (optional) :ref:`NXpositioner` 

    Stores the raw positions of aperture motors.

  .. _/NXaperture/GEOMETRY-group:

  :bolditalic:`GEOMETRY`: (optional) :ref:`NXgeometry` 


    .. index:: deprecated


    **DEPRECATED**: Use the field `depends_on` and :ref:`NXtransformations` to position the aperture and :ref:`NXoff_geometry` to describe its shape

    .. collapse:: Location and shape of aperture ...

        Location and shape of aperture

        .. TODO: documentation needs improvement, contributions welcome

            * 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?


  .. _/NXaperture/BLADE_GEOMETRY-group:

  **BLADE_GEOMETRY**: (optional) :ref:`NXgeometry` 


    .. index:: deprecated


    **DEPRECATED**: Use :ref:`NXoff_geometry` instead to describe the shape of the aperture

    location and shape of each blade

  .. _/NXaperture/NOTE-group:

  :bolditalic:`NOTE`: (optional) :ref:`NXnote` :ref:`⤆ </NXobject/NOTE-group>`

    Describe any additional information in a note.


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

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


* :ref:`/NXaperture/BLADE_GEOMETRY-group </NXaperture/BLADE_GEOMETRY-group>`
* :ref:`/NXaperture/depends_on-field </NXaperture/depends_on-field>`
* :ref:`/NXaperture/description-field </NXaperture/description-field>`
* :ref:`/NXaperture/GEOMETRY-group </NXaperture/GEOMETRY-group>`
* :ref:`/NXaperture/material-field </NXaperture/material-field>`
* :ref:`/NXaperture/NOTE-group </NXaperture/NOTE-group>`
* :ref:`/NXaperture/OFF_GEOMETRY-group </NXaperture/OFF_GEOMETRY-group>`
* :ref:`/NXaperture/POSITIONER-group </NXaperture/POSITIONER-group>`
* :ref:`/NXaperture/shape-field </NXaperture/shape-field>`
* :ref:`/NXaperture/size-field </NXaperture/size-field>`

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