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

.. index::
    ! NXspin_rotator (contributed definition)
    ! spin rotator (contributed definition)
    see: spin rotator (contributed definition); NXspin_rotator

.. _NXspin_rotator:

==============
NXspin_rotator
==============

**Status**:

  contributed definition, extends :ref:`NXobject`, version 1.0

**Description**:

  definition for a spin rotator.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXlog`

.. index:: NXlog (base class); used in contributed definition

**Structure**:

  .. index:: description (field)

  **description**: :ref:`NX_CHAR <NX_CHAR>`

    extended description of the spin rotator.

  .. index:: beamline distance (field)

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

    define position of beamline element relative to production target

  .. index:: set Bfield current (field)

  **set_Bfield_current**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}

    current set on magnet supply.

  .. index:: set Efield voltage (field)

  **set_Efield_voltage**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`}

    current set on HT supply.

  **read_Bfield_current**: (optional) :ref:`NXlog`

    current read from magnet supply.

    .. index:: value (field)

    **value**: :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}


  **read_Bfield_voltage**: (optional) :ref:`NXlog`

    voltage read from magnet supply.

    .. index:: value (field)

    **value**: :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`}


  **read_Efield_current**: (optional) :ref:`NXlog`

    current read from HT supply.

    .. index:: value (field)

    **value**: :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}


  **read_Efield_voltage**: (optional) :ref:`NXlog`

    voltage read from HT supply.

    .. index:: value (field)

    **value**: :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`}


**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/master/contributed_definitions/NXspin_rotator.nxdl.xml