Merge pull request #266 from FAIRmat-NFDI/mpes-clarifications

Small modifications to clarify NXmpes
FAIRmat-NFDI · Jul 11, 2024 · 5ff3ed6 · 5ff3ed6
2 parents bce9eb6 + 32afbb1
commit 5ff3ed6
Show file tree

Hide file tree

Showing 6 changed files with 365 additions and 106 deletions.
diff --git a/base_classes/NXbeam.nxdl.xml b/base_classes/NXbeam.nxdl.xml
@@ -219,8 +219,7 @@
     </field>
     <field name="incident_polarization" type="NX_NUMBER" units="NX_ANY">
         <doc>
-             Incident polarization as a Stokes vector
-             on entering beamline component
+             Polarization vector on entering beamline component
         </doc>
         <dimensions rank="2">
             <dim index="1" value="nP"/>
@@ -247,7 +246,7 @@
     </field>
     <field name="final_polarization" type="NX_NUMBER" units="NX_ANY">
         <doc>
-             Polarization as Stokes vector on leaving beamline component
+             Polarization vector on leaving beamline component
         </doc>
         <dimensions rank="2">
             <dim index="1" value="nP"/>
@@ -495,7 +494,7 @@
     </field>
     <field name="next_device">
         <doc>
-
+             Gives the beam device which this beam will interact with next.
         </doc>
     </field>
 </definition>
diff --git a/base_classes/NXenvironment.nxdl.xml b/base_classes/NXenvironment.nxdl.xml
@@ -58,6 +58,17 @@
              Note, it is recommended to use NXtransformations instead.
         </doc>
     </group>
+    <field name="value" type="NX_FLOAT" units="NX_ANY">
+        <doc>
+             This is to be used if there is no actuator/sensor that controls/measures
+             the environment parameters, but the user would still like to give a value for
+             it. An example would be a room temperature experiment where the temperature is
+             not actively measured, but rather estimated.
+
+             Note that this method for recording the environment parameters is not advised,
+             but using NXsensor and NXactuator is strongly recommended instead.
+        </doc>
+    </field>
     <field name="depends_on" type="NX_CHAR">
         <doc>
              NeXus positions components by applying a set of translations and rotations

diff --git a/base_classes/nyaml/NXbeam.yaml b/base_classes/nyaml/NXbeam.yaml
@@ -172,8 +172,7 @@ NXbeam(NXobject):
   incident_polarization(NX_NUMBER):
     unit: NX_ANY
     doc: |
-      Incident polarization as a Stokes vector
-      on entering beamline component
+      Polarization vector on entering beamline component
     dimensions:
       rank: 2
       dim: [[1, nP], [2, 2]]
@@ -197,7 +196,7 @@ NXbeam(NXobject):
   final_polarization(NX_NUMBER):
     unit: NX_ANY
     doc: |
-      Polarization as Stokes vector on leaving beamline component
+      Polarization vector on leaving beamline component
     dimensions:
       rank: 2
       dim: [[1, nP], [2, 2]]
@@ -394,22 +393,23 @@ NXbeam(NXobject):
         doc: |
           Points to the path to a field defining the location on which this
           depends or the string "." for origin.
-  previous_device: 
+  previous_device:
     doc: |
       Indicates the beam device from which this beam originates.
       This defines, whether the beam in an "input" or "output" beam.
-  next_device: 
+  next_device:
     doc: |
       Gives the beam device which this beam will interact with next.
+
 # ++++++++++++++++++++++++++++++++++ SHA HASH ++++++++++++++++++++++++++++++++++
-# dbe7fba854b6a29c068ef96a3c8fbe28c8217579d5d8a990ffa730ecd269bf21
-# <?xml version="1.0" encoding="UTF-8"?>
+# 0f4d4d5bf996841b80a3b24691b91622899dedd9e07a1944f462d2df2f478f09
+# <?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
 # # License as published by the Free Software Foundation; either
@@ -624,8 +624,7 @@ NXbeam(NXobject):
 #     </field>
 #     <field name="incident_polarization" type="NX_NUMBER" units="NX_ANY">
 #         <doc>
-#              Incident polarization as a Stokes vector
-#              on entering beamline component
+#              Polarization vector on entering beamline component
 #         </doc>
 #         <dimensions rank="2">
 #             <dim index="1" value="nP"/>
@@ -652,7 +651,7 @@ NXbeam(NXobject):
 #     </field>
 #     <field name="final_polarization" type="NX_NUMBER" units="NX_ANY">
 #         <doc>
-#              Polarization as Stokes vector on leaving beamline component
+#              Polarization vector on leaving beamline component
 #         </doc>
 #         <dimensions rank="2">
 #             <dim index="1" value="nP"/>
@@ -859,7 +858,7 @@ NXbeam(NXobject):
 #             <attribute name="depends_on" type="NX_CHAR">
 #                 <doc>
 #                      Points to the path to a field defining the location on which this
-#                      depends or the string &quot;.&quot; for origin.
+#                      depends or the string "." for origin.
 #                 </doc>
 #             </attribute>
 #         </field>
@@ -887,9 +886,20 @@ NXbeam(NXobject):
 #             <attribute name="depends_on" type="NX_CHAR">
 #                 <doc>
 #                      Points to the path to a field defining the location on which this
-#                      depends or the string &quot;.&quot; for origin.
+#                      depends or the string "." for origin.
 #                 </doc>
 #             </attribute>
 #         </field>
 #     </group>
+#     <field name="previous_device">
+#         <doc>
+#              Indicates the beam device from which this beam originates.
+#              This defines, whether the beam in an "input" or "output" beam.
+#         </doc>
+#     </field>
+#     <field name="next_device">
+#         <doc>
+#              Gives the beam device which this beam will interact with next.
+#         </doc>
+#     </field>
 # </definition>
diff --git a/base_classes/nyaml/NXenvironment.yaml b/base_classes/nyaml/NXenvironment.yaml
@@ -24,6 +24,16 @@ NXenvironment(NXobject):
     doc: |
       The position and orientation of the apparatus.
       Note, it is recommended to use NXtransformations instead.
+  value(NX_FLOAT):
+    unit: NX_ANY
+    doc: |
+      This is to be used if there is no actuator/sensor that controls/measures
+      the environment parameters, but the user would still like to give a value for
+      it. An example would be a room temperature experiment where the temperature is
+      not actively measured, but rather estimated.
+      
+      Note that this method for recording the environment parameters is not advised,
+      but using NXsensor and NXactuator is strongly recommended instead.
   depends_on(NX_CHAR):
     doc: |
       NeXus positions components by applying a set of translations and rotations
@@ -63,7 +73,7 @@ NXenvironment(NXobject):
       for a summary of the discussion.
 
 # ++++++++++++++++++++++++++++++++++ SHA HASH ++++++++++++++++++++++++++++++++++
-# 4e4bd4fe380d78389677def141557774db0580c77850b6cfe755ba06e7b57cef
+# 3ce4fc8a319f3ee0ad9eb40c88d67121e939a5f05f690725500c62ba88e7632a
 # <?xml version='1.0' encoding='UTF-8'?>
 # <?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
 # <!--
@@ -124,6 +134,17 @@ NXenvironment(NXobject):
 #              Note, it is recommended to use NXtransformations instead.
 #         </doc>
 #     </group>
+#     <field name="value" type="NX_FLOAT" units="NX_ANY">
+#         <doc>
+#              This is to be used if there is no actuator/sensor that controls/measures
+#              the environment parameters, but the user would still like to give a value for
+#              it. An example would be a room temperature experiment where the temperature is
+#              not actively measured, but rather estimated.
+#              
+#              Note that this method for recording the environment parameters is not advised,
+#              but using NXsensor and NXactuator is strongly recommended instead.
+#         </doc>
+#     </field>
 #     <field name="depends_on" type="NX_CHAR">
 #         <doc>
 #              NeXus positions components by applying a set of translations and rotations