.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXbending_magnet.nxdl.xml -- DO NOT EDIT .. index:: ! NXbending_magnet (base class) ! bending_magnet (base class) see: bending_magnet (base class); NXbending_magnet .. _NXbending_magnet: ================ NXbending_magnet ================ .. Contributors List .. |contrib_name| replace:: Woutdenolf|woutdenolf|https://avatars.githubusercontent.com/u/7264703?v=4|2022-06-17 .. |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 bending magnet **Symbols**: No symbol table **Groups cited**: :ref:`NXdata`, :ref:`NXgeometry`, :ref:`NXoff_geometry`, :ref:`NXtransformations` .. index:: NXdata (base class); used in base class, NXgeometry (base class); used in base class, NXoff_geometry (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXbending_magnet@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`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. .. _/NXbending_magnet/critical_energy-field: .. index:: critical_energy (field) **critical_energy**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} .. _/NXbending_magnet/bending_radius-field: .. index:: bending_radius (field) **bending_radius**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. _/NXbending_magnet/magnetic_field-field: .. index:: magnetic_field (field) **magnetic_field**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_CURRENT `} strength of magnetic field of dipole magnets .. _/NXbending_magnet/accepted_photon_beam_divergence-field: .. index:: accepted_photon_beam_divergence (field) **accepted_photon_beam_divergence**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} An array of four numbers giving X+, X-, Y+ and Y- half divergence .. _/NXbending_magnet/source_distance_x-field: .. index:: source_distance_x (field) **source_distance_x**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. collapse:: 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. .. _/NXbending_magnet/source_distance_y-field: .. index:: source_distance_y (field) **source_distance_y**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. collapse:: 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. .. _/NXbending_magnet/divergence_x_plus-field: .. index:: divergence_x_plus (field) **divergence_x_plus**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. collapse:: 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. .. _/NXbending_magnet/divergence_x_minus-field: .. index:: divergence_x_minus (field) **divergence_x_minus**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. collapse:: 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. .. _/NXbending_magnet/divergence_y_plus-field: .. index:: divergence_y_plus (field) **divergence_y_plus**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. collapse:: 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. .. _/NXbending_magnet/divergence_y_minus-field: .. index:: divergence_y_minus (field) **divergence_y_minus**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. collapse:: 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. .. _/NXbending_magnet/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`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 bending magnet. .. _/NXbending_magnet/spectrum-group: **spectrum**: (optional) :ref:`NXdata` bending magnet spectrum .. _/NXbending_magnet/GEOMETRY-group: **GEOMETRY**: (optional) :ref:`NXgeometry` .. index:: deprecated **DEPRECATED**: Use the field `depends_on` and :ref:`NXtransformations` to position the bending magnet and NXoff_geometry to describe its shape instead "Engineering" position of bending magnet .. _/NXbending_magnet/OFF_GEOMETRY-group: **OFF_GEOMETRY**: (optional) :ref:`NXoff_geometry` This group describes the shape of the beam line component .. _/NXbending_magnet/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:`/NXbending_magnet/accepted_photon_beam_divergence-field ` * :ref:`/NXbending_magnet/bending_radius-field ` * :ref:`/NXbending_magnet/critical_energy-field ` * :ref:`/NXbending_magnet/depends_on-field ` * :ref:`/NXbending_magnet/divergence_x_minus-field ` * :ref:`/NXbending_magnet/divergence_x_plus-field ` * :ref:`/NXbending_magnet/divergence_y_minus-field ` * :ref:`/NXbending_magnet/divergence_y_plus-field ` * :ref:`/NXbending_magnet/GEOMETRY-group ` * :ref:`/NXbending_magnet/magnetic_field-field ` * :ref:`/NXbending_magnet/OFF_GEOMETRY-group ` * :ref:`/NXbending_magnet/source_distance_x-field ` * :ref:`/NXbending_magnet/source_distance_y-field ` * :ref:`/NXbending_magnet/spectrum-group ` * :ref:`/NXbending_magnet/TRANSFORMATIONS-group ` * :ref:`/NXbending_magnet@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXbending_magnet.nxdl.xml