.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXspindispersion.nxdl.xml -- DO NOT EDIT

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

.. _NXspindispersion:

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

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  Class to describe spin filters in photoemission experiments.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXactivity`, :ref:`NXdeflector`, :ref:`NXelectromagnetic_lens`, :ref:`NXhistory`

.. index:: NXhistory (base class); used in base class, NXactivity (base class); used in base class, NXdeflector (base class); used in base class, NXelectromagnetic_lens (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/scattering_target-field:

  .. index:: scattering_target (field)

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

    Name of the target

  .. _/NXspindispersion/scattering_target_history-group:

  **scattering_target_history**: (optional) :ref:`NXhistory` 

    .. collapse:: A set of activities that occurred to the ``scattering_target`` prior to/during ...

        A set of activities that occurred to the ``scattering_target`` prior to/during the.
        experiment. For example, this group can be used to describe the preparation of the
        ``scattering_target``.

    .. _/NXspindispersion/scattering_target_history/preparation-group:

    **preparation**: (optional) :ref:`NXactivity` :ref:`⤆ </NXhistory/ACTIVITY-group>`

      Preparation procedure of the spin target

  .. _/NXspindispersion/DEFLECTOR-group:

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

    Deflectors in the spin dispersive section

  .. _/NXspindispersion/ELECTROMAGNETIC_LENS-group:

  :bolditalic:`ELECTROMAGNETIC_LENS`: (optional) :ref:`NXelectromagnetic_lens` 

    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/ELECTROMAGNETIC_LENS-group </NXspindispersion/ELECTROMAGNETIC_LENS-group>`
* :ref:`/NXspindispersion/figure_of_merit-field </NXspindispersion/figure_of_merit-field>`
* :ref:`/NXspindispersion/scattering_angle-field </NXspindispersion/scattering_angle-field>`
* :ref:`/NXspindispersion/scattering_energy-field </NXspindispersion/scattering_energy-field>`
* :ref:`/NXspindispersion/scattering_target-field </NXspindispersion/scattering_target-field>`
* :ref:`/NXspindispersion/scattering_target_history-group </NXspindispersion/scattering_target_history-group>`
* :ref:`/NXspindispersion/scattering_target_history/preparation-group </NXspindispersion/scattering_target_history/preparation-group>`
* :ref:`/NXspindispersion/shermann_function-field </NXspindispersion/shermann_function-field>`
* :ref:`/NXspindispersion/type-field </NXspindispersion/type-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXspindispersion.nxdl.xml