Merge pull request #150 from FAIRmat-NFDI/voltage_scan_range

Move voltage scan range to NXelectronanalyser
FAIRmat-NFDI · Jan 23, 2024 · 0f31944 · 0f31944
2 parents d2fdad4 + 0a5a742
commit 0f31944
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 27 deletions.
diff --git a/contributed_definitions/NXelectronanalyser.nxdl.xml b/contributed_definitions/NXelectronanalyser.nxdl.xml
@@ -88,6 +88,12 @@
              accurately determine the binding energy scale.
         </doc>
     </field>
+    <field name="voltage_energy_range" type="NX_FLOAT" units="NX_VOLTAGE">
+        <doc>
+             Energy range of the voltage supplies. This influences the noise of the supplies,
+             and thereby the energy resolution.
+        </doc>
+    </field>
     <group name="energy_resolution" type="NXresolution">
         <doc>
              Energy resolution of the analyser with the current setting. May be linked from an

diff --git a/contributed_definitions/NXenergydispersion.nxdl.xml b/contributed_definitions/NXenergydispersion.nxdl.xml
@@ -142,13 +142,6 @@
              Length of the tof drift electrode
         </doc>
     </field>
-    <field name="voltage_scan_range" type="NX_FLOAT" units="NX_VOLTAGE">
-        <doc>
-             Maximum/minimum voltage range of the energy dispersion, i.e., the voltage that is set on
-             the two hemispheres. If this range is set to `k` V, it means that the voltage can be varied
-             -`k` and `k` V. Influences the energy resolution.
-        </doc>
-    </field>
     <group type="NXaperture">
         <doc>
              Size, position and shape of a slit in dispersive analyzer, e.g. entrance and

diff --git a/contributed_definitions/NXmpes.nxdl.xml b/contributed_definitions/NXmpes.nxdl.xml
@@ -293,7 +293,6 @@
                     </field>
                     <field name="pass_energy" type="NX_FLOAT" units="NX_ENERGY"/>
                     <field name="energy_scan_mode" recommended="true"/>
-                    <field name="voltage_scan_range" type="NX_FLOAT" optional="true"/>
                     <group name="entrance_slit" type="NXaperture" optional="true">
                         <doc>
                              Size, position and shape of the entrance slit in dispersive analyzers.

diff --git a/contributed_definitions/nyaml/NXelectronanalyser.yaml b/contributed_definitions/nyaml/NXelectronanalyser.yaml
@@ -51,6 +51,11 @@ NXelectronanalyser(NXobject):
       As a result, the measured kinetic energy :math:`E_K^{\mathrm{meas.}}` of a photoelectron is `independent`
       of the sample work function. Nonetheless, the work function :math:`\phi_s` needs to be known to
       accurately determine the binding energy scale.
+  voltage_energy_range(NX_FLOAT):
+    unit: NX_VOLTAGE
+    doc: |
+      Energy range of the voltage supplies. This influences the noise of the supplies,
+      and thereby the energy resolution.
   energy_resolution(NXresolution):
     doc:
     - |
@@ -201,7 +206,7 @@ NXelectronanalyser(NXobject):
       Any other resolution not explicitly named in this base class.
 
 # ++++++++++++++++++++++++++++++++++ SHA HASH ++++++++++++++++++++++++++++++++++
-# 46e66ca4964b0e498516c08eae405b5ee657527c29a0b88c956704fa61e59c83
+# a713eabad7ec1246a1ceba9da426fd1188b23ddbd16fe7db6271b823ca6dbcd7
 # <?xml version='1.0' encoding='UTF-8'?>
 # <?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
 # <!--
@@ -292,6 +297,12 @@ NXelectronanalyser(NXobject):
 #              accurately determine the binding energy scale.
 #         </doc>
 #     </field>
+#     <field name="voltage_energy_range" type="NX_FLOAT" units="NX_VOLTAGE">
+#         <doc>
+#              Energy range of the voltage supplies. This influences the noise of the supplies,
+#              and thereby the energy resolution.
+#         </doc>
+#     </field>
 #     <group name="energy_resolution" type="NXresolution">
 #         <doc>
 #              Energy resolution of the analyser with the current setting. May be linked from an

diff --git a/contributed_definitions/nyaml/NXenergydispersion.yaml b/contributed_definitions/nyaml/NXenergydispersion.yaml
@@ -106,12 +106,6 @@ NXenergydispersion(NXobject):
     unit: NX_LENGTH
     doc: |
       Length of the tof drift electrode
-  voltage_scan_range(NX_FLOAT):
-    unit: NX_VOLTAGE
-    doc: |
-      Maximum/minimum voltage range of the energy dispersion, i.e., the voltage that is set on
-      the two hemispheres. If this range is set to `k` V, it means that the voltage can be varied
-      -`k` and `k` V. Influences the energy resolution.
   (NXaperture):
     doc: |
       Size, position and shape of a slit in dispersive analyzer, e.g. entrance and
@@ -139,7 +133,7 @@ NXenergydispersion(NXobject):
       the reference coordinate system.
 
 # ++++++++++++++++++++++++++++++++++ SHA HASH ++++++++++++++++++++++++++++++++++
-# 8085fec6b4fd2c46cfbe73186288cec3345d8383985940f7c417693f901825cd
+# e084c20fefdccbc249b32694d11fe8411402d9470fd37fb15b410d3af6fa0fd8
 # <?xml version='1.0' encoding='UTF-8'?>
 # <?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
 # <!--
@@ -284,13 +278,6 @@ NXenergydispersion(NXobject):
 #              Length of the tof drift electrode
 #         </doc>
 #     </field>
-#     <field name="voltage_scan_range" type="NX_FLOAT" units="NX_VOLTAGE">
-#         <doc>
-#              Maximum/minimum voltage range of the energy dispersion, i.e., the voltage that is set on
-#              the two hemispheres. If this range is set to `k` V, it means that the voltage can be varied
-#              -`k` and `k` V. Influences the energy resolution.
-#         </doc>
-#     </field>
 #     <group type="NXaperture">
 #         <doc>
 #              Size, position and shape of a slit in dispersive analyzer, e.g. entrance and

diff --git a/contributed_definitions/nyaml/NXmpes.yaml b/contributed_definitions/nyaml/NXmpes.yaml
@@ -245,8 +245,6 @@ NXmpes(NXobject):
             unit: NX_ENERGY
           energy_scan_mode:
             exists: recommended
-          voltage_scan_range(NX_FLOAT):
-            exists: optional
           entrance_slit(NXaperture):
             exists: optional
             doc: |
@@ -755,7 +753,7 @@ NXmpes(NXobject):
             @energy_depends: 'entry/process/energy_calibration'
 
 # ++++++++++++++++++++++++++++++++++ SHA HASH ++++++++++++++++++++++++++++++++++
-# 602ff2166c0a864186722c2f92db7636511b889b04e5843a6f765d47c441829a
+# 0858e4c498e1d031bbe35e761fdbb30b8db75d6725f7b39b320d53a90ec23587
 # <?xml version='1.0' encoding='UTF-8'?>
 # <?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
 # <!--
@@ -1051,7 +1049,6 @@ NXmpes(NXobject):
 #                     </field>
 #                     <field name="pass_energy" type="NX_FLOAT" units="NX_ENERGY"/>
 #                     <field name="energy_scan_mode" recommended="true"/>
-#                     <field name="voltage_scan_range" type="NX_FLOAT" optional="true"/>
 #                     <group name="entrance_slit" type="NXaperture" optional="true">
 #                         <doc>
 #                              Size, position and shape of the entrance slit in dispersive analyzers.