2.3.3.1.36. NXinsertion_device

Status:

base class, extends NXcomponent

Description:

An insertion device, as used in a synchrotron light source.

Symbols:

No symbol table

Groups cited:

NXdata, NXgeometry, NXoff_geometry

Structure:

type: (optional) NX_CHAR

Any of these values: undulator | wiggler

gap: (optional) NX_FLOAT {units=NX_LENGTH}

separation between opposing pairs of magnetic poles

taper: (optional) NX_FLOAT {units=NX_ANGLE}

angular of gap difference between upstream and downstream ends of the insertion device

phase: (optional) NX_FLOAT {units=NX_ANGLE}

poles: (optional) NX_INT {units=NX_UNITLESS}

number of poles

magnetic_wavelength: (optional) NX_FLOAT {units=NX_WAVELENGTH}

k: (optional) NX_FLOAT {units=NX_DIMENSIONLESS}

beam displacement parameter

length: (optional) NX_FLOAT {units=NX_LENGTH}

length of insertion device

power: (optional) NX_FLOAT {units=NX_POWER}

total power delivered by insertion device

energy: (optional) NX_FLOAT {units=NX_ENERGY}

energy of peak intensity in output spectrum

bandwidth: (optional) NX_FLOAT {units=NX_ENERGY}

bandwidth of peak energy

harmonic: (optional) NX_INT {units=NX_UNITLESS}

harmonic number of peak

depends_on: (optional) NX_CHAR ⤆

Add a definition for the reference point of a insertion device. ...

spectrum: (optional) NXdata ⤆

spectrum of insertion device

GEOMETRY: (optional) NXgeometry

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

“Engineering” position of insertion device

OFF_GEOMETRY: (optional) NXoff_geometry

This group describes the shape of the beam line component

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/NXinsertion_device.nxdl.xml