Skip to content

Commit

Permalink
Update documentation, add comments for discussion
Browse files Browse the repository at this point in the history
  • Loading branch information
@lukaspie
lukaspie authored and RubelMozumder committed May 9, 2023
1 parent 1863a14 commit 24c42cd
Showing 1 changed file with 24 additions and 20 deletions.
44 changes: 24 additions & 20 deletions contributed_definitions/nyaml/NXmpes_xps.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ NXmpes_xps(NXmpes):
units: NX_ANY
file(NXnote):
exists: recommended
doc: "File containing the transmission function data of the electron collection column.
doc: "Name of the file containing the transmission function data of the electron collection column.
This should be a link to /entry/instrument/collectioncolumn/transmission_function/file."
(NXenergydispersion):
scheme(NX_CHAR):
Expand All @@ -84,18 +84,19 @@ NXmpes_xps(NXmpes):
"detector voltage scan",
"constant final state",
"constant initial state",
]
]
# Not strictly neccessary to have.
iris(NXaperture):
exists: optional
analyzer_radius(NX_FLOAT):
exists: optional
description: "The radius of the hemispherical analyzer in mm (only if hemispherical analyzer is used."
description: "The radius of the hemispherical analyzer in mm (only if hemispherical analyzer is used)."
unit: NX_LENGTH
(NXmanipulator):
heater_type(NX_CHAR):
exists: optional
doc: "Method of heating the sample. Can be e.g. electron beam heating, laser, halogen lamp."
# Could potentially add some more options here.
# Could add some more options here.
enumeration: [
"electron beam heating",
"laser",
Expand All @@ -116,15 +117,16 @@ NXmpes_xps(NXmpes):
intensity_calibration(NXcalibration):
exists: optional
applied(NX_BOOLEAN):
doc: "Has an intensity calibration been applied? That is, has the transmission function of the analyzer been taken into account?"
doc: "Has an intensity calibration been applied?
That is, has the transmission function of the analyzer been taken into account?"
transmission_function(NX_FLOAT):
exists: recommended
doc: "Transmission function of the electron collection column.
This should be a link to /entry/instrument/collectioncolumn/transmission_function."
units: NX_ANY
file(NXnote):
exists: recommended
doc: "File containing the transmission function data.
doc: "Name of the file containing the transmission function data."
energy_reference(NXcalibration):
exists: optional
applied(NX_BOOLEAN):
Expand All @@ -137,14 +139,17 @@ NXmpes_xps(NXmpes):
doc: "Offset between measured binding energy and calibrated binding energy of the emission line."
binding_energy(NX_FLOAT):
exists: recommended
doc: "The binding energy that the specified emission line appeared at, after adjusting the binding energy scale, in units of eV"
doc: "The binding energy that the specified emission line appeared at,
after adjusting the binding energy scale, in units of eV"
calibrated_axis(NX_FLOAT):
exists: recommended
doc: "This is the calibrated energy axis to be used for data plotting. This should be a link to /entry/data/energy."
doc: "This is the calibrated energy axis to be used for data plotting.
This should be a link to /entry/data/energy."
(NXsample):
form(NX_CHAR):
exists: optional
enumeration:
# There should be more options here.
[
"foil",
"single crystal",
Expand All @@ -153,7 +158,10 @@ NXmpes_xps(NXmpes):
]
gas_pressure(NX_FLOAT):
unit: NX_PRESSURE
doc: "In the case of a fixed pressure measurement this is the scalar pressure. In the case of an experiment in which pressure changes, or anyway it is recorded, this is an array of length m of pressures."
doc: |
In the case of a fixed pressure measurement this is the scalar pressure.
In the case of an experiment in which pressure changes, or anyway it is recorded,
this is an array of length m of pressures.
gas_phase(NX_CHAR):
exists: optional
doc: "Description of the constituent gases of the gas phase."
Expand All @@ -165,24 +173,20 @@ NXmpes_xps(NXmpes):
doc: "Set of transformations, describing the relative orientation of the sample with respect to the beam coordinate system."
(NXdata):
\@axes(NX_CHAR):
doc: "It should contain at least one axis called 'energy'."
doc: "The data should contain at least one axis called 'energy'."
energy(NX_NUMBER):
doc: |
The calibrated energy axis can be either in binding or kinetic energy.
This should be a link to either
/entry/process/energy calibration/calibrated_axis or
/entry/process/energy_reference/calibrated_axis.
\@type(NX_CHAR):
exists: recommended
doc: "The calibrated energy axis can be either in binding or kinetic energy. "
enumeration:
[
"kinetic",
"binding"
]
\@step_size(NX_FLOAT):
exists: optional
doc: "The step size between two consecutive energy values if the energy axis is evenly spaced."
data(NX_NUMBER):
doc: "Processed plottable data. Represents a measure of one- or more-dimensional photoemission counts, where
the varied axis may be for example energy, spatial coordinate, pump-probe delay, temperature, etc.
The axes traces should be linked to the actual encoder position in NXinstrument or calibrated axes in NXprocess."
\@units(NX_ANY):
exists: recommended
\@long_name(NX_CHAR):
exists: optional
doc: "The step size between two consecutive energy values if the energy axis is evenly spaced."

0 comments on commit 24c42cd

Please sign in to comment.