2.3.3.1.5. NXbending_magnet

Status:

base class, extends NXobject

Description:

A bending magnet

Symbols:

No symbol table

Groups cited:

NXdata, NXgeometry, NXoff_geometry, NXtransformations

Structure:

@default: (optional) NX_CHAR

Declares which child group contains a path leading ...

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.

critical_energy: (optional) NX_FLOAT {units=NX_ENERGY}

bending_radius: (optional) NX_FLOAT {units=NX_LENGTH}

magnetic_field: (optional) NX_FLOAT {units=NX_CURRENT}

strength of magnetic field of dipole magnets

accepted_photon_beam_divergence: (optional) NX_FLOAT {units=NX_LENGTH}

An array of four numbers giving X+, X-, Y+ and Y- half divergence

source_distance_x: (optional) NX_FLOAT {units=NX_LENGTH}

Distance of source point from particle beam waist in X (horizontal) direction. ...

Distance of source point from particle beam waist in X (horizontal) direction. Note, it is recommended to use NXtransformations instead to place component.

source_distance_y: (optional) NX_FLOAT {units=NX_LENGTH}

Distance of source point from particle beam waist in Y (vertical) direction. ...

Distance of source point from particle beam waist in Y (vertical) direction. Note, it is recommended to use NXtransformations instead to place component.

divergence_x_plus: (optional) NX_FLOAT {units=NX_ANGLE}

Accepted photon beam divergence in X+ (horizontal outboard) direction. ...

Accepted photon beam divergence in X+ (horizontal outboard) direction. Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.

divergence_x_minus: (optional) NX_FLOAT {units=NX_ANGLE}

Accepted photon beam divergence in X- (horizontal inboard) direction. ...

Accepted photon beam divergence in X- (horizontal inboard) direction. Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.

divergence_y_plus: (optional) NX_FLOAT {units=NX_ANGLE}

Accepted photon beam divergence in Y+ (vertical upward) direction. ...

Accepted photon beam divergence in Y+ (vertical upward) direction. Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.

divergence_y_minus: (optional) NX_FLOAT {units=NX_ANGLE}

Accepted photon beam divergence in Y- (vertical downward) direction. ...

Accepted photon beam divergence in Y- (vertical downward) direction. Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.

depends_on: (optional) NX_CHAR

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.

spectrum: (optional) NXdata

bending magnet spectrum

GEOMETRY: (optional) NXgeometry

DEPRECATED: Use the field depends_on and NXtransformations to position the bending magnet and NXoff_geometry to describe its shape instead

“Engineering” position of bending magnet

OFF_GEOMETRY: (optional) NXoff_geometry

This group describes the shape of the beam line component

TRANSFORMATIONS: (optional) NXtransformations

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.

NXDL Source:

https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXbending_magnet.nxdl.xml