.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source ../../../../base_classes/NXinsertion_device.nxdl.xml

.. index::
    ! NXinsertion_device (base class)
    ! insertion device (base class)
    see: insertion device (base class); NXinsertion_device

.. _NXinsertion_device:

==================
NXinsertion_device
==================

**Status**:

  base class, extends :ref:`NXobject`, version 1.0

**Description**:

  Description of an insertion device, as in a synchrotron.

**Symbols**:

  No symbol table

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

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

**Structure**:

  .. index:: type (data field)

  **type**: :ref:`NX_CHAR <NX_CHAR>`


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

  .. index:: gap (data field)

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

    separation between opposing pairs of magnetic poles

  .. index:: taper (data field)

  **taper**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

    angular of gap difference between upstream and downstream ends of the insertion device

  .. index:: phase (data field)

  **phase**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}


  .. index:: poles (data field)

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

    number of poles

  .. index:: magnetic_wavelength (data field)

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


  .. index:: k (data field)

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

    beam displacement parameter

  .. index:: length (data field)

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

    length of insertion device

  .. index:: power (data field)

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

    total power delivered by insertion device

  .. index:: energy (data field)

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

    energy of peak intensity in output spectrum

  .. index:: bandwidth (data field)

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

    bandwidth of peak energy

  .. index:: harmonic (data field)

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

    harmonic number of peak

  **spectrum**: :ref:`NXdata`

    spectrum of insertion device

  **(geometry)**: :ref:`NXgeometry`

    "Engineering" position of insertion device

**Source**:
  Automatically generated from https://github.com/nexusformat/definitions/blob/master/base_classes/NXinsertion_device.nxdl.xml