.. 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 =========== .. Contributors List .. |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 .. |contrib_name| replace:: Joachim Wuttke (l)|jwuttke|https://avatars.githubusercontent.com/u/5262000?v=4|2014-08-26 **Status**: base class, extends :ref:`NXobject` **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`, :ref:`NXtransformations` .. index:: NXgeometry (base class); used in base class, NXoff_geometry (base class); used in base class, NXcylindrical_geometry (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXbeam_stop@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`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. .. _/NXbeam_stop/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` .. 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 ` {units=\ :ref:`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 ` {units=\ :ref:`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 ` {units=\ :ref:`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 ` {units=\ :ref:`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 ` Any of these values: ``in`` | ``out`` .. _/NXbeam_stop/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` .. collapse:: NeXus positions components by applying a set of translations and rotations ... NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere. 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: **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: **OFF_GEOMETRY**: (optional) :ref:`NXoff_geometry` This group describes the shape of the beam line component .. _/NXbeam_stop/CYLINDRICAL_GEOMETRY-group: **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. .. _/NXbeam_stop/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:`/NXbeam_stop/CYLINDRICAL_GEOMETRY-group ` * :ref:`/NXbeam_stop/depends_on-field ` * :ref:`/NXbeam_stop/description-field ` * :ref:`/NXbeam_stop/distance_to_detector-field ` * :ref:`/NXbeam_stop/GEOMETRY-group ` * :ref:`/NXbeam_stop/OFF_GEOMETRY-group ` * :ref:`/NXbeam_stop/size-field ` * :ref:`/NXbeam_stop/status-field ` * :ref:`/NXbeam_stop/TRANSFORMATIONS-group ` * :ref:`/NXbeam_stop/x-field ` * :ref:`/NXbeam_stop/y-field ` * :ref:`/NXbeam_stop@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXbeam_stop.nxdl.xml