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

.. index::
    ! NXpinhole (base class)
    ! pinhole (base class)
    see: pinhole (base class); NXpinhole

.. _NXpinhole:

=========
NXpinhole
=========

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  .. collapse:: A simple pinhole. ...

      A simple pinhole.

      For more complex geometries, :ref:`NXaperture` should be used.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXpinhole/depends_on-field:

  .. index:: depends_on (field)

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

    .. collapse:: The reference direction of the pinhole is parallel with the z axis. The refere ...

        The reference direction of the pinhole is parallel with the z axis. The reference
        point of the pinhole is its center in the x and y axis. The reference point on the z axis is the
        plane which overlaps the side of the opening of the pin hole pointing towards the source (minus on the z axis).

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

  .. _/NXpinhole/diameter-field:

  .. index:: diameter (field)

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

    Size of the circular hole defining the transmitted beam size.


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

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


* :ref:`/NXpinhole/depends_on-field </NXpinhole/depends_on-field>`
* :ref:`/NXpinhole/diameter-field </NXpinhole/diameter-field>`

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