2.3.3.3.131. NXmpes_arpes

Status:

application definition (contribution), extends NXmpes

Description:

This is a general application definition for angle-resolved (multidimensional) ...

This is a general application definition for angle-resolved (multidimensional) photoelectron spectroscopy (ARPES).

Symbols:

No symbol table

Groups cited:

NXaperture, NXcollectioncolumn, NXcoordinate_system, NXdata, NXelectronanalyzer, NXenergydispersion, NXentry, NXinstrument, NXresolution, NXsample, NXtransformations

Structure:

ENTRY: (required) NXentry

definition: (required) NX_CHAR

Obligatory value: NXmpes_arpes

@version: (required) NX_CHAR

method: (recommended) NX_CHAR

Name of the experimental method. ...

Name of the experimental method.

If applicable, this name should match the terms given by Clause 11 of the ISO 18115-1:2023 specification.

Examples include:
  • angle-resolved photoelectron spectroscopy (ARPES)

  • time-resolved angle-resolved X-ray photoelectron spectroscopy (trARPES)

  • spin-resolved angle-resolved X-ray photoelectron spectroscopy (spin-ARPES)

arpes_geometry: (required) NXcoordinate_system

depends_on: (required) NX_CHAR

TRANSFORMATIONS: (required) NXtransformations

Set of transformations, describing the orientation of the ARPES coordinate ...

Set of transformations, describing the orientation of the ARPES coordinate system with respect to the beam coordinate system (.).

INSTRUMENT: (required) NXinstrument

angularN_resolution: (recommended) NXresolution

Overall angular resolution along the Nth angular axis. Create one such ent ...

Overall angular resolution along the Nth angular axis. Create one such entry per relevant angular axis, corresponding to the angular axes in NXdata. For hemispherical analyzers, angular0_resolution corresponds to the direction along the analyzer slit, and angular1_resolution to the one perpendicular to it.

physical_quantity: (required) NX_CHAR

Obligatory value: angle

type: (recommended) NX_CHAR

resolution: (required) NX_FLOAT {units=NX_ANGLE}

ELECTRONANALYZER: (required) NXelectronanalyzer

depends_on: (required) NX_CHAR

Reference to the last transformation describing the orientation of the a ...

Reference to the last transformation describing the orientation of the analyzer relative to the beam, e.g. transformations/analyzer_elevation.

angularN_resolution: (recommended) NXresolution

Analyzer angular resolution along the Nth angular axis. ...

Analyzer angular resolution along the Nth angular axis. Create one such entry per relevant angular axis, corresponding to the angular axes in NXdata. For hemispherical analyzers, angular0_resolution corresponds to the direction along the analyzer slit, and angular1_resolution to the one perpendicular to it.

physical_quantity: (required) NX_CHAR

Obligatory value: angle

type: (recommended) NX_CHAR

resolution: (required) NX_FLOAT {units=NX_ANGLE}

transformations: (required) NXtransformations

Set of transformations, describing the relative orientation of the analy ...

Set of transformations, describing the relative orientation of the analyzer with respect to the beam coordinate system (.).

analyzer_rotation: (required) NX_NUMBER {units=NX_ANGLE}

Rotation about the analyzer lens axis. ...

Rotation about the analyzer lens axis. Its zero reference is defined such that the angular0 axis is increasing towards the positive y axis (analyzer slit vertical).

@transformation_type: (required) NX_CHAR

Obligatory value: rotation

@vector: (required) NX_NUMBER

Obligatory value: [0, 0, 1]

@depends_on: (required) NX_CHAR

Path to a transformation that places the analyzer origin system into ...

Path to a transformation that places the analyzer origin system into the arpes_geometry coordinate system.

analyzer_elevation: (required) NX_NUMBER {units=NX_ANGLE}

Elevation of the effective analyzer acceptance area, e.g. realized by ...

Elevation of the effective analyzer acceptance area, e.g. realized by deflectors, or as one angle in a TOF detector. If a resolved angle, place the calibrated axis coordinates here.

@transformation_type: (required) NX_CHAR

Obligatory value: rotation

@vector: (required) NX_NUMBER

Obligatory value: [0, 1, 0]

@depends_on: (required) NX_CHAR

Obligatory value: analyzer_dispersion

analyzer_dispersion: (required) NX_NUMBER {units=NX_ANGLE}

In-plane analyzer coordinate along a dispersive direction, ...

In-plane analyzer coordinate along a dispersive direction, e.g. along an analyzer slit. If a resolved angle, place the calibrated coordinates here.

@transformation_type: (required) NX_CHAR

Obligatory value: rotation

@vector: (required) NX_NUMBER

Obligatory value: [1, 0, 0]

@depends_on: (required) NX_CHAR

Obligatory value: analyzer_rotation

COLLECTIONCOLUMN: (required) NXcollectioncolumn

scheme: (recommended) NX_CHAR

Scheme of the electron collection column. ...

Scheme of the electron collection column.

Any of these values: angular dispersive | non-dispersive

angular_acceptance: (recommended) NX_FLOAT

ENERGYDISPERSION: (required) NXenergydispersion

diameter: (recommended) NX_NUMBER {units=NX_LENGTH}

entrance_slit: (recommended) NXaperture

shape: (required) NX_CHAR

Any of these values: straight slit | curved slit

SAMPLE: (required) NXsample

situation: (required) NX_CHAR

Obligatory value: vacuum

depends_on: (required) NX_CHAR

Reference to the end of the transformation chain, ...

Reference to the end of the transformation chain, orienting the sample surface within the arpes_geometry coordinate system (sample_azimuth or anything depending on it).

transformations: (required) NXtransformations

Set of transformations, describing the relative orientation of the sample ...

Set of transformations, describing the relative orientation of the sample with respect to the arpes_geometry coordinate system.

sample_azimuth: (required) NX_NUMBER {units=NX_ANGLE}

Rotation about the z axis (azimuthal rotation within the sample plane).

@transformation_type: (required) NX_CHAR

Obligatory value: rotation

@vector: (required) NX_NUMBER

Obligatory value: [0, 0, 1]

@depends_on: (required) NX_CHAR

Obligatory value: offset_azimuth

offset_azimuth: (required) NX_NUMBER {units=NX_ANGLE}

Offset of azimuthal rotation.

@transformation_type: (required) NX_CHAR

Obligatory value: rotation

@vector: (required) NX_NUMBER

Obligatory value: [0, 0, 1]

@depends_on: (required) NX_CHAR

Obligatory value: sample_tilt

sample_tilt: (required) NX_NUMBER {units=NX_ANGLE}

Rotation about the x axis (typically a manipulator tilt).

@transformation_type: (required) NX_CHAR

Obligatory value: rotation

@vector: (required) NX_NUMBER

Obligatory value: [1, 0, 0]

@depends_on: (required) NX_CHAR

Obligatory value: offset_tilt

offset_tilt: (required) NX_NUMBER {units=NX_ANGLE}

Offset of tilt rotation.

@transformation_type: (required) NX_CHAR

Obligatory value: rotation

@vector: (required) NX_NUMBER

Obligatory value: [1, 0, 0]

@depends_on: (required) NX_CHAR

Obligatory value: sample_polar

sample_polar: (required) NX_NUMBER {units=NX_ANGLE}

Rotation about the y axis (typically the long manipulator axis).

@transformation_type: (required) NX_CHAR

Obligatory value: rotation

@vector: (required) NX_NUMBER

Obligatory value: [0, 1, 0]

@depends_on: (required) NX_CHAR

Obligatory value: offset_polar

offset_polar: (required) NX_NUMBER {units=NX_ANGLE}

Offset of polar rotation.

@transformation_type: (required) NX_CHAR

Obligatory value: rotation

@vector: (required) NX_NUMBER

Obligatory value: [0, 1, 0]

@depends_on: (required) NX_CHAR

Path to a transformation that places the sample surface ...

Path to a transformation that places the sample surface into the origin of the arpes_geometry coordinate system.

DATA: (required) NXdata

@signal: (required) NX_CHAR

There is a field named data that contains the signal. ...

There is a field named data that contains the signal.

Obligatory value: data

@axes: (required) NX_CHAR

There are three dimensions, one energy and two angular coordinates. Any co ...

There are three dimensions, one energy and two angular coordinates. Any coordinates that do not move, are represented by one point.

Obligatory value: ['angular0', 'angular1', 'energy']

@energy_indices: (required) NX_INT

@angular0_indices: (required) NX_INT

@angular1_indices: (required) NX_INT

energy: (required) NX_NUMBER {units=NX_ENERGY}

Values on the energy axis. Could be linked from the respective ``@referenc ...

Values on the energy axis. Could be linked from the respective @reference field.

angular0: (required) NX_NUMBER {units=NX_ANGLE}

Trace of the first angular axis. Could be linked from the respective ...

Trace of the first angular axis. Could be linked from the respective @reference field.

angular1: (required) NX_NUMBER {units=NX_ANGLE}

Trace of the second axis. Could be linked from the respective ``@reference ...

Trace of the second axis. Could be linked from the respective @reference field.

data: (required) NX_NUMBER {units=NX_ANY}

Represents a measurement of photoemission counts over a three-dimensional ...

Represents a measurement of photoemission counts over a three-dimensional space where the varied axes are energy, and one or more angular coordinates. Axes traces should be linked to the actual encoder position in NXinstrument or calibrated axes in NXprocess.

Hypertext Anchors

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

NXDL Source:

https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXmpes_arpes.nxdl.xml