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

.. index::
    ! NXenergydispersion (base class)
    ! energydispersion (base class)
    see: energydispersion (base class); NXenergydispersion

.. _NXenergydispersion:

==================
NXenergydispersion
==================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Subclass of NXelectronanalyser to describe the energy dispersion section of a
  photoelectron analyser.

**Symbols**:

  No symbol table

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

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

**Structure**:

  .. _/NXenergydispersion/scheme-field:

  .. index:: scheme (field)

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

    Energy dispersion scheme employed, for example: tof, hemispherical, cylindrical,
    mirror, retarding grid, etc.

  .. _/NXenergydispersion/pass_energy-field:

  .. index:: pass_energy (field)

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

    Energy of the electrons on the mean path of the analyser. Pass energy for
    hemispherics, drift energy for tofs.

  .. _/NXenergydispersion/center_energy-field:

  .. index:: center_energy (field)

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

    Center of the energy window

  .. _/NXenergydispersion/energy_interval-field:

  .. index:: energy_interval (field)

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

    The interval of transmitted energies. It can be two different things depending
    on whether the scan is fixed or swept. With a fixed scan it is a 2 vector
    containing the extrema of the transmitted energy window (smaller number first).
    With a swept scan of m steps it is a 2xm array of windows one for each
    measurement point.

  .. _/NXenergydispersion/diameter-field:

  .. index:: diameter (field)

  **diameter**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

    Diameter of the dispersive orbit

  .. _/NXenergydispersion/energy_scan_mode-field:

  .. index:: energy_scan_mode (field)

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

    Way of scanning the energy axis (fixed or sweep).

    Any of these values: ``fixed`` | ``sweep``

  .. _/NXenergydispersion/tof_distance-field:

  .. index:: tof_distance (field)

  **tof_distance**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

    Length of the tof drift electrode

  .. _/NXenergydispersion/APERTURE-group:

  **APERTURE**: (optional) :ref:`NXaperture`

    Size, position and shape of a slit in dispersive analyzer, e.g. entrance and
    exit slits.

  .. _/NXenergydispersion/DEFLECTOR-group:

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

    Deflectors in the energy dispersive section

  .. _/NXenergydispersion/LENS_EM-group:

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

    Individual lenses in the energy dispersive section


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

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


* :ref:`/NXenergydispersion/APERTURE-group </NXenergydispersion/APERTURE-group>`
* :ref:`/NXenergydispersion/center_energy-field </NXenergydispersion/center_energy-field>`
* :ref:`/NXenergydispersion/DEFLECTOR-group </NXenergydispersion/DEFLECTOR-group>`
* :ref:`/NXenergydispersion/diameter-field </NXenergydispersion/diameter-field>`
* :ref:`/NXenergydispersion/energy_interval-field </NXenergydispersion/energy_interval-field>`
* :ref:`/NXenergydispersion/energy_scan_mode-field </NXenergydispersion/energy_scan_mode-field>`
* :ref:`/NXenergydispersion/LENS_EM-group </NXenergydispersion/LENS_EM-group>`
* :ref:`/NXenergydispersion/pass_energy-field </NXenergydispersion/pass_energy-field>`
* :ref:`/NXenergydispersion/scheme-field </NXenergydispersion/scheme-field>`
* :ref:`/NXenergydispersion/tof_distance-field </NXenergydispersion/tof_distance-field>`

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