4.3.1.22. NXflipper

Status:

base class, extends NXobject

Description:

A spin flipper.

Symbols:

No symbol table

Groups cited:

NXtransformations

Structure:

@default: (optional) NX_CHAR

Declares which child group contains a path leading to a 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.

type: (optional) NX_CHAR

Any of these values: coil | current-sheet

flip_turns: (optional) NX_FLOAT {units=NX_PER_LENGTH}

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

comp_turns: (optional) NX_FLOAT {units=NX_PER_LENGTH}

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

guide_turns: (optional) NX_FLOAT {units=NX_PER_LENGTH}

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

flip_current: (optional) NX_FLOAT {units=NX_CURRENT}

Flipping field coil current in “on” state”

comp_current: (optional) NX_FLOAT {units=NX_CURRENT}

Compensating field coil current in “on” state”

guide_current: (optional) NX_FLOAT {units=NX_CURRENT}

Guide field coil current in “on” state

thickness: (optional) NX_FLOAT {units=NX_LENGTH}

thickness along path of neutron travel

depends_on: (optional) NX_CHAR

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.

TRANSFORMATIONS: (optional) NXtransformations

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.

NXDL Source:

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