.. auto-generated by dev_tools.docs.nxdl from the NXDL source applications/NXarpes.nxdl.xml -- DO NOT EDIT .. index:: ! NXarpes (application definition) ! arpes (application definition) see: arpes (application definition); NXarpes .. _NXarpes: ======= NXarpes ======= .. Contributors List .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2022-01-31 .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28 .. |contrib_name| replace:: Russ Berg|RussBerg|https://avatars.githubusercontent.com/u/4698891?v=4|2020-10-19 **Status**: application definition, extends :ref:`NXobject` **Description**: .. collapse:: This is an application definition for angular resolved photo electron spectrosco ... This is an application definition for angular resolved photo electron spectroscopy. It has been drawn up with hemispherical electron analysers in mind. **Symbols**: No symbol table **Groups cited**: :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXmonochromator`, :ref:`NXsample`, :ref:`NXsource` .. index:: NXentry (base class); used in application definition, NXinstrument (base class); used in application definition, NXsource (base class); used in application definition, NXmonochromator (base class); used in application definition, NXdetector (base class); used in application definition, NXsample (base class); used in application definition, NXdata (base class); used in application definition **Structure**: .. _/NXarpes/ENTRY-group: **ENTRY**: (required) :ref:`NXentry` .. _/NXarpes/ENTRY@entry-attribute: .. index:: entry (group attribute) **@entry**: (required) :ref:`NX_CHAR ` .. collapse:: NeXus convention is to use "entry1", "entry2", ... ... NeXus convention is to use "entry1", "entry2", ... for analysis software to locate each entry. .. _/NXarpes/ENTRY/title-field: .. index:: title (field) **title**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXarpes/ENTRY/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXarpes/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Official NeXus NXDL schema to which this file conforms. ... Official NeXus NXDL schema to which this file conforms. Obligatory value: ``NXarpes`` .. _/NXarpes/ENTRY/INSTRUMENT-group: **INSTRUMENT**: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXarpes/ENTRY/INSTRUMENT/SOURCE-group: **SOURCE**: (required) :ref:`NXsource` :ref:`⤆ ` .. _/NXarpes/ENTRY/INSTRUMENT/SOURCE/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXarpes/ENTRY/INSTRUMENT/SOURCE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXarpes/ENTRY/INSTRUMENT/SOURCE/probe-field: .. index:: probe (field) **probe**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``x-ray`` .. _/NXarpes/ENTRY/INSTRUMENT/monochromator-group: **monochromator**: (required) :ref:`NXmonochromator` :ref:`⤆ ` .. _/NXarpes/ENTRY/INSTRUMENT/monochromator/energy-field: .. index:: energy (field) **energy**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ENERGY `} .. _/NXarpes/ENTRY/INSTRUMENT/analyser-group: **analyser**: (required) :ref:`NXdetector` :ref:`⤆ ` .. _/NXarpes/ENTRY/INSTRUMENT/analyser/data-field: .. index:: data (field) **data**: (required) :ref:`NX_NUMBER ` :ref:`⤆ ` .. _/NXarpes/ENTRY/INSTRUMENT/analyser/lens_mode-field: .. index:: lens_mode (field) **lens_mode**: (required) :ref:`NX_CHAR ` setting for the electron analyser lens .. _/NXarpes/ENTRY/INSTRUMENT/analyser/acquisition_mode-field: .. index:: acquisition_mode (field) **acquisition_mode**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: ``swept`` | ``fixed`` .. _/NXarpes/ENTRY/INSTRUMENT/analyser/entrance_slit_shape-field: .. index:: entrance_slit_shape (field) **entrance_slit_shape**: (required) :ref:`NX_CHAR ` Any of these values: ``curved`` | ``straight`` .. _/NXarpes/ENTRY/INSTRUMENT/analyser/entrance_slit_setting-field: .. index:: entrance_slit_setting (field) **entrance_slit_setting**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} dial setting of the entrance slit .. _/NXarpes/ENTRY/INSTRUMENT/analyser/entrance_slit_size-field: .. index:: entrance_slit_size (field) **entrance_slit_size**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_LENGTH `} size of the entrance slit .. _/NXarpes/ENTRY/INSTRUMENT/analyser/pass_energy-field: .. index:: pass_energy (field) **pass_energy**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ENERGY `} energy of the electrons on the mean path of the analyser .. _/NXarpes/ENTRY/INSTRUMENT/analyser/time_per_channel-field: .. index:: time_per_channel (field) **time_per_channel**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_TIME `} todo: define more clearly .. _/NXarpes/ENTRY/INSTRUMENT/analyser/angles-field: .. index:: angles (field) **angles**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANGLE `} .. collapse:: Angular axis of the analyser data ... Angular axis of the analyser data which dimension the axis applies to is defined using the normal NXdata methods. .. _/NXarpes/ENTRY/INSTRUMENT/analyser/energies-field: .. index:: energies (field) **energies**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ENERGY `} .. collapse:: Energy axis of the analyser data ... Energy axis of the analyser data which dimension the axis applies to is defined using the normal NXdata methods. .. _/NXarpes/ENTRY/INSTRUMENT/analyser/sensor_size-field: .. index:: sensor_size (field) **sensor_size**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [2]) number of raw active elements in each dimension .. _/NXarpes/ENTRY/INSTRUMENT/analyser/region_origin-field: .. index:: region_origin (field) **region_origin**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [2]) origin of rectangular region selected for readout .. _/NXarpes/ENTRY/INSTRUMENT/analyser/region_size-field: .. index:: region_size (field) **region_size**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [2]) size of rectangular region selected for readout .. _/NXarpes/ENTRY/SAMPLE-group: **SAMPLE**: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXarpes/ENTRY/SAMPLE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Descriptive name of sample .. _/NXarpes/ENTRY/SAMPLE/temperature-field: .. index:: temperature (field) **temperature**: (required) :ref:`NX_NUMBER ` {units=\ :ref:`NX_TEMPERATURE `} .. _/NXarpes/ENTRY/DATA-group: **DATA**: (required) :ref:`NXdata` :ref:`⤆ ` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXarpes/ENTRY-group ` * :ref:`/NXarpes/ENTRY/DATA-group ` * :ref:`/NXarpes/ENTRY/definition-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT-group ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser-group ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/acquisition_mode-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/angles-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/data-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/energies-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/entrance_slit_setting-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/entrance_slit_shape-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/entrance_slit_size-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/lens_mode-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/pass_energy-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/region_origin-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/region_size-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/sensor_size-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/analyser/time_per_channel-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/monochromator-group ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/monochromator/energy-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/SOURCE-group ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/SOURCE/name-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/SOURCE/probe-field ` * :ref:`/NXarpes/ENTRY/INSTRUMENT/SOURCE/type-field ` * :ref:`/NXarpes/ENTRY/SAMPLE-group ` * :ref:`/NXarpes/ENTRY/SAMPLE/name-field ` * :ref:`/NXarpes/ENTRY/SAMPLE/temperature-field ` * :ref:`/NXarpes/ENTRY/start_time-field ` * :ref:`/NXarpes/ENTRY/title-field ` * :ref:`/NXarpes/ENTRY@entry-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXarpes.nxdl.xml