use unit examples in NXbeam

nexusformat · Oct 7, 2024 · 767eeb3 · 767eeb3
1 parent 1f402e3
commit 767eeb3
Showing 1 changed file with 14 additions and 46 deletions.
diff --git a/base_classes/NXbeam.nxdl.xml b/base_classes/NXbeam.nxdl.xml
@@ -211,55 +211,19 @@
             <dim index="1" value="m"/>
         </dimensions>
     </field>
-    <field name="incident_polarization" type="NX_NUMBER" units="NX_ANY">
+    <field name="incident_polarization" type="NX_NUMBER" units="V^2/m^2">
         <doc>Polarization vector on entering beamline component</doc>
         <dimensions rank="2">
             <dim index="1" value="nP"/>
             <dim index="2" value="2"/>
         </dimensions>
-        <attribute name="units" type="NX_CHAR">
-            <doc>
-                 The units for this observable are not included in the NIAC list.
-                 Responsibility on correct formatting and parsing is handed to the user
-                 by using `NX_ANY`. Correct parsing can still be implemented by using
-                 this attribute.
-
-                 | Fill with:
-
-                 * The unit unidata symbol if the unit has one (Example: T for the unit of magnetic flux density tesla).
-                 * The unit unidata name if the unit has a name (Example: farad for capacitance).
-                 * A string describing the units according to unidata unit operation notation, if the unit is a complex combination of named units and
-                   does not have a name.
-
-                 Example: for lightsource brilliance (SI) 1/(s.mm2.mrad2).
-                 Here: SI units are V2/m2.
-            </doc>
-        </attribute>
     </field>
-    <field name="final_polarization" type="NX_NUMBER" units="NX_ANY">
+    <field name="final_polarization" type="NX_NUMBER" units="V^2/m^2">
         <doc>Polarization vector on leaving beamline component</doc>
         <dimensions rank="2">
             <dim index="1" value="nP"/>
             <dim index="2" value="2"/>
         </dimensions>
-        <attribute name="units" type="NX_CHAR">
-            <doc>
-                 The units for this observable are not included in the NIAC list.
-                 Responsibility on correct formatting and parsing is handed to the user
-                 by using `NX_ANY`. Correct parsing can still be implemented by using
-                 this attribute.
-
-                 | Fill with:
-
-                 * The unit unidata symbol if the unit has one (Example: T for the unit of magnetic flux density tesla).
-                 * The unit unidata name if the unit has a name (Example: farad for capacitance).
-                 * A string describing the units according to unidata unit operation notation, if the unit is a complex combination of named units and
-                   does not have a name.
-
-                 Example: for lightsource brilliance (SI) 1/(s.mm2.mrad2).
-                 Here: SI units are V2/m2.
-            </doc>
-        </attribute>
     </field>
     <field name="incident_polarization_stokes" type="NX_NUMBER" units="NX_ANY">
         <doc>
@@ -329,15 +293,10 @@
              Average power at the diagnostic point
         </doc>
     </field>
-    <field name="fluence" type="NX_FLOAT" units="NX_ANY">
+    <field name="fluence" type="NX_FLOAT" units="mJ/cm^2">
         <doc>
              Incident fluence at the diagnostic point
         </doc>
-        <attribute name="units" type="NX_CHAR">
-            <doc>
-                 Here: SI units are 'J/m2', customary 'mJ/cm2'.
-            </doc>
-        </attribute>
     </field>
     <field name="pulse_duration" type="NX_FLOAT" units="NX_TIME">
         <doc>
@@ -356,7 +315,10 @@
     </field>
     <field name="frog_trace" type="NX_FLOAT">
         <doc>
-             FROG trace of the pulse.
+             FROG (frequency-resolved optical gating) trace of the pulse.
+
+             This is to be used for ultrashort laser pulses in a
+             FROG (frequency-resolved optical gating) setup.
         </doc>
         <dimensions rank="2">
             <dim index="1" value="nx"/>
@@ -366,6 +328,9 @@
     <field name="frog_delays" type="NX_FLOAT" units="NX_TIME">
         <doc>
              Horizontal axis of a FROG trace, i.e. delay.
+
+             This is to be used for ultrashort laser pulses in a
+             FROG (frequency-resolved optical gating) setup.
         </doc>
         <dimensions rank="1">
             <dim index="1" value="nx"/>
@@ -374,6 +339,9 @@
     <field name="frog_frequencies" type="NX_FLOAT" units="NX_FREQUENCY">
         <doc>
              Vertical axis of a FROG trace, i.e. frequency.
+
+             This is to be used for ultrashort laser pulses in a
+             FROG (frequency-resolved optical gating) setup.
         </doc>
         <dimensions rank="1">
             <dim index="1" value="ny"/>
@@ -384,7 +352,7 @@
              The type of chirp implemented
         </doc>
     </field>
-    <field name="chirp_GDD" type="NX_FLOAT" units="NX_TIME">
+    <field name="chirp_GDD" type="NX_FLOAT" units="NX_TIME" nameType="specified">
         <doc>
              Group delay dispersion of the pulse for linear chirp
         </doc>