.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source ../../../../base_classes/NXbending_magnet.nxdl.xml

.. index::
    ! NXbending_magnet (base class)
    ! bending magnet (base class)
    see: bending magnet (base class); NXbending_magnet

.. _NXbending_magnet:

================
NXbending_magnet
================

**Status**:

  base class, extends :ref:`NXobject`, version 1.0

**Description**:

  description for a bending magnet

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdata`, :ref:`NXgeometry`

.. index:: NXdata (base class); used in base class, NXgeometry (base class); used in base class

**Structure**:

  .. index:: critical_energy (data field)

  **critical_energy**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ENERGY <NX_ENERGY>`}


  .. index:: bending_radius (data field)

  **bending_radius**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}


  .. index:: magnetic_field (data field)

  **magnetic_field**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}

    strength of magnetic field of dipole magnets

  .. index:: accepted_photon_beam_divergence (data field)

  **accepted_photon_beam_divergence**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

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

  .. index:: source_distance_x (data field)

  **source_distance_x**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

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

  .. index:: source_distance_y (data field)

  **source_distance_y**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

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

  .. index:: divergence_x_plus (data field)

  **divergence_x_plus**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

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

  .. index:: divergence_x_minus (data field)

  **divergence_x_minus**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

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

  .. index:: divergence_y_plus (data field)

  **divergence_y_plus**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

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

  .. index:: divergence_y_minus (data field)

  **divergence_y_minus**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

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

  **spectrum**: :ref:`NXdata`

    bending magnet spectrum

  **(geometry)**: :ref:`NXgeometry`

    "Engineering" position of bending magnet

**Source**:
  Automatically generated from https://github.com/nexusformat/definitions/blob/master/base_classes/NXbending_magnet.nxdl.xml