Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add radius to NXenergydispersion #273

Merged
merged 1 commit into from
Jul 23, 2024
Merged

Add radius to NXenergydispersion #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions contributed_definitions/NXenergydispersion.nxdl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@
Diameter of the dispersive orbit
</doc>
</field>
<field name="radius" type="NX_FLOAT" units="NX_LENGTH">
<doc>
Radius of the dispersive orbit
</doc>
</field>
<field name="energy_scan_mode" type="NX_CHAR">
<doc>
Way of scanning the energy axis
Expand Down
2 changes: 1 addition & 1 deletion contributed_definitions/NXxps.nxdl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@
<field name="magnification" type="NX_FLOAT" recommended="true" units="NX_DIMENSIONLESS"/>
</group>
<group type="NXenergydispersion">
<field name="diameter" type="NX_NUMBER" recommended="true" units="NX_LENGTH"/>
<field name="radius" type="NX_NUMBER" recommended="true" units="NX_LENGTH"/>
<field name="energy_scan_mode"/>
</group>
<field name="depends_on" recommended="true">
Expand Down
56 changes: 29 additions & 27 deletions contributed_definitions/nyaml/NXenergydispersion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ NXenergydispersion(NXobject):
unit: NX_LENGTH
doc: |
Diameter of the dispersive orbit
radius(NX_FLOAT):
unit: NX_LENGTH
doc: |
Radius of the dispersive orbit
energy_scan_mode(NX_CHAR):
doc: |
Way of scanning the energy axis
Expand Down Expand Up @@ -90,10 +94,10 @@ NXenergydispersion(NXobject):
specified time. This mode is particulary useful during setup or alignment of the
electron analyzer, for analysis of stability of the excitation source or for sample
alignment.

Since the mode measures intensity as a function of time, the difference in channel signals
is not of interest. Therefore, the signals from all channels are summed.

Synonyms: FE mode
snapshot:
doc: |
Expand Down Expand Up @@ -153,13 +157,13 @@ NXenergydispersion(NXobject):
for a summary of the discussion.

# ++++++++++++++++++++++++++++++++++ SHA HASH ++++++++++++++++++++++++++++++++++
# e89833fc28b832f73564da2bfcea931ca31dbf1e6723fdadc68eeb38eb667ec8
# 452a3427a6f6f009c7bab95daa4446fc74167c9d4ef6aad50811eee8e5c41ea5
# <?xml version='1.0' encoding='UTF-8'?>
# <?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
# <!--
# # NeXus - Neutron and X-ray Common Data Format
# #
# # Copyright (C) 2014-2022 NeXus International Advisory Committee (NIAC)
# # Copyright (C) 2014-2024 NeXus International Advisory Committee (NIAC)
# #
# # This library is free software; you can redistribute it and/or
# # modify it under the terms of the GNU Lesser General Public
Expand Down Expand Up @@ -190,14 +194,6 @@ NXenergydispersion(NXobject):
# </field>
# <field name="pass_energy" type="NX_FLOAT" units="NX_ENERGY">
# <doc>
# Energy of the electrons on the mean path of the analyser. Pass energy for
# hemispherics, drift energy for tofs.
#
# Refers to Term `12.63`_ of the ISO 18115-1:2023 specification.
# </doc>
# </field>
# <field name="kinetic_energy" type="NX_FLOAT" units="NX_ENERGY">
# <doc>
# Mean kinetic energy of the electrons in the energy-dispersive portion of the analyser.
# This term should be used for hemispherical analysers.
#
Expand All @@ -206,6 +202,12 @@ NXenergydispersion(NXobject):
# .. _12.63: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:12.63
# </doc>
# </field>
# <field name="kinetic_energy" type="NX_FLOAT" units="NX_ENERGY">
# <doc>
# Kinetic energy set for the dispersive analyzer section. Can be either the set kinetic energy,
# or the whole calibrated energy axis of a scan.
# </doc>
# </field>
# <field name="drift_energy" type="NX_FLOAT" units="NX_ENERGY">
# <doc>
# Drift energy for time-of-flight energy dispersive elements.
Expand All @@ -230,14 +232,14 @@ NXenergydispersion(NXobject):
# Diameter of the dispersive orbit
# </doc>
# </field>
# <field name="radius" type="NX_FLOAT" units="NX_LENGTH">
# <doc>
# Radius of the dispersive orbit
# </doc>
# </field>
# <field name="energy_scan_mode" type="NX_CHAR">
# <doc>
# Way of scanning the energy axis (fixed or sweep).
#
# Refers to Terms `12.65`_ and `12.66`_ of the ISO 18115-1:2023 specification.
#
# .. _12.65: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:12.65
# .. _12.66: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:12.66
# Way of scanning the energy axis
# </doc>
# <enumeration>
# <item value="fixed_analyser_transmission">
Expand All @@ -247,15 +249,15 @@ NXenergydispersion(NXobject):
# Here, :math:`W = e \phi` is the spectrometer work function (with the potential difference :math:`\phi_{\mathrm{sample}}`
# between the electrochemical potential of electrons in the bulk and the electrostatic potential of an electron in the
# vacuum just outside the surface).
#
#
# This mode is often used in XPS/UPS because the energy resolution does not change with
# changing energy (due to the constant pass energy).
#
#
# Synonyms: constant :math:`\Delta E` mode, constant analyser energy mode, CAE
# mode, FAT mode
#
#
# This concept is related to term `12.64`_ of the ISO 18115-1:2023 standard.
#
#
# .. _12.64: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:12.64
# </doc>
# </item>
Expand All @@ -267,12 +269,12 @@ NXenergydispersion(NXobject):
# used in Auger electron spectroscopy (AES) to improve S/N for high-KE electrons, but this
# leads to a changing energy resolution (:math:`\Delta E \sim E_p`) at different kinetic energies.
# It can however also be used in XPS.
#
#
# Synonyms: constant :math:`\Delta E/E` mode, constant retardation ratio mode, CRR
# mode, FRR mode
#
#
# This concept is related to term `12.66`_ of the ISO 18115-1:2023 standard.
#
#
# .. _12.66: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:12.66
# </doc>
# </item>
Expand All @@ -282,10 +284,10 @@ NXenergydispersion(NXobject):
# specified time. This mode is particulary useful during setup or alignment of the
# electron analyzer, for analysis of stability of the excitation source or for sample
# alignment.
#
#
# Since the mode measures intensity as a function of time, the difference in channel signals
# is not of interest. Therefore, the signals from all channels are summed.
#
#
# Synonyms: FE mode
# </doc>
# </item>
Expand Down
6 changes: 3 additions & 3 deletions contributed_definitions/nyaml/NXxps.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ NXxps(NXmpes):
exists: recommended
unit: NX_DIMENSIONLESS
(NXenergydispersion):
diameter(NX_NUMBER):
radius(NX_NUMBER):
exists: recommended
unit: NX_LENGTH
energy_scan_mode:
Expand Down Expand Up @@ -232,7 +232,7 @@ NXxps(NXmpes):
\@energy_indices:

# ++++++++++++++++++++++++++++++++++ SHA HASH ++++++++++++++++++++++++++++++++++
# 59c4a524be2f9db0fc2398d905fa42f69a76b59cdc5a4177539f30010f8f5271
# 804ce774ddb827110dd20f43f5edf1748376d129a0b4f6416c94980c77270e55
# <?xml version='1.0' encoding='UTF-8'?>
# <?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
# <!--
Expand Down Expand Up @@ -438,7 +438,7 @@ NXxps(NXmpes):
# <field name="magnification" type="NX_FLOAT" recommended="true" units="NX_DIMENSIONLESS"/>
# </group>
# <group type="NXenergydispersion">
# <field name="diameter" type="NX_NUMBER" recommended="true" units="NX_LENGTH"/>
# <field name="radius" type="NX_NUMBER" recommended="true" units="NX_LENGTH"/>
# <field name="energy_scan_mode"/>
# </group>
# <field name="depends_on" recommended="true">
Expand Down
Loading