NXarpes

Status:

application definition, extends NXobject

Description:

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:

NXdata, NXdetector, NXentry, NXinstrument, NXmonochromator, NXsample, NXsource

Structure:

ENTRY: (required) NXentry

@entry: (required) NX_CHAR

NeXus convention is to use “entry1”, “entry2”, … for analysis software to locate each entry.

title: (required) NX_CHAR

start_time: (required) NX_DATE_TIME

definition: (required) NX_CHAR

Official NeXus NXDL schema to which this file conforms.

Obligatory value: NXarpes

INSTRUMENT: (required) NXinstrument

SOURCE: (required) NXsource

type: (required) NX_CHAR

name: (required) NX_CHAR

probe: (required) NX_CHAR

Obligatory value: x-ray

monochromator: (required) NXmonochromator

energy: (required) NX_NUMBER {units=NX_ENERGY}

analyser: (required) NXdetector

data: (required) NX_NUMBER

lens_mode: (required) NX_CHAR

setting for the electron analyser lens

acquisition_mode: (required) NX_CHAR

Any of these values: swept | fixed

entrance_slit_shape: (required) NX_CHAR

Any of these values: curved | straight

entrance_slit_setting: (required) NX_NUMBER {units=NX_ANY}

dial setting of the entrance slit

entrance_slit_size: (required) NX_CHAR {units=NX_LENGTH}

size of the entrance slit

pass_energy: (required) NX_CHAR {units=NX_ENERGY}

energy of the electrons on the mean path of the analyser

time_per_channel: (required) NX_CHAR {units=NX_TIME}

todo: define more clearly

angles: (required) NX_NUMBER {units=NX_ANGLE}

Angular axis of the analyser data which dimension the axis applies to is defined using the normal NXdata methods.

energies: (required) NX_NUMBER {units=NX_ENERGY}

Energy axis of the analyser data which dimension the axis applies to is defined using the normal NXdata methods.

sensor_size[2]: (required) NX_INT

number of raw active elements in each dimension

region_origin[2]: (required) NX_INT

origin of rectangular region selected for readout

region_size[2]: (required) NX_INT

size of rectangular region selected for readout

SAMPLE: (required) NXsample

name: (required) NX_CHAR

Descriptive name of sample

temperature: (required) NX_NUMBER {units=NX_TEMPERATURE}

DATA: (required) NXdata

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

/NXarpes/ENTRY-group

#nxarpes-entry-group

/NXarpes/ENTRY/DATA-group

#nxarpes-entry-data-group

/NXarpes/ENTRY/definition-field

#nxarpes-entry-definition-field

/NXarpes/ENTRY/INSTRUMENT-group

#nxarpes-entry-instrument-group

/NXarpes/ENTRY/INSTRUMENT/analyser-group

#nxarpes-entry-instrument-analyser-group

/NXarpes/ENTRY/INSTRUMENT/analyser/acquisition_mode-field

#nxarpes-entry-instrument-analyser-acquisition-mode-field

/NXarpes/ENTRY/INSTRUMENT/analyser/angles-field

#nxarpes-entry-instrument-analyser-angles-field

/NXarpes/ENTRY/INSTRUMENT/analyser/data-field

#nxarpes-entry-instrument-analyser-data-field

/NXarpes/ENTRY/INSTRUMENT/analyser/energies-field

#nxarpes-entry-instrument-analyser-energies-field

/NXarpes/ENTRY/INSTRUMENT/analyser/entrance_slit_setting-field

#nxarpes-entry-instrument-analyser-entrance-slit-setting-field

/NXarpes/ENTRY/INSTRUMENT/analyser/entrance_slit_shape-field

#nxarpes-entry-instrument-analyser-entrance-slit-shape-field

/NXarpes/ENTRY/INSTRUMENT/analyser/entrance_slit_size-field

#nxarpes-entry-instrument-analyser-entrance-slit-size-field

/NXarpes/ENTRY/INSTRUMENT/analyser/lens_mode-field

#nxarpes-entry-instrument-analyser-lens-mode-field

/NXarpes/ENTRY/INSTRUMENT/analyser/pass_energy-field

#nxarpes-entry-instrument-analyser-pass-energy-field

/NXarpes/ENTRY/INSTRUMENT/analyser/region_origin-field

#nxarpes-entry-instrument-analyser-region-origin-field

/NXarpes/ENTRY/INSTRUMENT/analyser/region_size-field

#nxarpes-entry-instrument-analyser-region-size-field

/NXarpes/ENTRY/INSTRUMENT/analyser/sensor_size-field

#nxarpes-entry-instrument-analyser-sensor-size-field

/NXarpes/ENTRY/INSTRUMENT/analyser/time_per_channel-field

#nxarpes-entry-instrument-analyser-time-per-channel-field

/NXarpes/ENTRY/INSTRUMENT/monochromator-group

#nxarpes-entry-instrument-monochromator-group

/NXarpes/ENTRY/INSTRUMENT/monochromator/energy-field

#nxarpes-entry-instrument-monochromator-energy-field

/NXarpes/ENTRY/INSTRUMENT/SOURCE-group

#nxarpes-entry-instrument-source-group

/NXarpes/ENTRY/INSTRUMENT/SOURCE/name-field

#nxarpes-entry-instrument-source-name-field

/NXarpes/ENTRY/INSTRUMENT/SOURCE/probe-field

#nxarpes-entry-instrument-source-probe-field

/NXarpes/ENTRY/INSTRUMENT/SOURCE/type-field

#nxarpes-entry-instrument-source-type-field

/NXarpes/ENTRY/SAMPLE-group

#nxarpes-entry-sample-group

/NXarpes/ENTRY/SAMPLE/name-field

#nxarpes-entry-sample-name-field

/NXarpes/ENTRY/SAMPLE/temperature-field

#nxarpes-entry-sample-temperature-field

/NXarpes/ENTRY/start_time-field

#nxarpes-entry-start-time-field

/NXarpes/ENTRY/title-field

#nxarpes-entry-title-field

/NXarpes/ENTRY@entry-attribute

#nxarpes-entry-entry-attribute

NXDL Source:

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