.. 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
=========

..
    Contributors List

    .. |contrib_name| replace:: Woutdenolf|woutdenolf|https://avatars.githubusercontent.com/u/7264703?v=4|2022-06-17

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

    .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28

    .. |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:`NXobject`

**Description**:

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

      A simple pinhole.

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

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXtransformations`

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

**Structure**:

  .. _/NXpinhole@default-attribute:

  .. index:: default (file attribute)

  **@default**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: Declares which child group contains a path leading  ...

        .. index:: plotting

        Declares which child group contains a path leading 
        to a :ref:`NXdata` group.

        It is recommended (as of NIAC2014) to use this attribute
        to help define the path to the default dataset to be plotted.
        See https://www.nexusformat.org/2014_How_to_find_default_data.html
        for a summary of the discussion.

  .. _/NXpinhole/depends_on-field:

  .. index:: depends_on (field)

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

    .. collapse:: Points to the path of the last element in the geometry chain that places ...

        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.

        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.

  .. _/NXpinhole/TRANSFORMATIONS-group:

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

    .. collapse:: This is the group recommended for holding the chain of translation ...

        This is the group recommended for holding the chain of translation
        and rotation operations necessary to position the component within
        the instrument. The dependency chain may however traverse similar groups in
        other component groups.


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>`
* :ref:`/NXpinhole/TRANSFORMATIONS-group </NXpinhole/TRANSFORMATIONS-group>`
* :ref:`/NXpinhole@default-attribute </NXpinhole@default-attribute>`

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