.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXprocess_mpes.nxdl.xml -- DO NOT EDIT .. index:: ! NXprocess_mpes (base class) ! process_mpes (base class) see: process_mpes (base class); NXprocess_mpes .. _NXprocess_mpes: ============== NXprocess_mpes ============== **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: :ref:`NXprocess_mpes` describes events of data processing, reconstruction, ... :ref:`NXprocess_mpes` describes events of data processing, reconstruction, or analysis for photoemission-related data. It extends the NXprocess class and provides a glossary of explicitly named processes and their metadata which are typical for photoemission data. For now, the extension of NXprocess is performed by simply copying all existing groups, fields, and attibute from NXprocess. In the future, it is envisioned that this extension can be solved by base class inheritance. **Symbols**: No symbol table **Groups cited**: :ref:`NXcalibration`, :ref:`NXdata`, :ref:`NXdistortion`, :ref:`NXelectron_level`, :ref:`NXnote`, :ref:`NXregistration` .. index:: NXcalibration (base class); used in base class, NXelectron_level (base class); used in base class, NXdata (base class); used in base class, NXregistration (base class); used in base class, NXdistortion (base class); used in base class, NXnote (base class); used in base class **Structure**: .. _/NXprocess_mpes@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 .. _/NXprocess_mpes/program-field: .. index:: program (field) **program**: (optional) :ref:`NX_CHAR ` Name of the program used .. _/NXprocess_mpes/sequence_index-field: .. index:: sequence_index (field) **sequence_index**: (optional) :ref:`NX_POSINT ` .. collapse:: Sequence index of processing, ... Sequence index of processing, for determining the order of multiple **NXprocess** steps. Starts with 1. .. _/NXprocess_mpes/version-field: .. index:: version (field) **version**: (optional) :ref:`NX_CHAR ` Version of the program used .. _/NXprocess_mpes/date-field: .. index:: date (field) **date**: (optional) :ref:`NX_DATE_TIME ` Date and time of processing. .. _/NXprocess_mpes/energy_calibration-group: **energy_calibration**: (optional) :ref:`NXcalibration` .. collapse:: Calibration event on the energy axis. ... Calibration event on the energy axis. For XPS, the calibration should ideally be performed according to `ISO 15472:2010`_ specification. .. _ISO 15472:2010: https://www.iso.org/standard/74811.html .. _/NXprocess_mpes/energy_calibration/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``energy`` .. _/NXprocess_mpes/energy_calibration/calibrated_axis-field: .. index:: calibrated_axis (field) **calibrated_axis**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} :ref:`⤆ ` This is the calibrated energy axis to be used for data plotting. .. _/NXprocess_mpes/kN_calibration-group: **kN_calibration**: (optional) :ref:`NXcalibration` .. collapse:: Calibration event on a k-space axis. ... Calibration event on a k-space axis. It is envisioned that the individual calibrations for each coordinate are stored as kx_calibration, ky_calibration, kz_calibration, in accordance with the axis name definitions in NXdata_mpes. It is also possible to have k_parallel_calibration and k_perp_calibration if the momentum axes are defined as k_parallel and k_perp for the parallel and perpendicular momenta, respectively. .. _/NXprocess_mpes/kN_calibration/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``momentum`` .. _/NXprocess_mpes/kN_calibration/calibrated_axis-field: .. index:: calibrated_axis (field) **calibrated_axis**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVENUMBER `} :ref:`⤆ ` This is the calibrated k-space axis to be used for data plotting. .. _/NXprocess_mpes/angularN_calibration-group: **angularN_calibration**: (optional) :ref:`NXcalibration` .. collapse:: Calibration event of an angular axis. ... Calibration event of an angular axis. It is envisioned that the individual calibrations for each angle are stored as angular0_calibration, angular1_calibration, etc., in accordance with the axis name definitions in NXdata_mpes. .. _/NXprocess_mpes/angularN_calibration/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``angle`` .. _/NXprocess_mpes/angularN_calibration/calibrated_axis-field: .. index:: calibrated_axis (field) **calibrated_axis**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` This is the calibrated angular axis to be used for data plotting. .. _/NXprocess_mpes/spatialN_calibration-group: **spatialN_calibration**: (optional) :ref:`NXcalibration` .. collapse:: Calibration event of a spatial axis. ... Calibration event of a spatial axis. It is envisioned that the individual calibrations for each angle are stored as spatial0_calibration, spatial1_calibration, etc., in accordance with the axis name definitions in NXdata_mpes. .. _/NXprocess_mpes/spatialN_calibration/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``space`` .. _/NXprocess_mpes/spatialN_calibration/calibrated_axis-field: .. index:: calibrated_axis (field) **calibrated_axis**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` This is the calibrated spatial axis to be used for data plotting. .. _/NXprocess_mpes/delay_calibration-group: **delay_calibration**: (optional) :ref:`NXcalibration` Calibration event of the delay time. .. _/NXprocess_mpes/delay_calibration/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``time`` .. _/NXprocess_mpes/delay_calibration/calibrated_axis-field: .. index:: calibrated_axis (field) **calibrated_axis**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} :ref:`⤆ ` This is the calibrated delay time axis to be used for data plotting. .. _/NXprocess_mpes/polarization_angle_calibration-group: **polarization_angle_calibration**: (optional) :ref:`NXcalibration` Calibration event of the beam polarization angle. .. _/NXprocess_mpes/polarization_angle_calibration/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``beam polarization angle`` .. _/NXprocess_mpes/polarization_angle_calibration/calibrated_axis-field: .. index:: calibrated_axis (field) **calibrated_axis**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` This is the calibrated polarization angle axis to be used for data plotting. .. _/NXprocess_mpes/ellipticity_calibration-group: **ellipticity_calibration**: (optional) :ref:`NXcalibration` Calibration event of the ellipticity of the incoming or outgoing beam. .. _/NXprocess_mpes/ellipticity_calibration/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``beam ellipticity`` .. _/NXprocess_mpes/ellipticity_calibration/calibrated_axis-field: .. index:: calibrated_axis (field) **calibrated_axis**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` This is the calibrated ellipticity axis to be used for data plotting. .. _/NXprocess_mpes/energy_referencing-group: **energy_referencing**: (optional) :ref:`NXcalibration` .. collapse:: For energy referencing, the measured energies are corrected for the charging p ... For energy referencing, the measured energies are corrected for the charging potential (i.e., the electrical potential of the surface region of an insulating sample, caused by irradiation) such that those energies correspond to a sample with no surface charge. Usually, the energy axis is adjusted by shifting all energies uniformally until one well-defined emission line peak (or the Fermi edge) is located at a known _correct_ energy. This concept is related to term `12.74 ff.`_ of the ISO 18115-1:2023 standard. .. _12.74 ff.: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:12.74 .. _/NXprocess_mpes/energy_referencing/physical_quantity-field: .. index:: physical_quantity (field) **physical_quantity**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``energy`` .. _/NXprocess_mpes/energy_referencing/reference_peak-field: .. index:: reference_peak (field) **reference_peak**: (optional) :ref:`NX_CHAR ` .. collapse:: Reference peak that was used for the calibration. ... Reference peak that was used for the calibration. For example: adventitious carbon | C-C | metallic Au | elemental Si | Fermi edge | vacuum level .. _/NXprocess_mpes/energy_referencing/binding_energy-field: .. index:: binding_energy (field) **binding_energy**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} .. collapse:: The binding energy (in units of eV) that the specified emission line appeare ... The binding energy (in units of eV) that the specified emission line appeared at, after adjusting the binding energy scale. This concept is related to term `12.16`_ of the ISO 18115-1:2023 standard. .. _12.16: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:12.16 .. _/NXprocess_mpes/energy_referencing/offset-field: .. index:: offset (field) **offset**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} :ref:`⤆ ` .. collapse:: Offset between measured binding energy and calibrated binding energy of the ... Offset between measured binding energy and calibrated binding energy of the emission line. .. _/NXprocess_mpes/energy_referencing/calibrated_axis-field: .. index:: calibrated_axis (field) **calibrated_axis**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ENERGY `} :ref:`⤆ ` .. collapse:: This is the calibrated energy axis to be used for data plotting. ... This is the calibrated energy axis to be used for data plotting. This should link to /entry/data/energy. .. _/NXprocess_mpes/energy_referencing/level-group: **level**: (optional) :ref:`NXelectron_level` Electronic core or valence level that was used for the calibration. .. _/NXprocess_mpes/transmission_correction-group: **transmission_correction**: (optional) :ref:`NXcalibration` .. collapse:: In the transmission correction, each intensity measurement for electrons of a ... In the transmission correction, each intensity measurement for electrons of a given kinetic energy is multiplied by the corresponding value in the relative_intensity field of the transmission_function. This calibration procedure is used to account for the different tranmsission efficiencies when using different lens modes. .. _/NXprocess_mpes/transmission_correction/transmission_function-group: **transmission_function**: (optional) :ref:`NXdata` :ref:`⤆ ` .. collapse:: Transmission function of the electron analyser. ... Transmission function of the electron analyser. The transmission function (TF) specifies the detection efficiency for electrons of different kinetic energy passing through the electron analyser. This can be a link to /entry/instrument/electronanalyser/transmission_function. .. _/NXprocess_mpes/transmission_correction/transmission_function@signal-attribute: .. index:: signal (group attribute) **@signal**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``relative_intensity`` .. _/NXprocess_mpes/transmission_correction/transmission_function@axes-attribute: .. index:: axes (group attribute) **@axes**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``kinetic_energy`` .. _/NXprocess_mpes/transmission_correction/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 .. _/NXprocess_mpes/transmission_correction/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 .. _/NXprocess_mpes/REGISTRATION-group: **REGISTRATION**: (optional) :ref:`NXregistration` Describes the operations of image registration .. _/NXprocess_mpes/DISTORTION-group: **DISTORTION**: (optional) :ref:`NXdistortion` Describes the operations of image distortion correction .. _/NXprocess_mpes/CALIBRATION-group: **CALIBRATION**: (optional) :ref:`NXcalibration` Describes the operations of calibration procedures, e.g. axis calibrations. .. _/NXprocess_mpes/NOTE-group: **NOTE**: (optional) :ref:`NXnote` .. collapse:: The note will contain information about how the data was processed ... The note will contain information about how the data was processed or anything about the data provenance. The contents of the note can be anything that the processing code can understand, or simple text. The name will be numbered to allow for ordering of steps. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXprocess_mpes/angularN_calibration-group ` * :ref:`/NXprocess_mpes/angularN_calibration/calibrated_axis-field ` * :ref:`/NXprocess_mpes/angularN_calibration/physical_quantity-field ` * :ref:`/NXprocess_mpes/CALIBRATION-group ` * :ref:`/NXprocess_mpes/date-field ` * :ref:`/NXprocess_mpes/delay_calibration-group ` * :ref:`/NXprocess_mpes/delay_calibration/calibrated_axis-field ` * :ref:`/NXprocess_mpes/delay_calibration/physical_quantity-field ` * :ref:`/NXprocess_mpes/DISTORTION-group ` * :ref:`/NXprocess_mpes/ellipticity_calibration-group ` * :ref:`/NXprocess_mpes/ellipticity_calibration/calibrated_axis-field ` * :ref:`/NXprocess_mpes/ellipticity_calibration/physical_quantity-field ` * :ref:`/NXprocess_mpes/energy_calibration-group ` * :ref:`/NXprocess_mpes/energy_calibration/calibrated_axis-field ` * :ref:`/NXprocess_mpes/energy_calibration/physical_quantity-field ` * :ref:`/NXprocess_mpes/energy_referencing-group ` * :ref:`/NXprocess_mpes/energy_referencing/binding_energy-field ` * :ref:`/NXprocess_mpes/energy_referencing/calibrated_axis-field ` * :ref:`/NXprocess_mpes/energy_referencing/level-group ` * :ref:`/NXprocess_mpes/energy_referencing/offset-field ` * :ref:`/NXprocess_mpes/energy_referencing/physical_quantity-field ` * :ref:`/NXprocess_mpes/energy_referencing/reference_peak-field ` * :ref:`/NXprocess_mpes/kN_calibration-group ` * :ref:`/NXprocess_mpes/kN_calibration/calibrated_axis-field ` * :ref:`/NXprocess_mpes/kN_calibration/physical_quantity-field ` * :ref:`/NXprocess_mpes/NOTE-group ` * :ref:`/NXprocess_mpes/polarization_angle_calibration-group ` * :ref:`/NXprocess_mpes/polarization_angle_calibration/calibrated_axis-field ` * :ref:`/NXprocess_mpes/polarization_angle_calibration/physical_quantity-field ` * :ref:`/NXprocess_mpes/program-field ` * :ref:`/NXprocess_mpes/REGISTRATION-group ` * :ref:`/NXprocess_mpes/sequence_index-field ` * :ref:`/NXprocess_mpes/spatialN_calibration-group ` * :ref:`/NXprocess_mpes/spatialN_calibration/calibrated_axis-field ` * :ref:`/NXprocess_mpes/spatialN_calibration/physical_quantity-field ` * :ref:`/NXprocess_mpes/transmission_correction-group ` * :ref:`/NXprocess_mpes/transmission_correction/transmission_function-group ` * :ref:`/NXprocess_mpes/transmission_correction/transmission_function/kinetic_energy-field ` * :ref:`/NXprocess_mpes/transmission_correction/transmission_function/relative_intensity-field ` * :ref:`/NXprocess_mpes/transmission_correction/transmission_function@axes-attribute ` * :ref:`/NXprocess_mpes/transmission_correction/transmission_function@signal-attribute ` * :ref:`/NXprocess_mpes/version-field ` * :ref:`/NXprocess_mpes@default-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXprocess_mpes.nxdl.xml