.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXelectronanalyser.nxdl.xml -- DO NOT EDIT .. index:: ! NXelectronanalyser (base class) ! electronanalyser (base class) see: electronanalyser (base class); NXelectronanalyser .. _NXelectronanalyser: ================== NXelectronanalyser ================== **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: Basic class for describing a electron analyzer. ... Basic class for describing a 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 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:`NXenergydispersion`, :ref:`NXfabrication`, :ref:`NXlens_em`, :ref:`NXresolution`, :ref:`NXspindispersion`, :ref:`NXtransformations` .. index:: NXresolution (base class); used in base class, NXdata (base class); used in base class, NXtransformations (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, NXlens_em (base class); used in base class, NXfabrication (base class); used in base class **Structure**: .. _/NXelectronanalyser@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`NX_CHAR ` .. collapse:: Declares which child group contains a path leading ... .. index:: plotting Declares which child group contains a path leading to a :ref:`NXdata` group. It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion. .. _/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/work_function-field: .. index:: work_function (field) **work_function**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} .. collapse:: Work function of the electron analyser. ... Work function of the electron analyser. 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 (with 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:`\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 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.}} = h\nu - E_B + \Delta \phi = h\nu - E_B - e \phi_{\mathrm{spectr.}}`. As a result, 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_s` needs to be known to accurately determine the binding energy scale. .. _/NXelectronanalyser/voltage_energy_range-field: .. index:: voltage_energy_range (field) **voltage_energy_range**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_VOLTAGE `} .. collapse:: Energy range of the voltage supplies. This influences the noise of the supplie ... Energy range of the voltage supplies. This influences the noise of the supplies, and thereby the energy resolution. .. _/NXelectronanalyser/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 analyser. Other variables such as temperature, manipulator angles etc. are labeled as fast or slow in the data. .. 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. .. _/NXelectronanalyser/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. .. _/NXelectronanalyser/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` .. collapse:: Refers to the last transformation specifying the position of the electron anal ... Refers to the last transformation specifying the position of the electron analyser in the NXtransformations chain. .. _/NXelectronanalyser/energy_resolution-group: **energy_resolution**: (optional) :ref:`NXresolution` .. collapse:: Energy resolution of the analyser with the current setting. May be linked from ... Energy resolution of the analyser with the current setting. May be linked from an NXcalibration. .. _/NXelectronanalyser/energy_resolution/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``energy`` .. _/NXelectronanalyser/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 .. _/NXelectronanalyser/energy_resolution/resolution_errors-field: .. index:: resolution_errors (field) **resolution_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} :ref:`⤆ ` .. _/NXelectronanalyser/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 analyser at a specified energ ... Ratio of the energy resolution of the electron analyser 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 .. _/NXelectronanalyser/momentum_resolution-group: **momentum_resolution**: (optional) :ref:`NXresolution` Momentum resolution of the electron analyser (FWHM) .. _/NXelectronanalyser/momentum_resolution/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``momentum`` .. _/NXelectronanalyser/momentum_resolution/resolution-field: .. index:: resolution (field) **resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVENUMBER `} :ref:`⤆ ` .. _/NXelectronanalyser/momentum_resolution/resolution_errors-field: .. index:: resolution_errors (field) **resolution_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVENUMBER `} :ref:`⤆ ` .. _/NXelectronanalyser/angular_resolution-group: **angular_resolution**: (optional) :ref:`NXresolution` Angular resolution of the electron analyser (FWHM) .. _/NXelectronanalyser/angular_resolution/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``angle`` .. _/NXelectronanalyser/angular_resolution/resolution-field: .. index:: resolution (field) **resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXelectronanalyser/angular_resolution/resolution_errors-field: .. index:: resolution_errors (field) **resolution_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXelectronanalyser/spatial_resolution-group: **spatial_resolution**: (optional) :ref:`NXresolution` .. collapse:: Spatial resolution of the electron analyser (Airy disk radius) ... Spatial resolution of the electron analyser (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 .. _/NXelectronanalyser/spatial_resolution/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``length`` .. _/NXelectronanalyser/spatial_resolution/resolution-field: .. index:: resolution (field) **resolution**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXelectronanalyser/spatial_resolution/resolution_errors-field: .. index:: resolution_errors (field) **resolution_errors**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXelectronanalyser/transmission_function-group: **transmission_function**: (optional) :ref:`NXdata` .. collapse:: Transmission function of the electron analyser. ... Transmission function of the electron analyser. The transmission function (TF) specifies the detection efficiency per solid angle for electrons of different kinetic energy passing through the electron analyser. 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 atomic concentrations. 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 .. _/NXelectronanalyser/transmission_function@signal-attribute: .. index:: signal (group attribute) **@signal**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``relative_intensity`` .. _/NXelectronanalyser/transmission_function@axes-attribute: .. index:: axes (group attribute) **@axes**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``kinetic_energy`` .. _/NXelectronanalyser/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 .. _/NXelectronanalyser/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 .. _/NXelectronanalyser/TRANSFORMATIONS-group: **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` .. collapse:: Collection of axis-based translations and rotations to describe the location a ... Collection of axis-based translations and rotations to describe the location and geometry of the electron analyser as a component in the instrument. Conventions from the NXtransformations base class are used. In principle, the McStas coordinate system is used. The first transformation has to point either to another component of the system or "." (for pointing to the reference frame) to relate it relative to the experimental setup. Typically, the components of a system should all be related relative to each other and only one component should relate to the reference coordinate system. .. _/NXelectronanalyser/COLLECTIONCOLUMN-group: **COLLECTIONCOLUMN**: (optional) :ref:`NXcollectioncolumn` Describes the electron collection (spatial and momentum imaging) column .. _/NXelectronanalyser/ENERGYDISPERSION-group: **ENERGYDISPERSION**: (optional) :ref:`NXenergydispersion` Describes the energy dispersion section .. _/NXelectronanalyser/SPINDISPERSION-group: **SPINDISPERSION**: (optional) :ref:`NXspindispersion` Describes the spin dispersion section .. _/NXelectronanalyser/DETECTOR-group: **DETECTOR**: (optional) :ref:`NXdetector` Describes the electron detector .. _/NXelectronanalyser/DEFLECTOR-group: **DEFLECTOR**: (optional) :ref:`NXdeflector` Deflectors outside the main optics ensembles described by the subclasses .. _/NXelectronanalyser/LENS_EM-group: **LENS_EM**: (optional) :ref:`NXlens_em` Individual lenses outside the main optics ensembles described by the subclasses .. _/NXelectronanalyser/FABRICATION-group: **FABRICATION**: (optional) :ref:`NXfabrication` .. _/NXelectronanalyser/RESOLUTION-group: **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:`/NXelectronanalyser/angular_resolution-group ` * :ref:`/NXelectronanalyser/angular_resolution/physical_quantity-field ` * :ref:`/NXelectronanalyser/angular_resolution/resolution-field ` * :ref:`/NXelectronanalyser/angular_resolution/resolution_errors-field ` * :ref:`/NXelectronanalyser/COLLECTIONCOLUMN-group ` * :ref:`/NXelectronanalyser/DEFLECTOR-group ` * :ref:`/NXelectronanalyser/depends_on-field ` * :ref:`/NXelectronanalyser/description-field ` * :ref:`/NXelectronanalyser/DETECTOR-group ` * :ref:`/NXelectronanalyser/energy_resolution-group ` * :ref:`/NXelectronanalyser/energy_resolution/physical_quantity-field ` * :ref:`/NXelectronanalyser/energy_resolution/relative_resolution-field ` * :ref:`/NXelectronanalyser/energy_resolution/resolution-field ` * :ref:`/NXelectronanalyser/energy_resolution/resolution_errors-field ` * :ref:`/NXelectronanalyser/ENERGYDISPERSION-group ` * :ref:`/NXelectronanalyser/FABRICATION-group ` * :ref:`/NXelectronanalyser/fast_axes-field ` * :ref:`/NXelectronanalyser/LENS_EM-group ` * :ref:`/NXelectronanalyser/momentum_resolution-group ` * :ref:`/NXelectronanalyser/momentum_resolution/physical_quantity-field ` * :ref:`/NXelectronanalyser/momentum_resolution/resolution-field ` * :ref:`/NXelectronanalyser/momentum_resolution/resolution_errors-field ` * :ref:`/NXelectronanalyser/name-field ` * :ref:`/NXelectronanalyser/name@short_name-attribute ` * :ref:`/NXelectronanalyser/RESOLUTION-group ` * :ref:`/NXelectronanalyser/slow_axes-field ` * :ref:`/NXelectronanalyser/spatial_resolution-group ` * :ref:`/NXelectronanalyser/spatial_resolution/physical_quantity-field ` * :ref:`/NXelectronanalyser/spatial_resolution/resolution-field ` * :ref:`/NXelectronanalyser/spatial_resolution/resolution_errors-field ` * :ref:`/NXelectronanalyser/SPINDISPERSION-group ` * :ref:`/NXelectronanalyser/TRANSFORMATIONS-group ` * :ref:`/NXelectronanalyser/transmission_function-group ` * :ref:`/NXelectronanalyser/transmission_function/kinetic_energy-field ` * :ref:`/NXelectronanalyser/transmission_function/relative_intensity-field ` * :ref:`/NXelectronanalyser/transmission_function@axes-attribute ` * :ref:`/NXelectronanalyser/transmission_function@signal-attribute ` * :ref:`/NXelectronanalyser/voltage_energy_range-field ` * :ref:`/NXelectronanalyser/work_function-field ` * :ref:`/NXelectronanalyser@default-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXelectronanalyser.nxdl.xml