.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXgrating.nxdl.xml -- DO NOT EDIT .. index:: ! NXgrating (base class) ! grating (base class) see: grating (base class); NXgrating .. _NXgrating: ========= NXgrating ========= .. 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-02-04 **Status**: base class, extends :ref:`NXobject` **Description**: A diffraction grating, as could be used in a soft X-ray monochromator **Symbols**: No symbol table **Groups cited**: :ref:`NXdata`, :ref:`NXoff_geometry`, :ref:`NXshape`, :ref:`NXtransformations` .. index:: NXshape (base class); used in base class, NXdata (base class); used in base class, NXoff_geometry (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXgrating@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. .. _/NXgrating/angles-field: .. index:: angles (field) **angles**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_ANGLE `} Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first. Blazed gratings can be identified by the low value of the first-listed angle. .. _/NXgrating/period-field: .. index:: period (field) **period**: (optional) :ref:`NX_FLOAT ` (Rank: 1) {units=\ :ref:`NX_LENGTH `} List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position. Gratings which do not have variable line spacing will only have a single coefficient (constant). .. _/NXgrating/duty_cycle-field: .. index:: duty_cycle (field) **duty_cycle**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_UNITLESS `} .. _/NXgrating/depth-field: .. index:: depth (field) **depth**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. _/NXgrating/diffraction_order-field: .. index:: diffraction_order (field) **diffraction_order**: (optional) :ref:`NX_INT ` {units=\ :ref:`NX_UNITLESS `} .. _/NXgrating/deflection_angle-field: .. index:: deflection_angle (field) **deflection_angle**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Angle between the incident beam and the utilised outgoing beam. .. _/NXgrating/interior_atmosphere-field: .. index:: interior_atmosphere (field) **interior_atmosphere**: (optional) :ref:`NX_CHAR ` Any of these values: ``vacuum`` | ``helium`` | ``argon`` .. _/NXgrating/substrate_material-field: .. index:: substrate_material (field) **substrate_material**: (optional) :ref:`NX_CHAR ` .. _/NXgrating/substrate_density-field: .. index:: substrate_density (field) **substrate_density**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_MASS_DENSITY `} .. _/NXgrating/substrate_thickness-field: .. index:: substrate_thickness (field) **substrate_thickness**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. _/NXgrating/coating_material-field: .. index:: coating_material (field) **coating_material**: (optional) :ref:`NX_CHAR ` .. _/NXgrating/substrate_roughness-field: .. index:: substrate_roughness (field) **substrate_roughness**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. _/NXgrating/coating_roughness-field: .. index:: coating_roughness (field) **coating_roughness**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. _/NXgrating/layer_thickness-field: .. index:: layer_thickness (field) **layer_thickness**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} An array describing the thickness of each layer .. _/NXgrating/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 bending grating. .. _/NXgrating/shape-group: **shape**: (optional) :ref:`NXshape` .. index:: deprecated **DEPRECATED**: Use NXoff_geometry to describe the shape of grating A NXshape group describing the shape of the mirror .. _/NXgrating/figure_data-group: **figure_data**: (optional) :ref:`NXdata` Numerical description of the surface figure of the mirror. .. _/NXgrating/OFF_GEOMETRY-group: **OFF_GEOMETRY**: (optional) :ref:`NXoff_geometry` This group describes the shape of the beam line component .. _/NXgrating/TRANSFORMATIONS-group: **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` .. collapse:: "Engineering" position of the grating ... "Engineering" position of the grating Transformations used by this component to define its position and orientation. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXgrating/angles-field ` * :ref:`/NXgrating/coating_material-field ` * :ref:`/NXgrating/coating_roughness-field ` * :ref:`/NXgrating/deflection_angle-field ` * :ref:`/NXgrating/depends_on-field ` * :ref:`/NXgrating/depth-field ` * :ref:`/NXgrating/diffraction_order-field ` * :ref:`/NXgrating/duty_cycle-field ` * :ref:`/NXgrating/figure_data-group ` * :ref:`/NXgrating/interior_atmosphere-field ` * :ref:`/NXgrating/layer_thickness-field ` * :ref:`/NXgrating/OFF_GEOMETRY-group ` * :ref:`/NXgrating/period-field ` * :ref:`/NXgrating/shape-group ` * :ref:`/NXgrating/substrate_density-field ` * :ref:`/NXgrating/substrate_material-field ` * :ref:`/NXgrating/substrate_roughness-field ` * :ref:`/NXgrating/substrate_thickness-field ` * :ref:`/NXgrating/TRANSFORMATIONS-group ` * :ref:`/NXgrating@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXgrating.nxdl.xml