Regeneration of the nexus file for fixing the changes coming from old…

… version of yaml. Removing unintensional comments # Conflicts: # base_classes/NXbeam.nxdl.xml # base_classes/NXdetector.nxdl.xml # base_classes/NXentry.nxdl.xml # base_classes/NXinstrument.nxdl.xml # base_classes/NXprocess.nxdl.xml # base_classes/NXsample.nxdl.xml # base_classes/NXsource.nxdl.xml
nexusformat · Sep 23, 2024 · 1a1d474 · 1a1d474
1 parent 31bdf0d
commit 1a1d474
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 189 deletions.
diff --git a/base_classes/NXaperture.nxdl.xml b/base_classes/NXaperture.nxdl.xml
@@ -8,7 +8,7 @@
 # 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
-# version 2 of the License, or (at your option) any later version.
+# version 3 of the License, or (at your option) any later version.
 #
 # This library is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of

diff --git a/base_classes/NXbeam.nxdl.xml b/base_classes/NXbeam.nxdl.xml
@@ -61,45 +61,11 @@
         <doc>Distance from sample. Note, it is recommended to use NXtransformations instead.</doc>
     </field>
     <field name="incident_energy" type="NX_FLOAT" units="NX_ENERGY">
-        <doc>
-            Energy carried by each particle of the beam on entering the beamline component.
-
-            In the case of a monochromatic beam this is the scalar energy.
-            Several other use cases are permitted, depending on the 
-            presence of other incident_energy_X fields.
-
-            * In the case of a polychromatic beam this is an array of length m of energies, with the relative weights in incident_energy_weights.
-            * In the case of a monochromatic beam that varies shot-to-shot, this is an array of energies, one for each recorded shot.
-            Here, incident_energy_weights and incident_energy_spread are not set.
-            * In the case of a polychromatic beam that varies shot-to-shot,
-            this is an array of length m with the relative weights in incident_energy_weights as a 2D array.
-            * In the case of a polychromatic beam that varies shot-to-shot and where the channels also vary,
-            this is a 2D array of dimensions nP by m (slow to fast) with the relative weights in incident_energy_weights as a 2D array.
-
-            Note, variants are a good way to represent several of these use cases in a single dataset,
-            e.g. if a calibrated, single-value energy value is available along with the original spectrum from which it was calibrated.
-        </doc>
+        <doc>Energy carried by each particle of the beam on entering the beamline component</doc>
         <dimensions rank="1">
             <dim index="1" value="m"/>
         </dimensions>
     </field>
-    <field name="incident_energy_spread" type="NX_NUMBER" units="NX_ENERGY">
-        <doc>
-            The energy spread FWHM for the corresponding energy(ies) in incident_energy. In the case of shot-to-shot variation in
-            the energy spread, this is a 2D array of dimension nP by m
-            (slow to fast) of the spreads of the corresponding
-            wavelength in incident_wavelength.
-        </doc>
-    </field>
-    <field name="incident_energy_weights" type="NX_NUMBER" units="NX_ENERGY">
-        <doc>
-            In the case of a polychromatic beam this is an array of length m of the relative
-            weights of the corresponding energies in incident_energy. In the case of a
-            polychromatic beam that varies shot-to-shot, this is a 2D array of dimensions np
-            by m (slow to fast) of the relative weights of the corresponding energies in
-            incident_energy.
-        </doc>
-    </field>
     <field name="final_energy" type="NX_FLOAT" units="NX_ENERGY">
         <doc>Energy carried by each particle of the beam on leaving the beamline component</doc>
         <dimensions rank="1">
@@ -208,59 +174,18 @@
         </dimensions>
     </field>
     <field name="incident_polarization" type="NX_NUMBER" units="NX_ANY">
-        <doc>
-            Incident polarization as a Stokes vector
-            on entering beamline component
-        </doc>
+        <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">
-        <doc>
-            Polarization as Stokes vector on leaving beamline component
-        </doc>
+        <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>
@@ -320,66 +245,6 @@
             <dim index="1" value="nP"/>
         </dimensions>
     </field>
-    <field name="pulse_energy" type="NX_FLOAT" units="NX_ENERGY">
-        <doc>
-            Energy of a single pulse at the diagnostic point
-        </doc>
-    </field>
-    <field name="average_power" type="NX_FLOAT" units="NX_POWER">
-        <doc>
-            Average power at the diagnostic point
-        </doc>
-    </field>
-    <field name="fluence" type="NX_FLOAT" units="NX_ANY">
-        <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>
-            FWHM duration of the pulses at the diagnostic point
-        </doc>
-    </field>
-    <field name="frog_trace" type="NX_FLOAT">
-        <doc>
-            FROG trace of the pulse.
-        </doc>
-        <dimensions rank="2">
-            <dim index="1" value="nx"/>
-            <dim index="2" value="ny"/>
-        </dimensions>
-    </field>
-    <field name="frog_delays" type="NX_FLOAT" units="NX_TIME">
-        <doc>
-            Horizontal axis of a FROG trace, i.e. delay.
-        </doc>
-        <dimensions rank="1">
-            <dim index="1" value="nx"/>
-        </dimensions>
-    </field>
-    <field name="frog_frequencies" type="NX_FLOAT" units="NX_FREQUENCY">
-        <doc>
-            Vertical axis of a FROG trace, i.e. frequency.
-        </doc>
-        <dimensions rank="1">
-            <dim index="1" value="ny"/>
-        </dimensions>
-    </field>
-    <field name="chirp_type" type="NX_CHAR">
-        <doc>
-            The type of chirp implemented
-        </doc>
-    </field>
-    <field name="chirp_GDD" type="NX_FLOAT" units="NX_TIME">
-        <doc>
-            Group delay dispersion of the pulse for linear chirp
-        </doc>
-    </field>
     <group type="NXdata">
         <doc>
             Distribution of beam with respect to relevant variable e.g. wavelength. This is mainly

diff --git a/base_classes/NXinstrument.nxdl.xml b/base_classes/NXinstrument.nxdl.xml
@@ -42,31 +42,6 @@
 	        <doc>short name for instrument, perhaps the acronym</doc>
 	    </attribute>
 	</field>
-    <field name="energy_resolution" type="NX_FLOAT" units="NX_ENERGY">
-         <doc>
-              Energy resolution of the experiment (FWHM or gaussian broadening)
-         </doc>
-     </field>
-     <field name="momentum_resolution" type="NX_FLOAT" units="NX_WAVENUMBER">
-         <doc>
-              Momentum resolution of the experiment (FWHM)
-         </doc>
-     </field>
-     <field name="angular_resolution" type="NX_FLOAT" units="NX_ANGLE">
-         <doc>
-              Angular resolution of the experiment (FWHM)
-         </doc>
-     </field>
-     <field name="spatial_resolution" type="NX_FLOAT" units="NX_LENGTH">
-         <doc>
-              Spatial resolution of the experiment (Airy disk radius)
-         </doc>
-     </field>
-     <field name="temporal_resolution" type="NX_FLOAT" units="NX_TIME">
-         <doc>
-              Temporal resolution of the experiment (FWHM)
-         </doc>
-     </field>
     <group type="NXaperture" />
     <group type="NXattenuator" />
     <group type="NXbeam" />

diff --git a/base_classes/NXprocess.nxdl.xml b/base_classes/NXprocess.nxdl.xml
@@ -43,21 +43,6 @@
     <field name="date" type="NX_DATE_TIME">
         <doc>Date and time of processing.</doc>
     </field>
-    <group type="NXregistration">
-         <doc>
-              Describes the operations of image registration
-         </doc>
-     </group>
-     <group type="NXdistortion">
-         <doc>
-              Describes the operations of image distortion correction
-         </doc>
-     </group>
-     <group type="NXcalibration">
-         <doc>
-              Describes the operations of calibration procedures, e.g. axis calibrations.
-         </doc>
-     </group>
     <group type="NXnote">
         <doc>
             The note will contain information about how the data was processed

diff --git a/contributed_definitions/NXcollectioncolumn.nxdl.xml b/contributed_definitions/NXcollectioncolumn.nxdl.xml
@@ -8,7 +8,7 @@
 # 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
-# version 2 of the License, or (at your option) any later version.
+# version 3 of the License, or (at your option) any later version.
 #
 # This library is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -21,10 +21,10 @@
 #
 # For further information, see http://www.nexusformat.org
 -->
-<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" name="NXcollectioncolumn" extends="NXobject" type="group" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
+<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="base" type="group" name="NXcollectioncolumn" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
     <doc>
-        Subclass of NXelectronanalyser to describe the electron collection
-        column of a photoelectron analyser.
+         Subclass of NXelectronanalyser to describe the electron collection
+         column of a photoelectron analyser.
     </doc>
     <field name="scheme" type="NX_CHAR">
         <doc>

diff --git a/contributed_definitions/NXmpes.nxdl.xml b/contributed_definitions/NXmpes.nxdl.xml
@@ -8,7 +8,7 @@
 # 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
-# version 2 of the License, or (at your option) any later version.
+# version 3 of the License, or (at your option) any later version.
 #
 # This library is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -21,10 +21,10 @@
 #
 # For further information, see http://www.nexusformat.org
 -->
-<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="application" name="NXmpes" extends="NXobject" type="group" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
+<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="application" type="group" name="NXmpes" extends="NXobject" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
     <doc>
-        This is the most general application definition for multidimensional
-        photoelectron spectroscopy.
+         This is the most general application definition for multidimensional
+         photoelectron spectroscopy.
     </doc>
     <group type="NXentry">
         <field name="title"/>
@@ -303,8 +303,8 @@
             <field name="atom_types" recommended="true">
                 <doc>
                      List of comma-separated elements from the periodic table
-                     that are contained in the sample. 
-                     If the sample substance has multiple components, all 
+                     that are contained in the sample.
+                     If the sample substance has multiple components, all
                      elements from each component must be included in `atom_types`.
                 </doc>
             </field>