.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXelectronanalyser.nxdl.xml .. index:: ! NXelectronanalyser (base class) ! electronanalyser (base class) see: electronanalyser (base class); NXelectronanalyser .. _NXelectronanalyser: ================== NXelectronanalyser ================== **Status**: base class, extends :ref:`NXobject` **Description**: Draft subclass of NXinstrument to describe a photoelectron analyser. **Symbols**: The symbols used in the schema to specify e.g. dimensions of arrays **nfa** **nsa** **Groups cited**: :ref:`NXcollectioncolumn`, :ref:`NXdeflector`, :ref:`NXdetector`, :ref:`NXenergydispersion`, :ref:`NXlens`, :ref:`NXspindispersion` .. index:: NXcollectioncolumn (base class); used in base class, NXenergydispersion (base class); used in base class, NXspindispersion (base class); used in base class, NXdetector (base class); used in base class, NXdeflector (base class); used in base class, NXlens (base class); used in base class **Structure**: .. _/NXelectronanalyser/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` Free text description of the type of the detector .. _/NXelectronanalyser/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` Name or model of the equipment .. _/NXelectronanalyser/name@short_name-attribute: .. index:: short_name (field attribute) **@short_name**: (optional) :ref:`NX_CHAR ` Acronym or other shorthand name .. _/NXelectronanalyser/energy_resolution-field: .. index:: energy_resolution (field) **energy_resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} Overall energy resolution (FWHM of gaussian broadening) .. _/NXelectronanalyser/momentum_resolution-field: .. index:: momentum_resolution (field) **momentum_resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVENUMBER `} Overall momentum resolution (FWHM) .. _/NXelectronanalyser/angular_resolution-field: .. index:: angular_resolution (field) **angular_resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Overall angular resolution (FWHM) .. _/NXelectronanalyser/spatial_resolution-field: .. index:: spatial_resolution (field) **spatial_resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Overall spatial resolution (Airy disk radius) .. _/NXelectronanalyser/fast_axes-field: .. index:: fast_axes (field) **fast_axes[nfa]**: (optional) :ref:`NX_CHAR ` List of the axes that are acquired symultaneously by the detector. These refer only to the experimental variables recorded by the electron analyser. Other variables such as temperature, manipulator angles etc. are labeled as fast or slow in the data. Examples. Hemispherical in ARPES mode: fast_axes: [energy,kx] Hemispherical with channeltron, sweeping energy mode: slow_axes: [energy] Tof: fast_axes: [energy, kx, ky] Momentum microscope, spin-resolved: fast_axes: [energy, kx, ky] slow_axes: [spin up-down, spin left-right] axes can be less abstract than this, i.e. [detector_x, detector_y]. If energy_scan_mode=sweep, fast_axes: [energy, kx]; slow_axes: [energy] is allowed. .. _/NXelectronanalyser/slow_axes-field: .. index:: slow_axes (field) **slow_axes[nsa]**: (optional) :ref:`NX_CHAR ` List of the axes that are acquired by scanning a physical parameter, listed in order of decreasing speed. See fast_axes for examples. .. _/NXelectronanalyser/COLLECTIONCOLUMN-group: **COLLECTIONCOLUMN**: (optional) :ref:`NXcollectioncolumn` class to describe the electron collection (spatial and momentum imaging) column .. _/NXelectronanalyser/ENERGYDISPERSION-group: **ENERGYDISPERSION**: (optional) :ref:`NXenergydispersion` class to describe the energy dispersion section .. _/NXelectronanalyser/SPINDISPERSION-group: **SPINDISPERSION**: (optional) :ref:`NXspindispersion` class to describe the spin dispersion section .. _/NXelectronanalyser/DETECTOR-group: **DETECTOR**: (optional) :ref:`NXdetector` class to describe the electron detector .. _/NXelectronanalyser/DEFLECTOR-group: **DEFLECTOR**: (optional) :ref:`NXdeflector` deflectors in the collection column section .. _/NXelectronanalyser/LENS-group: **LENS**: (optional) :ref:`NXlens` Individual lenses in the collection column 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:`/NXelectronanalyser/angular_resolution-field ` :ref:`#nxelectronanalyser-angular-resolution-field ` :ref:`/NXelectronanalyser/COLLECTIONCOLUMN-group ` :ref:`#nxelectronanalyser-collectioncolumn-group ` :ref:`/NXelectronanalyser/DEFLECTOR-group ` :ref:`#nxelectronanalyser-deflector-group ` :ref:`/NXelectronanalyser/description-field ` :ref:`#nxelectronanalyser-description-field ` :ref:`/NXelectronanalyser/DETECTOR-group ` :ref:`#nxelectronanalyser-detector-group ` :ref:`/NXelectronanalyser/energy_resolution-field ` :ref:`#nxelectronanalyser-energy-resolution-field ` :ref:`/NXelectronanalyser/ENERGYDISPERSION-group ` :ref:`#nxelectronanalyser-energydispersion-group ` :ref:`/NXelectronanalyser/fast_axes-field ` :ref:`#nxelectronanalyser-fast-axes-field ` :ref:`/NXelectronanalyser/LENS-group ` :ref:`#nxelectronanalyser-lens-group ` :ref:`/NXelectronanalyser/momentum_resolution-field ` :ref:`#nxelectronanalyser-momentum-resolution-field ` :ref:`/NXelectronanalyser/name-field ` :ref:`#nxelectronanalyser-name-field ` :ref:`/NXelectronanalyser/name@short_name-attribute ` :ref:`#nxelectronanalyser-name-short-name-attribute ` :ref:`/NXelectronanalyser/slow_axes-field ` :ref:`#nxelectronanalyser-slow-axes-field ` :ref:`/NXelectronanalyser/spatial_resolution-field ` :ref:`#nxelectronanalyser-spatial-resolution-field ` :ref:`/NXelectronanalyser/SPINDISPERSION-group ` :ref:`#nxelectronanalyser-spindispersion-group ` ==================================================================================================== ==================================================================================================== **NXDL Source**: https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/base_classes/NXelectronanalyser.nxdl.xml