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

.. index::
    ! NXflipper (base class)
    ! flipper (base class)
    see: flipper (base class); NXflipper

.. _NXflipper:

=========
NXflipper
=========

**Status**:

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

**Description**:

  Template of a beamline spin flipper.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. index:: type (data field)

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


    Any of these values: ``coil`` | ``current-sheet``

  .. index:: flip_turns (data field)

  **flip_turns**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_PER_LENGTH <NX_PER_LENGTH>`}

    Linear density of turns (such as number of turns/cm) in flipping field coils

  .. index:: comp_turns (data field)

  **comp_turns**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_PER_LENGTH <NX_PER_LENGTH>`}

    Linear density of turns (such as number of turns/cm) in compensating field coils

  .. index:: guide_turns (data field)

  **guide_turns**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_PER_LENGTH <NX_PER_LENGTH>`}

    Linear density of turns (such as number of turns/cm) in guide field coils

  .. index:: flip_current (data field)

  **flip_current**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}

    Flipping field coil current in "on" state"

  .. index:: comp_current (data field)

  **comp_current**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}

    Compensating field coil current in "on" state"

  .. index:: guide_current (data field)

  **guide_current**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}

    Guide field coil current in "on" state"

  .. index:: thickness (data field)

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

    thickness along path of neutron travel

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