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

**Description**:

  definition for a spin rotator.

**Symbols**:

  No symbol table

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

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

**Structure**:

  .. _/NXspin_rotator/description-field:

  .. index:: description (field)

  **description**: (required) :ref:`NX_CHAR <NX_CHAR>`

    extended description of the spin rotator.

  .. _/NXspin_rotator/beamline_distance-field:

  .. 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

  .. _/NXspin_rotator/set_Bfield_current-field:

  .. 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.

  .. _/NXspin_rotator/set_Efield_voltage-field:

  .. 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.

  .. _/NXspin_rotator/read_Bfield_current-group:

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

    current read from magnet supply.

    .. _/NXspin_rotator/read_Bfield_current/value-field:

    .. index:: value (field)

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


  .. _/NXspin_rotator/read_Bfield_voltage-group:

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

    voltage read from magnet supply.

    .. _/NXspin_rotator/read_Bfield_voltage/value-field:

    .. index:: value (field)

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


  .. _/NXspin_rotator/read_Efield_current-group:

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

    current read from HT supply.

    .. _/NXspin_rotator/read_Efield_current/value-field:

    .. index:: value (field)

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


  .. _/NXspin_rotator/read_Efield_voltage-group:

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

    voltage read from HT supply.

    .. _/NXspin_rotator/read_Efield_voltage/value-field:

    .. index:: value (field)

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



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

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


======================================================================================================== ========================================================================================================
documentation (reST source) anchor                                                                       web page (HTML) anchor                                                                                  
======================================================================================================== ========================================================================================================
:ref:`/NXspin_rotator/beamline_distance-field </NXspin_rotator/beamline_distance-field>`                 :ref:`#nxspin-rotator-beamline-distance-field </NXspin_rotator/beamline_distance-field>`                
:ref:`/NXspin_rotator/description-field </NXspin_rotator/description-field>`                             :ref:`#nxspin-rotator-description-field </NXspin_rotator/description-field>`                            
:ref:`/NXspin_rotator/read_Bfield_current-group </NXspin_rotator/read_Bfield_current-group>`             :ref:`#nxspin-rotator-read-bfield-current-group </NXspin_rotator/read_Bfield_current-group>`            
:ref:`/NXspin_rotator/read_Bfield_current/value-field </NXspin_rotator/read_Bfield_current/value-field>` :ref:`#nxspin-rotator-read-bfield-current-value-field </NXspin_rotator/read_Bfield_current/value-field>`
:ref:`/NXspin_rotator/read_Bfield_voltage-group </NXspin_rotator/read_Bfield_voltage-group>`             :ref:`#nxspin-rotator-read-bfield-voltage-group </NXspin_rotator/read_Bfield_voltage-group>`            
:ref:`/NXspin_rotator/read_Bfield_voltage/value-field </NXspin_rotator/read_Bfield_voltage/value-field>` :ref:`#nxspin-rotator-read-bfield-voltage-value-field </NXspin_rotator/read_Bfield_voltage/value-field>`
:ref:`/NXspin_rotator/read_Efield_current-group </NXspin_rotator/read_Efield_current-group>`             :ref:`#nxspin-rotator-read-efield-current-group </NXspin_rotator/read_Efield_current-group>`            
:ref:`/NXspin_rotator/read_Efield_current/value-field </NXspin_rotator/read_Efield_current/value-field>` :ref:`#nxspin-rotator-read-efield-current-value-field </NXspin_rotator/read_Efield_current/value-field>`
:ref:`/NXspin_rotator/read_Efield_voltage-group </NXspin_rotator/read_Efield_voltage-group>`             :ref:`#nxspin-rotator-read-efield-voltage-group </NXspin_rotator/read_Efield_voltage-group>`            
:ref:`/NXspin_rotator/read_Efield_voltage/value-field </NXspin_rotator/read_Efield_voltage/value-field>` :ref:`#nxspin-rotator-read-efield-voltage-value-field </NXspin_rotator/read_Efield_voltage/value-field>`
:ref:`/NXspin_rotator/set_Bfield_current-field </NXspin_rotator/set_Bfield_current-field>`               :ref:`#nxspin-rotator-set-bfield-current-field </NXspin_rotator/set_Bfield_current-field>`              
:ref:`/NXspin_rotator/set_Efield_voltage-field </NXspin_rotator/set_Efield_voltage-field>`               :ref:`#nxspin-rotator-set-efield-voltage-field </NXspin_rotator/set_Efield_voltage-field>`              
======================================================================================================== ========================================================================================================


**NXDL Source**:
  https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/contributed_definitions/NXspin_rotator.nxdl.xml