.. 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:: Lukas Pielsticker|lukaspie|https://avatars.githubusercontent.com/u/50139597?v=4|2025-02-13

    .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2024-02-18

    .. |contrib_name| replace:: Aaron Brewster|phyy-nx|https://avatars.githubusercontent.com/u/13471434?v=4|2022-06-15

    .. |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:`NXcomponent`

**Description**:

  An insertion device, as used in a synchrotron light source.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdata`, :ref:`NXgeometry`, :ref:`NXoff_geometry`

.. index:: NXdata (base class); used in base class, NXgeometry (base class); used in base class, NXoff_geometry (base class); used in base class

**Structure**:

  .. _/NXinsertion_device/type-field:

  .. index:: type (field)

  **type**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: It is recommended (effective from 2025) to use the "wavelength_shifter" choice ...

        It is recommended (effective from 2025) to use the "wavelength_shifter" choice for 3-pole wigglers, while reserving the generic "wiggler" designation for extended multipole wigglers.

        Any of these values: ``undulator`` | ``wiggler`` | ``wavelength_shifter``

  .. _/NXinsertion_device/gap-field:

  .. index:: gap (field)

  **gap**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    separation between opposing pairs of magnetic poles

  .. _/NXinsertion_device/taper-field:

  .. index:: taper (field)

  **taper**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <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 <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} 


  .. _/NXinsertion_device/poles-field:

  .. index:: poles (field)

  **poles**: (optional) :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    number of poles

  .. _/NXinsertion_device/magnetic_wavelength-field:

  .. index:: magnetic_wavelength (field)

  **magnetic_wavelength**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_WAVELENGTH <NX_WAVELENGTH>`} 


  .. _/NXinsertion_device/k-field:

  .. index:: k (field)

  **k**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_DIMENSIONLESS <NX_DIMENSIONLESS>`} 

    beam displacement parameter

  .. _/NXinsertion_device/length-field:

  .. index:: length (field)

  **length**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    length of insertion device

  .. _/NXinsertion_device/power-field:

  .. index:: power (field)

  **power**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_POWER <NX_POWER>`} 

    total power delivered by insertion device

  .. _/NXinsertion_device/energy-field:

  .. index:: energy (field)

  **energy**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ENERGY <NX_ENERGY>`} 

    energy of peak intensity in output spectrum

  .. _/NXinsertion_device/bandwidth-field:

  .. index:: bandwidth (field)

  **bandwidth**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ENERGY <NX_ENERGY>`} 

    bandwidth of peak energy

  .. _/NXinsertion_device/harmonic-field:

  .. index:: harmonic (field)

  **harmonic**: (optional) :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    harmonic number of peak

  .. _/NXinsertion_device/depends_on-field:

  .. index:: depends_on (field)

  **depends_on**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXcomponent/depends_on-field>`

    .. collapse::   Add a definition for the reference point of a insertion device. ...

        .. todo::
          Add a definition for the reference point of a insertion device.

  .. _/NXinsertion_device/spectrum-group:

  **spectrum**: (optional) :ref:`NXdata` :ref:`⤆ </NXobject/DATA-group>`

    spectrum of insertion device

  .. _/NXinsertion_device/GEOMETRY-group:

  :bolditalic:`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:

  :bolditalic:`OFF_GEOMETRY`: (optional) :ref:`NXoff_geometry` 

    This group describes the shape of the beam line component


Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXinsertion_device/bandwidth-field </NXinsertion_device/bandwidth-field>`
* :ref:`/NXinsertion_device/depends_on-field </NXinsertion_device/depends_on-field>`
* :ref:`/NXinsertion_device/energy-field </NXinsertion_device/energy-field>`
* :ref:`/NXinsertion_device/gap-field </NXinsertion_device/gap-field>`
* :ref:`/NXinsertion_device/GEOMETRY-group </NXinsertion_device/GEOMETRY-group>`
* :ref:`/NXinsertion_device/harmonic-field </NXinsertion_device/harmonic-field>`
* :ref:`/NXinsertion_device/k-field </NXinsertion_device/k-field>`
* :ref:`/NXinsertion_device/length-field </NXinsertion_device/length-field>`
* :ref:`/NXinsertion_device/magnetic_wavelength-field </NXinsertion_device/magnetic_wavelength-field>`
* :ref:`/NXinsertion_device/OFF_GEOMETRY-group </NXinsertion_device/OFF_GEOMETRY-group>`
* :ref:`/NXinsertion_device/phase-field </NXinsertion_device/phase-field>`
* :ref:`/NXinsertion_device/poles-field </NXinsertion_device/poles-field>`
* :ref:`/NXinsertion_device/power-field </NXinsertion_device/power-field>`
* :ref:`/NXinsertion_device/spectrum-group </NXinsertion_device/spectrum-group>`
* :ref:`/NXinsertion_device/taper-field </NXinsertion_device/taper-field>`
* :ref:`/NXinsertion_device/type-field </NXinsertion_device/type-field>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/base_classes/NXinsertion_device.nxdl.xml