.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXflipper.nxdl.xml -- DO NOT EDIT

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

.. _NXflipper:

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

..
    Contributors List

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

    .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28

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

**Description**:

  A spin flipper.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXtransformations`

.. index:: NXtransformations (base class); used in base class

**Structure**:

  .. _/NXflipper@default-attribute:

  .. index:: default (file attribute)

  **@default**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: Declares which child group contains a path leading  ...

        .. index:: plotting

        Declares which child group contains a path leading 
        to a :ref:`NXdata` group.

        It is recommended (as of NIAC2014) to use this attribute
        to help define the path to the default dataset to be plotted.
        See https://www.nexusformat.org/2014_How_to_find_default_data.html
        for a summary of the discussion.

  .. _/NXflipper/type-field:

  .. index:: type (field)

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


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

  .. _/NXflipper/flip_turns-field:

  .. index:: flip_turns (field)

  **flip_turns**: (optional) :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

  .. _/NXflipper/comp_turns-field:

  .. index:: comp_turns (field)

  **comp_turns**: (optional) :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

  .. _/NXflipper/guide_turns-field:

  .. index:: guide_turns (field)

  **guide_turns**: (optional) :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

  .. _/NXflipper/flip_current-field:

  .. index:: flip_current (field)

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

    Flipping field coil current in "on" state"

  .. _/NXflipper/comp_current-field:

  .. index:: comp_current (field)

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

    Compensating field coil current in "on" state"

  .. _/NXflipper/guide_current-field:

  .. index:: guide_current (field)

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

    Guide field coil current in "on" state

  .. _/NXflipper/thickness-field:

  .. index:: thickness (field)

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

    thickness along path of neutron travel

  .. _/NXflipper/depends_on-field:

  .. index:: depends_on (field)

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

    .. collapse:: NeXus positions components by applying a set of translations and rotations ...

        NeXus positions components by applying a set of translations and rotations
        to apply to the component starting from 0, 0, 0. The order of these operations
        is critical and forms what NeXus calls a dependency chain. The depends_on
        field defines the path to the top most operation of the dependency chain or the
        string "." if located in the origin. Usually these operations are stored in a
        NXtransformations group. But NeXus allows them to be stored anywhere.

        .. todo::
          Add a definition for the reference point of a spin flipper.


  .. _/NXflipper/TRANSFORMATIONS-group:

  **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` 

    .. collapse:: This is the group recommended for holding the chain of translation ...

        This is the group recommended for holding the chain of translation
        and rotation operations necessary to position the component within
        the instrument. The dependency chain may however traverse similar groups in
        other component groups.


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

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


* :ref:`/NXflipper/comp_current-field </NXflipper/comp_current-field>`
* :ref:`/NXflipper/comp_turns-field </NXflipper/comp_turns-field>`
* :ref:`/NXflipper/depends_on-field </NXflipper/depends_on-field>`
* :ref:`/NXflipper/flip_current-field </NXflipper/flip_current-field>`
* :ref:`/NXflipper/flip_turns-field </NXflipper/flip_turns-field>`
* :ref:`/NXflipper/guide_current-field </NXflipper/guide_current-field>`
* :ref:`/NXflipper/guide_turns-field </NXflipper/guide_turns-field>`
* :ref:`/NXflipper/thickness-field </NXflipper/thickness-field>`
* :ref:`/NXflipper/TRANSFORMATIONS-group </NXflipper/TRANSFORMATIONS-group>`
* :ref:`/NXflipper/type-field </NXflipper/type-field>`
* :ref:`/NXflipper@default-attribute </NXflipper@default-attribute>`

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