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

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

.. _NXpinhole:

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

**Status**:

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

**Description**:

  Template of a simple pinhole.
  For more complex geometries NXaperture should be used.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. index:: depends_on (data field)

  **depends_on**: :ref:`NX_CHAR <NX_CHAR>`

    Points to the path of the last element in the geometry chain that places
    this object in space. 
    When followed through that chain is supposed to end at an element depending
    on "." i.e. the origin of the coordinate system.
    If desired the location of the slit can also be described relative to
    an NXbeam, which will allow a simple description of a non-centred pinhole.

  .. index:: diameter (data field)

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

    Size of the circular hole defining the transmitted beam size.

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