NXmpes

Status:

application definition, extends NXobject

Description:

This is the most general application definition for multidimensional photoelectron spectroscopy.

Symbols:

The symbols used in the schema to specify e.g. dimensions of arrays

nfa

nsa

nx

ne

Groups cited:

NXbeam, NXcalibration, NXcollectioncolumn, NXdata, NXdetector, NXelectronanalyser, NXenergydispersion, NXentry, NXinstrument, NXprocess, NXsample, NXsource

Structure:

ENTRY: (required) NXentry

title: (required) NX_CHAR

Title describing the entry.

start_time: (required) NX_DATE_TIME

ISO8601 formatted date time of the start of the measurement.

definition: (required) NX_CHAR

Official NeXus NXDL schema to which this file conforms.

Obligatory value: NXmpes

@version: (required) NX_CHAR

Version specifier enabling to document modification of the schema.

INSTRUMENT: (required) NXinstrument

SOURCE: (required) NXsource

type: (required) NX_CHAR

Type of source. Any of these values: - Synchrotron X-ray Source - Rotating Anode X-ray - Fixed Tube X-ray - UV Laser - Free-Electron Laser - Optical Laser - UV Plasma Source - Metal Jet X-ray

Any of these values:

  • Synchrotron X-ray Source

  • Rotating Anode X-ray

  • Fixed Tube X-ray

  • UV Laser

  • Free-Electron Laser

  • Optical Laser

  • UV Plasma Source

  • Metal Jet X-ray

name: (required) NX_CHAR

Free text name of the source.

probe: (required) NX_CHAR

Type of probe. In photoemission it’s always photons, any of these values: - x-ray - ultraviolet - visible light

Any of these values: x-ray | ultraviolet | visible light

BEAM: (required) NXbeam

Properties of the beam at the sample.

distance: (required) NX_NUMBER {units=NX_LENGTH}

Distance of the point of evaluation of the beam from the sample.

incident_energy: (required) NX_NUMBER {units=NX_ENERGY}

Incident photon energy.

incident_energy_spread: (recommended) NX_NUMBER {units=NX_ENERGY}

FWHM energy linewidth of the incident photons.

incident_polarization[4]: (recommended) NX_NUMBER {units=NX_ANY}

Incident polarization specified as a Stokes vector.

ELECTRONANALYSER: (required) NXelectronanalyser

description: (required) NX_CHAR

Free text description of the type of detector.

energy_resolution: (required) NX_NUMBER {units=NX_ENERGY}

Energy resolution of the analyser with the current setting.

fast_axes[nfa]: (optional) NX_CHAR

List of the axes that are acquired symultaneously by the detector.

slow_axes[nsa]: (optional) NX_CHAR

List of the axes that are acquired by scanning a physical parameter, listed in order of decreasing speed.

COLLECTIONCOLUMN: (required) NXcollectioncolumn

scheme: (required) NX_CHAR

Scheme of the electron collection column.

Any of these values:

  • Standard

  • Deflector

  • PEEM

  • Momentum Microscope

mode: (recommended) NX_CHAR

Labelling of the lens setting in use.

projection: (recommended) NX_CHAR

The space projected in the angularly dispersive directions, i.e. real or reciprocal.

Any of these values: real | reciprocal

ENERGYDISPERSION: (required) NXenergydispersion

scheme: (required) NX_CHAR

Energy dispersion scheme employed.

Any of these values:

  • tof

  • hemispherical

  • cylindrical mirror

  • display mirror

  • retarding grid

pass_energy: (required) NX_NUMBER {units=NX_ENERGY}

energy of the electrons on the mean path of the analyser.

energy_scan_mode: (required) NX_CHAR

Way of scanning the energy axis (fixed or sweep).

Any of these values: fixed | sweep

DETECTOR: (required) NXdetector

amplifier_type: (required) NX_CHAR

Type of electron amplifier.

Any of these values: MCP | channeltron

detector_type: (required) NX_CHAR

Description of the detector type.

Any of these values: DLD | Phosphor+CCD | Phosphor+CMOS | ECMOS

PROCESS: (required) NXprocess

calculated_energy[ne]: (recommended) NX_FLOAT {units=NX_ENERGY}

Calibrated energy axis

energy_calibration: (required) NXcalibration

applied: (required) NX_BOOLEAN

Has an energy calibration been applied?

SAMPLE: (required) NXsample

name: (required) NX_CHAR

Simple and descriptive name of the sample.

chemical_formula: (required) NX_CHAR

Chemical formula of the sample.

sample_history: (optional) NX_CHAR

Ideally, a reference to the location or a unique identifier or other metadata file. In the case that is not available, free-text description.

preparation_date: (recommended) NX_DATE_TIME

ISO 8601 date of preparation of the sample for the ARPES experiment (i.e. cleaving, last annealing).

description: (required) NX_CHAR

Free-text surface preparation technique for the ARPES experiment, i.e. UHV cleaving, in-situ growth, sputtering/annealing etc.

temperature: (required) NX_NUMBER {units=NX_TEMPERATURE}

Temperature of the sample.

situation: (required) NX_CHAR

pressure: (required) NX_NUMBER {units=NX_PRESSURE}

Residual gas pressure at the sample.

DATA: (required) NXdata

data: (required) NX_NUMBER

Processed plottable data.

Hypertext Anchors

Table of hypertext anchors for all groups, fields, attributes, and links defined in this class.

documentation (reST source) anchor

web page (HTML) anchor

/NXmpes/ENTRY-group

#nxmpes-entry-group

/NXmpes/ENTRY/DATA-group

#nxmpes-entry-data-group

/NXmpes/ENTRY/DATA/data-field

#nxmpes-entry-data-data-field

/NXmpes/ENTRY/definition-field

#nxmpes-entry-definition-field

/NXmpes/ENTRY/definition@version-attribute

#nxmpes-entry-definition-version-attribute

/NXmpes/ENTRY/INSTRUMENT-group

#nxmpes-entry-instrument-group

/NXmpes/ENTRY/INSTRUMENT/BEAM-group

#nxmpes-entry-instrument-beam-group

/NXmpes/ENTRY/INSTRUMENT/BEAM/distance-field

#nxmpes-entry-instrument-beam-distance-field

/NXmpes/ENTRY/INSTRUMENT/BEAM/incident_energy-field

#nxmpes-entry-instrument-beam-incident-energy-field

/NXmpes/ENTRY/INSTRUMENT/BEAM/incident_energy_spread-field

#nxmpes-entry-instrument-beam-incident-energy-spread-field

/NXmpes/ENTRY/INSTRUMENT/BEAM/incident_polarization-field

#nxmpes-entry-instrument-beam-incident-polarization-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER-group

#nxmpes-entry-instrument-electronanalyser-group

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/COLLECTIONCOLUMN-group

#nxmpes-entry-instrument-electronanalyser-collectioncolumn-group

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/COLLECTIONCOLUMN/mode-field

#nxmpes-entry-instrument-electronanalyser-collectioncolumn-mode-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/COLLECTIONCOLUMN/projection-field

#nxmpes-entry-instrument-electronanalyser-collectioncolumn-projection-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/COLLECTIONCOLUMN/scheme-field

#nxmpes-entry-instrument-electronanalyser-collectioncolumn-scheme-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/description-field

#nxmpes-entry-instrument-electronanalyser-description-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/DETECTOR-group

#nxmpes-entry-instrument-electronanalyser-detector-group

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/DETECTOR/amplifier_type-field

#nxmpes-entry-instrument-electronanalyser-detector-amplifier-type-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/DETECTOR/detector_type-field

#nxmpes-entry-instrument-electronanalyser-detector-detector-type-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/energy_resolution-field

#nxmpes-entry-instrument-electronanalyser-energy-resolution-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/ENERGYDISPERSION-group

#nxmpes-entry-instrument-electronanalyser-energydispersion-group

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/ENERGYDISPERSION/energy_scan_mode-field

#nxmpes-entry-instrument-electronanalyser-energydispersion-energy-scan-mode-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/ENERGYDISPERSION/pass_energy-field

#nxmpes-entry-instrument-electronanalyser-energydispersion-pass-energy-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/ENERGYDISPERSION/scheme-field

#nxmpes-entry-instrument-electronanalyser-energydispersion-scheme-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/fast_axes-field

#nxmpes-entry-instrument-electronanalyser-fast-axes-field

/NXmpes/ENTRY/INSTRUMENT/ELECTRONANALYSER/slow_axes-field

#nxmpes-entry-instrument-electronanalyser-slow-axes-field

/NXmpes/ENTRY/INSTRUMENT/SOURCE-group

#nxmpes-entry-instrument-source-group

/NXmpes/ENTRY/INSTRUMENT/SOURCE/name-field

#nxmpes-entry-instrument-source-name-field

/NXmpes/ENTRY/INSTRUMENT/SOURCE/probe-field

#nxmpes-entry-instrument-source-probe-field

/NXmpes/ENTRY/INSTRUMENT/SOURCE/type-field

#nxmpes-entry-instrument-source-type-field

/NXmpes/ENTRY/PROCESS-group

#nxmpes-entry-process-group

/NXmpes/ENTRY/PROCESS/calculated_energy-field

#nxmpes-entry-process-calculated-energy-field

/NXmpes/ENTRY/PROCESS/energy_calibration-group

#nxmpes-entry-process-energy-calibration-group

/NXmpes/ENTRY/PROCESS/energy_calibration/applied-field

#nxmpes-entry-process-energy-calibration-applied-field

/NXmpes/ENTRY/SAMPLE-group

#nxmpes-entry-sample-group

/NXmpes/ENTRY/SAMPLE/chemical_formula-field

#nxmpes-entry-sample-chemical-formula-field

/NXmpes/ENTRY/SAMPLE/description-field

#nxmpes-entry-sample-description-field

/NXmpes/ENTRY/SAMPLE/name-field

#nxmpes-entry-sample-name-field

/NXmpes/ENTRY/SAMPLE/preparation_date-field

#nxmpes-entry-sample-preparation-date-field

/NXmpes/ENTRY/SAMPLE/pressure-field

#nxmpes-entry-sample-pressure-field

/NXmpes/ENTRY/SAMPLE/sample_history-field

#nxmpes-entry-sample-sample-history-field

/NXmpes/ENTRY/SAMPLE/situation-field

#nxmpes-entry-sample-situation-field

/NXmpes/ENTRY/SAMPLE/temperature-field

#nxmpes-entry-sample-temperature-field

/NXmpes/ENTRY/start_time-field

#nxmpes-entry-start-time-field

/NXmpes/ENTRY/title-field

#nxmpes-entry-title-field

NXDL Source:

https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/applications/NXmpes.nxdl.xml