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

.. index::
    ! NXspindispersion (base class)
    ! spindispersion (base class)
    see: spindispersion (base class); NXspindispersion

.. _NXspindispersion:

================
NXspindispersion
================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Subclass of NXelectronanalyser to describe the spin filters in photoemission
  experiments.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdeflector`, :ref:`NXlens_em`, :ref:`NXtransformations`

.. index:: NXtransformations (base class); used in base class, NXdeflector (base class); used in base class, NXlens_em (base class); used in base class

**Structure**:

  .. _/NXspindispersion/type-field:

  .. index:: type (field)

  **type**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Type of spin detector, VLEED, SPLEED, Mott, etc.

  .. _/NXspindispersion/figure_of_merit-field:

  .. index:: figure_of_merit (field)

  **figure_of_merit**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_DIMENSIONLESS <NX_DIMENSIONLESS>`}

    Figure of merit of the spin detector

  .. _/NXspindispersion/shermann_function-field:

  .. index:: shermann_function (field)

  **shermann_function**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_DIMENSIONLESS <NX_DIMENSIONLESS>`}

    Effective Shermann function, calibrated spin selectivity factor

  .. _/NXspindispersion/scattering_energy-field:

  .. index:: scattering_energy (field)

  **scattering_energy**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ENERGY <NX_ENERGY>`}

    Energy of the spin-selective scattering

  .. _/NXspindispersion/scattering_angle-field:

  .. index:: scattering_angle (field)

  **scattering_angle**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

    Angle of the spin-selective scattering

  .. _/NXspindispersion/target-field:

  .. index:: target (field)

  **target**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Name of the target

  .. _/NXspindispersion/target_preparation-field:

  .. index:: target_preparation (field)

  **target_preparation**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Preparation procedure of the spin target

  .. _/NXspindispersion/target_preparation_date-field:

  .. index:: target_preparation_date (field)

  **target_preparation_date**: (optional) :ref:`NX_DATE_TIME <NX_DATE_TIME>`

    Date of last preparation of the spin target

  .. _/NXspindispersion/depends_on-field:

  .. index:: depends_on (field)

  **depends_on**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Specifies the position of the lens by pointing to the last transformation in the
    transformation chain in the NXtransformations group.

  .. _/NXspindispersion/TRANSFORMATIONS-group:

  **TRANSFORMATIONS**: (optional) :ref:`NXtransformations`

    Collection of axis-based translations and rotations to describe the location and
    geometry of the deflector as a component in the instrument. Conventions from the
    NXtransformations base class are used. In principle, the McStas coordinate
    system is used. The first transformation has to point either to another
    component of the system or . (for pointing to the reference frame) to relate it
    relative to the experimental setup. Typically, the components of a system should
    all be related relative to each other and only one component should relate to
    the reference coordinate system.

  .. _/NXspindispersion/DEFLECTOR-group:

  **DEFLECTOR**: (optional) :ref:`NXdeflector`

    Deflectors in the spin dispersive section

  .. _/NXspindispersion/LENS_EM-group:

  **LENS_EM**: (optional) :ref:`NXlens_em`

    Individual lenses in the spin dispersive section


Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXspindispersion/DEFLECTOR-group </NXspindispersion/DEFLECTOR-group>`
* :ref:`/NXspindispersion/depends_on-field </NXspindispersion/depends_on-field>`
* :ref:`/NXspindispersion/figure_of_merit-field </NXspindispersion/figure_of_merit-field>`
* :ref:`/NXspindispersion/LENS_EM-group </NXspindispersion/LENS_EM-group>`
* :ref:`/NXspindispersion/scattering_angle-field </NXspindispersion/scattering_angle-field>`
* :ref:`/NXspindispersion/scattering_energy-field </NXspindispersion/scattering_energy-field>`
* :ref:`/NXspindispersion/shermann_function-field </NXspindispersion/shermann_function-field>`
* :ref:`/NXspindispersion/target-field </NXspindispersion/target-field>`
* :ref:`/NXspindispersion/target_preparation-field </NXspindispersion/target_preparation-field>`
* :ref:`/NXspindispersion/target_preparation_date-field </NXspindispersion/target_preparation_date-field>`
* :ref:`/NXspindispersion/TRANSFORMATIONS-group </NXspindispersion/TRANSFORMATIONS-group>`
* :ref:`/NXspindispersion/type-field </NXspindispersion/type-field>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/base_classes/NXspindispersion.nxdl.xml