.. 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**:

  Draft subclass of NXelectronanalyser to describe the spin filters in photoemission experiments.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdeflector`, :ref:`NXlens`

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

**Structure**:

  .. _/NXspindispersion/spin_filter_type-field:

  .. index:: spin_filter_type (field)

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

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

  .. _/NXspindispersion/spin_filter_FoM-field:

  .. index:: spin_filter_FoM (field)

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

    Figure of merit of the spin detector

  .. _/NXspindispersion/spin_filter_shermann_function-field:

  .. index:: spin_filter_shermann_function (field)

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

    Effective Shermann function, calibrated spin selectivity factor

  .. _/NXspindispersion/spin_scattering_energy-field:

  .. index:: spin_scattering_energy (field)

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

    Energy of the spin-selective scattering

  .. _/NXspindispersion/spin_scattering_angle-field:

  .. index:: spin_scattering_angle (field)

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

    Angle of the spin-selective scattering

  .. _/NXspindispersion/spin_target-field:

  .. index:: spin_target (field)

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

    Name of the target

  .. _/NXspindispersion/spin_target_preparation-field:

  .. index:: spin_target_preparation (field)

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

    Preparation procedure of the spin target

  .. _/NXspindispersion/spin_target_preparation_date-field:

  .. index:: spin_target_preparation_date (field)

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

    Date of last preparation of the spin target

  .. _/NXspindispersion/DEFLECTOR-group:

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

    deflectors in the spin dispersive section

  .. _/NXspindispersion/LENS-group:

  **LENS**: (optional) :ref:`NXlens`

    Individual lenses in the spin dispersive section


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

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


==================================================================================================================== ====================================================================================================================
documentation (reST source) anchor                                                                                   web page (HTML) anchor                                                                                              
==================================================================================================================== ====================================================================================================================
:ref:`/NXspindispersion/DEFLECTOR-group </NXspindispersion/DEFLECTOR-group>`                                         :ref:`#nxspindispersion-deflector-group </NXspindispersion/DEFLECTOR-group>`                                        
:ref:`/NXspindispersion/LENS-group </NXspindispersion/LENS-group>`                                                   :ref:`#nxspindispersion-lens-group </NXspindispersion/LENS-group>`                                                  
:ref:`/NXspindispersion/spin_filter_FoM-field </NXspindispersion/spin_filter_FoM-field>`                             :ref:`#nxspindispersion-spin-filter-fom-field </NXspindispersion/spin_filter_FoM-field>`                            
:ref:`/NXspindispersion/spin_filter_shermann_function-field </NXspindispersion/spin_filter_shermann_function-field>` :ref:`#nxspindispersion-spin-filter-shermann-function-field </NXspindispersion/spin_filter_shermann_function-field>`
:ref:`/NXspindispersion/spin_filter_type-field </NXspindispersion/spin_filter_type-field>`                           :ref:`#nxspindispersion-spin-filter-type-field </NXspindispersion/spin_filter_type-field>`                          
:ref:`/NXspindispersion/spin_scattering_angle-field </NXspindispersion/spin_scattering_angle-field>`                 :ref:`#nxspindispersion-spin-scattering-angle-field </NXspindispersion/spin_scattering_angle-field>`                
:ref:`/NXspindispersion/spin_scattering_energy-field </NXspindispersion/spin_scattering_energy-field>`               :ref:`#nxspindispersion-spin-scattering-energy-field </NXspindispersion/spin_scattering_energy-field>`              
:ref:`/NXspindispersion/spin_target-field </NXspindispersion/spin_target-field>`                                     :ref:`#nxspindispersion-spin-target-field </NXspindispersion/spin_target-field>`                                    
:ref:`/NXspindispersion/spin_target_preparation-field </NXspindispersion/spin_target_preparation-field>`             :ref:`#nxspindispersion-spin-target-preparation-field </NXspindispersion/spin_target_preparation-field>`            
:ref:`/NXspindispersion/spin_target_preparation_date-field </NXspindispersion/spin_target_preparation_date-field>`   :ref:`#nxspindispersion-spin-target-preparation-date-field </NXspindispersion/spin_target_preparation_date-field>`  
==================================================================================================================== ====================================================================================================================


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