.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXdata_mpes_detector.nxdl.xml -- DO NOT EDIT .. index:: ! NXdata_mpes_detector (base class) ! data_mpes_detector (base class) see: data_mpes_detector (base class); NXdata_mpes_detector .. _NXdata_mpes_detector: ==================== NXdata_mpes_detector ==================== **Status**: base class, extends :ref:`NXdata` **Description**: .. collapse:: :ref:`NXdata_mpes_detector` describes the plottable data and related ... :ref:`NXdata_mpes_detector` describes the plottable data and related dimension scales for raw detector data in photoemission experiments. It extends the NXdata class and provides a glossary of explicitly named axis names which are typical for raw photoemission data. **Symbols**: No symbol table **Groups cited**: none **Structure**: .. _/NXdata_mpes_detector/raw-field: .. index:: raw (field) **raw**: (optional) :ref:`NX_NUMBER ` :ref:`⤆ ` Raw data before calibration. .. _/NXdata_mpes_detector/pixel_x-field: .. index:: pixel_x (field) **pixel_x**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} Detector pixel in x direction. .. _/NXdata_mpes_detector/pixel_y-field: .. index:: pixel_y (field) **pixel_y**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} Detector pixel in y direction. .. _/NXdata_mpes_detector/energy-field: .. index:: energy (field) **energy**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ENERGY `} :ref:`⤆ ` (Un)calibrated energy axis. .. _/NXdata_mpes_detector/energy@type-attribute: .. index:: type (field attribute) **@type**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: The energy can be either stored as kinetic or as binding energy. ... The energy can be either stored as kinetic or as binding energy. Any of these values: * ``kinetic``: (Un)calibrated kinetic energy axis. This concept is related to term `3.35 `_ of the ISO 18115-1:2023 standard. * ``binding``: (Un)calibrated binding energy axis. This concept is related to term `12.16 `_ of the ISO 18115-1:2023 standard. .. _/NXdata_mpes_detector/kN-field: .. index:: kN (field) **kN**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_WAVENUMBER `} :ref:`⤆ ` .. collapse:: One (un)calibrated k-space coordinate. It is envisioned that the axes are name ... One (un)calibrated k-space coordinate. It is envisioned that the axes are named kx, ky, and kz. Typically, the vectors in momentum space are defined such that kx and ky comprise the parallel component, while kz is taken as the perpendicular component. It is also possible to define k_parallel and k_perp for the parallel and perpendicular momenta, respectively. Units are 1/Angström. .. _/NXdata_mpes_detector/angularN-field: .. index:: angularN (field) **angularN**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. collapse:: One (un)calibrated angular coordinate. It is envisioned that the axes are name ... One (un)calibrated angular coordinate. It is envisioned that the axes are name angular0, angular1, etc. The angular axes should be named in order of decreasing speed, i.e., angular0 should be the fastest scan axis and angular1 should be the slow-axis angular coordinate. However, angular0 may also be second slow axis if the measurement is angularly integrated and angular1 could also be the second fast axis in the case of simultaneous dispersion in two angular dimensions. .. _/NXdata_mpes_detector/spatialN-field: .. index:: spatialN (field) **spatialN**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. collapse:: One (un)calibrated spatial coordinate. It is envisioned that the axes are name ... One (un)calibrated spatial coordinate. It is envisioned that the axes are name spatial0, spatial1, etc. The spatial axes should be named in order of decreasing speed, i.e., spatial0 should be the fastest scan axis and spatial1 should be the slow-axis spatial coordinate. However, spatial0 may also be second slow axis if the measurement is spatially integrated and spatial1 could also be the second fast axis in the case of simultaneous dispersion in two spatial dimensions. .. _/NXdata_mpes_detector/time_of_flight-field: .. index:: time_of_flight (field) **time_of_flight**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME_OF_FLIGHT `} Total time of flight. .. _/NXdata_mpes_detector/time_of_flight_adc-field: .. index:: time_of_flight_adc (field) **time_of_flight_adc**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} Time-of-flight values, analog-to-digital converted. .. _/NXdata_mpes_detector/delay-field: .. index:: delay (field) **delay**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_TIME `} :ref:`⤆ ` (Un)calibrated delay time. .. _/NXdata_mpes_detector/polarization_angle-field: .. index:: polarization_angle (field) **polarization_angle**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Linear polarization angle of the incoming or outgoing beam. .. _/NXdata_mpes_detector/ellipticity-field: .. index:: ellipticity (field) **ellipticity**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} Ellipticity of the incoming or outgoing beam. .. _/NXdata_mpes_detector/external_AXIS-field: .. index:: external_AXIS (field) **external_AXIS**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} :ref:`⤆ ` .. collapse:: Describes an axis which is coming from outside the detectors scope. ... Describes an axis which is coming from outside the detectors scope. Think of a detector just being triggered for readout by the rest of the experimental setup - it would just know that it collected N images, which would flatten the external parameters to one axis, too. This can then be linked, e.g. with NXcalibration, to the appropriate fields in the instrument and write it to the top-level NXdata_mpes. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXdata_mpes_detector/angularN-field ` * :ref:`/NXdata_mpes_detector/delay-field ` * :ref:`/NXdata_mpes_detector/ellipticity-field ` * :ref:`/NXdata_mpes_detector/energy-field ` * :ref:`/NXdata_mpes_detector/energy@type-attribute ` * :ref:`/NXdata_mpes_detector/external_AXIS-field ` * :ref:`/NXdata_mpes_detector/kN-field ` * :ref:`/NXdata_mpes_detector/pixel_x-field ` * :ref:`/NXdata_mpes_detector/pixel_y-field ` * :ref:`/NXdata_mpes_detector/polarization_angle-field ` * :ref:`/NXdata_mpes_detector/raw-field ` * :ref:`/NXdata_mpes_detector/spatialN-field ` * :ref:`/NXdata_mpes_detector/time_of_flight-field ` * :ref:`/NXdata_mpes_detector/time_of_flight_adc-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXdata_mpes_detector.nxdl.xml