.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXmonochromator.nxdl.xml -- DO NOT EDIT .. index:: ! NXmonochromator (base class) ! monochromator (base class) see: monochromator (base class); NXmonochromator .. _NXmonochromator: =============== NXmonochromator =============== .. 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:: Benajamin|benajamin|https://avatars.githubusercontent.com/u/10222548?v=4|2015-04-27 **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: A wavelength defining device. ... A wavelength defining device. This is a base class for everything which selects a wavelength or energy, be it a monochromator crystal, a velocity selector, an undulator or whatever. The expected units are: * wavelength: angstrom * energy: eV **Symbols**: No symbol table **Groups cited**: :ref:`NXcrystal`, :ref:`NXdata`, :ref:`NXgeometry`, :ref:`NXgrating`, :ref:`NXoff_geometry`, :ref:`NXtransformations`, :ref:`NXvelocity_selector` .. index:: NXdata (base class); used in base class, NXgeometry (base class); used in base class, NXoff_geometry (base class); used in base class, NXcrystal (base class); used in base class, NXvelocity_selector (base class); used in base class, NXgrating (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXmonochromator@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. .. _/NXmonochromator/wavelength-field: .. index:: wavelength (field) **wavelength**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVELENGTH `} wavelength selected .. _/NXmonochromator/wavelength_error-field: .. index:: wavelength_error (field) **wavelength_error**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVELENGTH `} .. index:: deprecated **DEPRECATED**: see https://github.com/nexusformat/definitions/issues/820 wavelength standard deviation .. _/NXmonochromator/wavelength_errors-field: .. index:: wavelength_errors (field) **wavelength_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVELENGTH `} wavelength standard deviation .. _/NXmonochromator/energy-field: .. index:: energy (field) **energy**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} energy selected .. _/NXmonochromator/energy_error-field: .. index:: energy_error (field) **energy_error**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} .. index:: deprecated **DEPRECATED**: see https://github.com/nexusformat/definitions/issues/820 energy standard deviation .. _/NXmonochromator/energy_errors-field: .. index:: energy_errors (field) **energy_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} energy standard deviation .. _/NXmonochromator/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. .. todo:: Add a definition for the reference point of a monochromator. .. _/NXmonochromator/distribution-group: **distribution**: (optional) :ref:`NXdata` .. _/NXmonochromator/geometry-group: **geometry**: (optional) :ref:`NXgeometry` .. index:: deprecated **DEPRECATED**: Use the field `depends_on` and :ref:`NXtransformations` to position the monochromator and NXoff_geometry to describe its shape instead .. _/NXmonochromator/OFF_GEOMETRY-group: **OFF_GEOMETRY**: (optional) :ref:`NXoff_geometry` This group describes the shape of the beam line component .. _/NXmonochromator/CRYSTAL-group: **CRYSTAL**: (optional) :ref:`NXcrystal` Use as many crystals as necessary to describe .. _/NXmonochromator/VELOCITY_SELECTOR-group: **VELOCITY_SELECTOR**: (optional) :ref:`NXvelocity_selector` .. _/NXmonochromator/GRATING-group: **GRATING**: (optional) :ref:`NXgrating` For diffraction grating based monochromators .. _/NXmonochromator/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:`/NXmonochromator/CRYSTAL-group ` * :ref:`/NXmonochromator/depends_on-field ` * :ref:`/NXmonochromator/distribution-group ` * :ref:`/NXmonochromator/energy-field ` * :ref:`/NXmonochromator/energy_error-field ` * :ref:`/NXmonochromator/energy_errors-field ` * :ref:`/NXmonochromator/geometry-group ` * :ref:`/NXmonochromator/GRATING-group ` * :ref:`/NXmonochromator/OFF_GEOMETRY-group ` * :ref:`/NXmonochromator/TRANSFORMATIONS-group ` * :ref:`/NXmonochromator/VELOCITY_SELECTOR-group ` * :ref:`/NXmonochromator/wavelength-field ` * :ref:`/NXmonochromator/wavelength_error-field ` * :ref:`/NXmonochromator/wavelength_errors-field ` * :ref:`/NXmonochromator@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXmonochromator.nxdl.xml