.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXinsertion_device.nxdl.xml -- DO NOT EDIT .. index:: ! NXinsertion_device (base class) ! insertion_device (base class) see: insertion_device (base class); NXinsertion_device .. _NXinsertion_device: ================== NXinsertion_device ================== .. 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 **Status**: base class, extends :ref:`NXobject` **Description**: An insertion device, as used in a synchrotron light source. **Symbols**: No symbol table **Groups cited**: :ref:`NXdata`, :ref:`NXgeometry`, :ref:`NXoff_geometry`, :ref:`NXtransformations` .. index:: NXdata (base class); used in base class, NXgeometry (base class); used in base class, NXoff_geometry (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXinsertion_device@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. .. _/NXinsertion_device/type-field: .. index:: type (field) **type**: (optional) :ref:`NX_CHAR ` Any of these values: ``undulator`` | ``wiggler`` .. _/NXinsertion_device/gap-field: .. index:: gap (field) **gap**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} separation between opposing pairs of magnetic poles .. _/NXinsertion_device/taper-field: .. index:: taper (field) **taper**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} angular of gap difference between upstream and downstream ends of the insertion device .. _/NXinsertion_device/phase-field: .. index:: phase (field) **phase**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. _/NXinsertion_device/poles-field: .. index:: poles (field) **poles**: (optional) :ref:`NX_INT ` {units=\ :ref:`NX_UNITLESS `} number of poles .. _/NXinsertion_device/magnetic_wavelength-field: .. index:: magnetic_wavelength (field) **magnetic_wavelength**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVELENGTH `} .. _/NXinsertion_device/k-field: .. index:: k (field) **k**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_DIMENSIONLESS `} beam displacement parameter .. _/NXinsertion_device/length-field: .. index:: length (field) **length**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} length of insertion device .. _/NXinsertion_device/power-field: .. index:: power (field) **power**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_POWER `} total power delivered by insertion device .. _/NXinsertion_device/energy-field: .. index:: energy (field) **energy**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} energy of peak intensity in output spectrum .. _/NXinsertion_device/bandwidth-field: .. index:: bandwidth (field) **bandwidth**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} bandwidth of peak energy .. _/NXinsertion_device/harmonic-field: .. index:: harmonic (field) **harmonic**: (optional) :ref:`NX_INT ` {units=\ :ref:`NX_UNITLESS `} harmonic number of peak .. _/NXinsertion_device/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 insertion device. .. _/NXinsertion_device/spectrum-group: **spectrum**: (optional) :ref:`NXdata` spectrum of insertion device .. _/NXinsertion_device/GEOMETRY-group: **GEOMETRY**: (optional) :ref:`NXgeometry` .. index:: deprecated **DEPRECATED**: Use the field `depends_on` and :ref:`NXtransformations` to position the device and NXoff_geometry to describe its shape instead "Engineering" position of insertion device .. _/NXinsertion_device/OFF_GEOMETRY-group: **OFF_GEOMETRY**: (optional) :ref:`NXoff_geometry` This group describes the shape of the beam line component .. _/NXinsertion_device/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:`/NXinsertion_device/bandwidth-field ` * :ref:`/NXinsertion_device/depends_on-field ` * :ref:`/NXinsertion_device/energy-field ` * :ref:`/NXinsertion_device/gap-field ` * :ref:`/NXinsertion_device/GEOMETRY-group ` * :ref:`/NXinsertion_device/harmonic-field ` * :ref:`/NXinsertion_device/k-field ` * :ref:`/NXinsertion_device/length-field ` * :ref:`/NXinsertion_device/magnetic_wavelength-field ` * :ref:`/NXinsertion_device/OFF_GEOMETRY-group ` * :ref:`/NXinsertion_device/phase-field ` * :ref:`/NXinsertion_device/poles-field ` * :ref:`/NXinsertion_device/power-field ` * :ref:`/NXinsertion_device/spectrum-group ` * :ref:`/NXinsertion_device/taper-field ` * :ref:`/NXinsertion_device/TRANSFORMATIONS-group ` * :ref:`/NXinsertion_device/type-field ` * :ref:`/NXinsertion_device@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXinsertion_device.nxdl.xml