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

.. index::
    ! NXbeam_stop (base class)
    ! beam_stop (base class)
    see: beam_stop (base class); NXbeam_stop

.. _NXbeam_stop:

===========
NXbeam_stop
===========

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  .. collapse:: A device that blocks the beam completely, usually to protect a detector. ...

      A device that blocks the beam completely, usually to protect a detector.

      Beamstops and their positions are important for SANS
      and SAXS experiments.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXcylindrical_geometry`, :ref:`NXgeometry`, :ref:`NXoff_geometry`

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

**Structure**:

  .. _/NXbeam_stop/description-field:

  .. index:: description (field)

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

    .. collapse:: description of beamstop ...

        description of beamstop

        Any of these values: ``circular`` | ``rectangular``

  .. _/NXbeam_stop/size-field:

  .. index:: size (field)

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

    .. collapse:: Size of beamstop. If this is not sufficient to describe the beam stop use ...

        Size of beamstop. If this is not sufficient to describe the beam stop use
        NXoff_geometry instead.

  .. _/NXbeam_stop/x-field:

  .. index:: x (field)

  **x**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: x position of the beamstop in relation to the detector. ...

        x position of the beamstop in relation to the detector.
        Note, it is recommended to use NXtransformations instead.

  .. _/NXbeam_stop/y-field:

  .. index:: y (field)

  **y**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: y position of the beamstop in relation to the detector. ...

        y position of the beamstop in relation to the detector.
        Note, it is recommended to use NXtransformations instead.

  .. _/NXbeam_stop/distance_to_detector-field:

  .. index:: distance_to_detector (field)

  **distance_to_detector**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: distance of the beamstop to the detector. ...

        distance of the beamstop to the detector.
        Note, it is recommended to use NXtransformations instead.

  .. _/NXbeam_stop/status-field:

  .. index:: status (field)

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


    Any of these values: ``in`` | ``out``

  .. _/NXbeam_stop/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 beam stop is its center in the x and y axis. The re ...

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

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

  .. _/NXbeam_stop/GEOMETRY-group:

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


    .. index:: deprecated


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

    engineering shape, orientation and position of the beam stop.

  .. _/NXbeam_stop/OFF_GEOMETRY-group:

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

    This group describes the shape of the beam line component

  .. _/NXbeam_stop/CYLINDRICAL_GEOMETRY-group:

  :bolditalic:`CYLINDRICAL_GEOMETRY`: (optional) :ref:`NXcylindrical_geometry` 

    .. collapse:: This group is an alternative to NXoff_geometry for describing the shape ...

        This group is an alternative to NXoff_geometry for describing the shape
        of the beam stop.


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

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


* :ref:`/NXbeam_stop/CYLINDRICAL_GEOMETRY-group </NXbeam_stop/CYLINDRICAL_GEOMETRY-group>`
* :ref:`/NXbeam_stop/depends_on-field </NXbeam_stop/depends_on-field>`
* :ref:`/NXbeam_stop/description-field </NXbeam_stop/description-field>`
* :ref:`/NXbeam_stop/distance_to_detector-field </NXbeam_stop/distance_to_detector-field>`
* :ref:`/NXbeam_stop/GEOMETRY-group </NXbeam_stop/GEOMETRY-group>`
* :ref:`/NXbeam_stop/OFF_GEOMETRY-group </NXbeam_stop/OFF_GEOMETRY-group>`
* :ref:`/NXbeam_stop/size-field </NXbeam_stop/size-field>`
* :ref:`/NXbeam_stop/status-field </NXbeam_stop/status-field>`
* :ref:`/NXbeam_stop/x-field </NXbeam_stop/x-field>`
* :ref:`/NXbeam_stop/y-field </NXbeam_stop/y-field>`

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