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

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

**Description**:

  A class for a beamstop. Beamstops and their positions are important for SANS
  and SAXS experiments.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXgeometry`

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

**Structure**:

  .. index:: description (data field)

  **description**: :ref:`NX_CHAR <NX_CHAR>`

    description of beamstop

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

  .. index:: size (data field)

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

    size of beamstop

  .. index:: x (data field)

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

    x position of the beamstop in relation to the detector

  .. index:: y (data field)

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

    y position of the beamstop in relation to the detector

  .. index:: distance_to_detector (data field)

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

    distance of the beamstop to the detector

  .. index:: status (data field)

  **status**: :ref:`NX_CHAR <NX_CHAR>`


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

  **(geometry)**: :ref:`NXgeometry`

    engineering shape, orientation and position of the beam stop.

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