.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXelectronanalyzer.nxdl.xml -- DO NOT EDIT .. index:: ! NXelectronanalyzer (base class) ! electronanalyzer (base class) see: electronanalyzer (base class); NXelectronanalyzer .. _NXelectronanalyzer: ================== NXelectronanalyzer ================== **Status**: base class, extends :ref:`NXcomponent` **Description**: .. collapse:: Basic class for describing an electron analyzer. ... Basic class for describing an electron analyzer. This concept is related to term `12.59`_ of the ISO 18115-1:2023 standard. .. _12.59: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:12.59 **Symbols**: The symbols used in the schema to specify e.g. dimensions of arrays **nfa**: Number of fast axes (axes acquired simultaneously, without scanning a physical quantity) **nsa**: Number of slow axes (axes acquired while scanning a physical quantity) **n_transmission_function**: Number of data points in the transmission function. **Groups cited**: :ref:`NXcollectioncolumn`, :ref:`NXdata`, :ref:`NXdeflector`, :ref:`NXdetector`, :ref:`NXelectromagnetic_lens`, :ref:`NXenergydispersion`, :ref:`NXfabrication`, :ref:`NXresolution`, :ref:`NXspindispersion` .. index:: NXresolution (base class); used in base class, NXdata (base class); used in base class, 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, NXelectromagnetic_lens (base class); used in base class, NXfabrication (base class); used in base class **Structure**: .. _/NXelectronanalyzer/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Free text description of the type of the detector .. _/NXelectronanalyzer/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Name or model of the equipment .. _/NXelectronanalyzer/name@short_name-attribute: .. index:: short_name (field attribute) **@short_name**: (optional) :ref:`NX_CHAR ` Acronym or other shorthand name .. _/NXelectronanalyzer/work_function-field: .. index:: work_function (field) **work_function**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} .. collapse:: Work function of the electron analyzer. ... Work function of the electron analyzer. The work function of a uniform surface of a conductor is the minimum energy required to remove an electron from the interior of the solid to a vacuum level immediately outside the solid surface. The kinetic energy :math:E_K of a photoelectron emitted from an energy level with binding energy :math:`E_B` below the Fermi level is given by :math:`E_K = h\nu - E_B - W = h\nu - E_B - e \phi_{\mathrm{sample}}`. Here, :math:`W = e \phi_{\mathrm{sample}}` is the work function of the sample surface, which is directly proportional to the potential difference :math:`\phi_{\mathrm{sample}}` between the electrochemical potential of electrons in the bulk and the electrostatic potential of an electron in the vacuum just outside the surface. In PES measurements, the sample and the spectrometer (with work function :math:`W_{\mathrm{spectr.}} = e \phi_{\mathrm{spectr.}}`) are electrically connected and therefore their Fermi levels are aligned. Due to the difference in local vacuum level between the sample and spectrometer, there however exists an electric potential difference (contact potential) :math:`\Delta\phi = \phi_{\mathrm{sample}} - \phi_{\mathrm{spectr.}}`. The measured kinetic energy of a photoelectron in PES is therefore given by :math:`E_K^{\mathrm{meas.}} = E_K + e\Delta\phi = h\nu - E_B - e\phi_{\mathrm{spectr.}}`. Hence, the measured kinetic energy :math:`E_K^{\mathrm{meas.}}` of a photoelectron is independent of the sample work function. Nonetheless, the work function :math:`\phi_{\mathrm{spectr.}}` needs to be known to accurately determine the binding energy scale. .. _/NXelectronanalyzer/voltage_range-field: .. index:: voltage_range (field) **voltage_range**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_VOLTAGE `} .. collapse:: Voltage range of the power supply. This influences the noise of the supply ... Voltage range of the power supply. This influences the noise of the supply and thereby the energy resolution. .. _/NXelectronanalyzer/fast_axes-field: .. index:: fast_axes (field) **fast_axes**: (optional) :ref:`NX_CHAR ` (Rank: 1, Dimensions: [nfa]) .. collapse:: List of the axes that are acquired simultaneously by the detector. ... List of the axes that are acquired simultaneously by the detector. These refer only to the experimental variables recorded by the electron analyzer. Other variables such as temperature, manipulator angles etc. can be labeled as fast or slow in the data. The fast axes should be listed in order of decreasing speed if they describe the same physical quantity or different components of the same quantity (e.g., ['kx', 'ky'] or ['detector_x', 'detector_y']). However, axes representing different physical quantities (e.g., ['energy', 'kx']) do not need to be ordered by speed. .. csv-table:: Examples :header: "Mode", "fast_axes", "slow_axes" "Hemispherical in ARPES mode", "['energy', 'kx']","" "Hemispherical with channeltron, sweeping energy mode", "", [\"energy\"] "Tof", "['energy', 'kx', 'ky']","" "Momentum microscope, spin-resolved", "['energy', 'kx', 'ky']", "['spin up-down', 'spin left-right']" Axes may 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. .. _/NXelectronanalyzer/slow_axes-field: .. index:: slow_axes (field) **slow_axes**: (optional) :ref:`NX_CHAR ` (Rank: 1, Dimensions: [nsa]) .. collapse:: List of the axes that are acquired by scanning a physical parameter, listed in ... List of the axes that are acquired by scanning a physical parameter, listed in order of decreasing speed. See fast_axes for examples. .. _/NXelectronanalyzer/energy_resolution-group: **energy_resolution**: (optional) :ref:`NXresolution` .. collapse:: Energy resolution of the analyzer with the current setting. May be linked from ... Energy resolution of the analyzer with the current setting. May be linked from an NXcalibration. .. _/NXelectronanalyzer/energy_resolution/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``energy`` .. _/NXelectronanalyzer/energy_resolution/resolution-field: .. index:: resolution (field) **resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} :ref:`⤆ ` .. collapse:: Minimum distinguishable energy separation in the energy spectra. ... Minimum distinguishable energy separation in the energy spectra. This concept is related to term `10.24`_ of the ISO 18115-1:2023 standard. .. _10.24: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:10.24 .. _/NXelectronanalyzer/energy_resolution/resolution_errors-field: .. index:: resolution_errors (field) **resolution_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} :ref:`⤆ ` .. _/NXelectronanalyzer/energy_resolution/relative_resolution-field: .. index:: relative_resolution (field) **relative_resolution**: (optional) :ref:`NX_FLOAT ` :ref:`⤆ ` .. collapse:: Ratio of the energy resolution of the electron analyzer at a specified energ ... Ratio of the energy resolution of the electron analyzer at a specified energy value to that energy value. This concept is related to term `10.7`_ of the ISO 18115-1:2023 standard. .. _10.7: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:10.7 .. _/NXelectronanalyzer/momentum_resolution-group: **momentum_resolution**: (optional) :ref:`NXresolution` Momentum resolution of the electron analyzer (FWHM) .. _/NXelectronanalyzer/momentum_resolution/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``momentum`` .. _/NXelectronanalyzer/momentum_resolution/resolution-field: .. index:: resolution (field) **resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVENUMBER `} :ref:`⤆ ` .. _/NXelectronanalyzer/momentum_resolution/resolution_errors-field: .. index:: resolution_errors (field) **resolution_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVENUMBER `} :ref:`⤆ ` .. _/NXelectronanalyzer/angular_resolution-group: **angular_resolution**: (optional) :ref:`NXresolution` Angular resolution of the electron analyzer (FWHM) .. _/NXelectronanalyzer/angular_resolution/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``angle`` .. _/NXelectronanalyzer/angular_resolution/resolution-field: .. index:: resolution (field) **resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXelectronanalyzer/angular_resolution/resolution_errors-field: .. index:: resolution_errors (field) **resolution_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXelectronanalyzer/spatial_resolution-group: **spatial_resolution**: (optional) :ref:`NXresolution` .. collapse:: Spatial resolution of the electron analyzer (Airy disk radius) ... Spatial resolution of the electron analyzer (Airy disk radius) This concept is related to term `10.14`_ of the ISO 18115-1:2023 standard. .. _10.14: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:10.15 .. _/NXelectronanalyzer/spatial_resolution/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``length`` .. _/NXelectronanalyzer/spatial_resolution/resolution-field: .. index:: resolution (field) **resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXelectronanalyzer/spatial_resolution/resolution_errors-field: .. index:: resolution_errors (field) **resolution_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXelectronanalyzer/transmission_function-group: **transmission_function**: (optional) :ref:`NXdata` :ref:`⤆ ` .. collapse:: Transmission function of the electron analyzer. ... Transmission function of the electron analyzer. The transmission function (TF) specifies the detection efficiency per solid angle for electrons of different kinetic energy passing through the electron analyzer. It depends on the spectrometer geometry as well as operation settings such as lens mode and pass energy. The transmission function is usually given as relative intensity vs. kinetic energy. The TF is used for calibration of the intensity scale in quantitative XPS. Without proper transmission correction, a comparison of results measured from the same sample using different operating modes for an instrument would show significant variations in signal intensity for the same kinetic energies. This concept is related to term `7.15`_ of the ISO 18115-1:2023 standard. .. _7.15: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:7.15 .. _/NXelectronanalyzer/transmission_function@signal-attribute: .. index:: signal (group attribute) **@signal**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``relative_intensity`` .. _/NXelectronanalyzer/transmission_function@axes-attribute: .. index:: axes (group attribute) **@axes**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``['kinetic_energy']`` .. _/NXelectronanalyzer/transmission_function/kinetic_energy-field: .. index:: kinetic_energy (field) **kinetic_energy**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_transmission_function]) {units=\ :ref:`NX_ENERGY `} Kinetic energy values .. _/NXelectronanalyzer/transmission_function/relative_intensity-field: .. index:: relative_intensity (field) **relative_intensity**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n_transmission_function]) {units=\ :ref:`NX_UNITLESS `} Relative transmission efficiency for the given kinetic energies .. _/NXelectronanalyzer/COLLECTIONCOLUMN-group: :bolditalic:`COLLECTIONCOLUMN`: (optional) :ref:`NXcollectioncolumn` Describes the electron collection (spatial and momentum imaging) column .. _/NXelectronanalyzer/ENERGYDISPERSION-group: :bolditalic:`ENERGYDISPERSION`: (optional) :ref:`NXenergydispersion` Describes the energy dispersion section .. _/NXelectronanalyzer/SPINDISPERSION-group: :bolditalic:`SPINDISPERSION`: (optional) :ref:`NXspindispersion` Describes the spin dispersion section .. _/NXelectronanalyzer/DETECTOR-group: :bolditalic:`DETECTOR`: (optional) :ref:`NXdetector` Describes the electron detector .. _/NXelectronanalyzer/DEFLECTOR-group: :bolditalic:`DEFLECTOR`: (optional) :ref:`NXdeflector` Deflectors outside the main optics ensembles described by the subclasses .. _/NXelectronanalyzer/ELECTROMAGNETIC_LENS-group: :bolditalic:`ELECTROMAGNETIC_LENS`: (optional) :ref:`NXelectromagnetic_lens` Individual lenses outside the main optics ensembles described by the subclasses .. _/NXelectronanalyzer/FABRICATION-group: :bolditalic:`FABRICATION`: (optional) :ref:`NXfabrication` :ref:`⤆ ` .. _/NXelectronanalyzer/RESOLUTION-group: :bolditalic:`RESOLUTION`: (optional) :ref:`NXresolution` Any other resolution not explicitly named in this base class. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXelectronanalyzer/angular_resolution-group ` * :ref:`/NXelectronanalyzer/angular_resolution/physical_quantity-field ` * :ref:`/NXelectronanalyzer/angular_resolution/resolution-field ` * :ref:`/NXelectronanalyzer/angular_resolution/resolution_errors-field ` * :ref:`/NXelectronanalyzer/COLLECTIONCOLUMN-group ` * :ref:`/NXelectronanalyzer/DEFLECTOR-group ` * :ref:`/NXelectronanalyzer/description-field ` * :ref:`/NXelectronanalyzer/DETECTOR-group ` * :ref:`/NXelectronanalyzer/ELECTROMAGNETIC_LENS-group ` * :ref:`/NXelectronanalyzer/energy_resolution-group ` * :ref:`/NXelectronanalyzer/energy_resolution/physical_quantity-field ` * :ref:`/NXelectronanalyzer/energy_resolution/relative_resolution-field ` * :ref:`/NXelectronanalyzer/energy_resolution/resolution-field ` * :ref:`/NXelectronanalyzer/energy_resolution/resolution_errors-field ` * :ref:`/NXelectronanalyzer/ENERGYDISPERSION-group ` * :ref:`/NXelectronanalyzer/FABRICATION-group ` * :ref:`/NXelectronanalyzer/fast_axes-field ` * :ref:`/NXelectronanalyzer/momentum_resolution-group ` * :ref:`/NXelectronanalyzer/momentum_resolution/physical_quantity-field ` * :ref:`/NXelectronanalyzer/momentum_resolution/resolution-field ` * :ref:`/NXelectronanalyzer/momentum_resolution/resolution_errors-field ` * :ref:`/NXelectronanalyzer/name-field ` * :ref:`/NXelectronanalyzer/name@short_name-attribute ` * :ref:`/NXelectronanalyzer/RESOLUTION-group ` * :ref:`/NXelectronanalyzer/slow_axes-field ` * :ref:`/NXelectronanalyzer/spatial_resolution-group ` * :ref:`/NXelectronanalyzer/spatial_resolution/physical_quantity-field ` * :ref:`/NXelectronanalyzer/spatial_resolution/resolution-field ` * :ref:`/NXelectronanalyzer/spatial_resolution/resolution_errors-field ` * :ref:`/NXelectronanalyzer/SPINDISPERSION-group ` * :ref:`/NXelectronanalyzer/transmission_function-group ` * :ref:`/NXelectronanalyzer/transmission_function/kinetic_energy-field ` * :ref:`/NXelectronanalyzer/transmission_function/relative_intensity-field ` * :ref:`/NXelectronanalyzer/transmission_function@axes-attribute ` * :ref:`/NXelectronanalyzer/transmission_function@signal-attribute ` * :ref:`/NXelectronanalyzer/voltage_range-field ` * :ref:`/NXelectronanalyzer/work_function-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXelectronanalyzer.nxdl.xml