changes for requiredness relaxation, partial names, temperature_env o…

contributed_definitions/NXellipsometry.nxdl.xml

@@ -24,20 +24,19 @@
 <!--
 04/2024
 A rework of the draft version(06/2022) of a NeXus application definition for ellipsometry.
-
 09/2024
 TODO (Workshop output):
 - Better categorization of ellipsoeter types:
-    Seperate in spectral range and measurement types (In situ vs infrared?? This grouping does not make sense)
-    Maybe make a given special field for "spectral_range" with units of eV or nm?
+Seperate in spectral range and measurement types (In situ vs infrared?? This grouping does not make sense)
+Maybe make a given special field for "spectral_range" with units of eV or nm?
 - Add a StepScanAnalzer as measurement type (continous/rotating mode the other? Ask Chris)
 - Redefine more/higher requirements for Ellipsometry compared to NXoptical_spectroscopy: Especially incident angle and polarization.
 - Refinements for ellipsometer_type and add ellipsometer_method/mode:
-   "~ please consider renaming "ellipsometer_type" to "ellipsometer_method" or "ellipsometer_mode". Motivation: "rotating_compensator" etc. are methods of ellipsometry measurements, and some ellipsometers support multiple methods (e.g. rotating compensator, nulling etc).
-   ~ please consider to use the field "ellipsometer_type" for entries directly related to the core instrument, i.e. "imaging ellipsometer",  "standard ellipsometer" (or: "non-imaging ellipsometer"), maybe others such as "back-focal plane ellipsometer"  "
+"~ please consider renaming "ellipsometer_type" to "ellipsometer_method" or "ellipsometer_mode". Motivation: "rotating_compensator" etc. are methods of ellipsometry measurements, and some ellipsometers support multiple methods (e.g. rotating compensator, nulling etc).
+~ please consider to use the field "ellipsometer_type" for entries directly related to the core instrument, i.e. "imaging ellipsometer",  "standard ellipsometer" (or: "non-imaging ellipsometer"), maybe others such as "back-focal plane ellipsometer"  "
 - Add a clear predefined data structure, as initially proposed, but dont add any restrictions regarding dimensions
-    Make ois maybe similar to NXdata_mpes. In this way, at all FAIR assignments of the data is possible. As well use this to guide the people, to let them know, where they have to save their data. Just use NXdata is too vague. Could be easing the threshold to get into NeXus.
-    This explicitly refers to a wish to add: "exposure time, number of scans"-->
+Make ois maybe similar to NXdata_mpes. In this way, at all FAIR assignments of the data is possible. As well use this to guide the people, to let them know, where they have to save their data. Just use NXdata is too vague. Could be easing the threshold to get into NeXus.
+This explicitly refers to a wish to add: "exposure time, number of scans"-->
 <definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="application" type="group" name="NXellipsometry" extends="NXoptical_spectroscopy" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
     <symbols>
         <doc>
@@ -411,7 +410,7 @@ NXellipsometry.-->
                          deterministic manner.
                     </doc>
                 </field>
-                <attribute name="URL" optional="true">
+                <attribute name="URL" recommended="true">
                     <doc>
                          Website of the software.
                     </doc>

contributed_definitions/NXoptical_spectroscopy.nxdl.xml

@@ -81,7 +81,7 @@ TODO:
                      definition was used for this entry/data.
                 </doc>
             </attribute>
-            <attribute name="URL">
+            <attribute name="URL" recommended="true">
                 <doc>
                      URL where to find further material (documentation, examples) relevant
                      to the application definition.
@@ -311,7 +311,7 @@ TODO:
                 </field>
             </group>
             <group name="detector_TYPE" type="NXdetector" minOccurs="1" maxOccurs="unbounded">
-                <field name="detector_channel_type">
+                <field name="detector_channel_type" recommended="true">
                     <enumeration>
                         <item value="single-channel"/>
                         <item value="multichannel"/>
@@ -1003,7 +1003,7 @@ Can be used to describe a beam splitter as optical element.-->
                      A set of activities that occurred to the sample prior to/during the experiment.
                 </doc>
             </group>
-            <group name="temperature" type="NXenvironment" recommended="true">
+            <group name="temperature_env" type="NXenvironment" recommended="true">
                 <doc>
                      Sample temperature (either controlled or just measured).
                 </doc>
@@ -1025,24 +1025,6 @@ Can be used to describe a beam splitter as optical element.-->
                          sample temperature.
                     </doc>
                 </field>
-                <group name="temperature_sensor" type="NXsensor" recommended="true">
-                    <doc>
-                         Temperature sensor measuring the sample temperature.
-                         This should be a link to /entry/instrument/manipulator/temperature_sensor.
-                    </doc>
-                </group>
-                <group name="sample_heater" type="NXactuator" optional="true">
-                    <doc>
-                         Device to heat the sample.
-                         This should be a link to /entry/instrument/manipulator/sample_heater.
-                    </doc>
-                </group>
-                <group name="sample_cooler" type="NXactuator" optional="true">
-                    <doc>
-                         Device for cooling the sample (Cryostat, Airflow cooler, etc.).
-                         This should be a link to /entry/instrument/manipulator/cryostat.
-                    </doc>
-                </group>
             </group>
             <group type="NXenvironment" optional="true">
                 <doc>

contributed_definitions/NXraman.nxdl.xml

@@ -23,9 +23,9 @@
 -->
 <!--
 N_incident_wavelengths: |
- Number of the incident wavelen
+Number of the incident wavelen
 N_incident_beams: |
- to be done....-->
+to be done....-->
 <!--
 04/2024
 A draft version of a NeXus application definition for Raman spectroscopy.-->
@@ -38,7 +38,6 @@ TODO (Workshop output):
 - Which for more dataconverters: Output from usualy Raman setups to neXus format?
 - Spot size description?
 - Descroption of defocusing / maybe as well as experiment_type?
-
 Wishes for NXraman or general next workshop:
 "convert excisting data to NeXus"
 "dictionary lookup keywords/fields in existing formats"(?)
@@ -78,7 +77,7 @@ dataset examples (i.e. NXdata_raman)-->
         <symbol name="N_scattering_configurations">
             <doc>
                 Number of scattering configurations used in the measurement.
-                It is 1 for only parallel polarization meausement, 2 for parallel and cross 
+                It is 1 for only parallel polarization meausement, 2 for parallel and cross
                 polarization measurement or larger, if i.e. the incident and scattered photon
                 direction is varied.
             </doc>
@@ -159,7 +158,7 @@ dataset examples (i.e. NXdata_raman)-->
                     definition was used for this entry/data.
                 </doc>
             </attribute>
-            <attribute name="URL">
+            <attribute name="URL" recommended="true">
                 <doc>
                     URL where to find further material (documentation, examples) relevant
                     to the application definition.
@@ -199,7 +198,7 @@ dataset examples (i.e. NXdata_raman)-->
                 <item value="other"/>
             </enumeration>
         </field>
-        <!--     enumeration: [in situ, resonant, non-resonant, imaging, tip-enhanced (TERS), surface-enhanced (SERS), surface plasmon polariton enhanced (SPPERS), hyper Raman spectroscopy (HRS), stimulated (SRS), inverse (IRS), coherent anti-Stokes (CARS), other]-->
+        <!--enumeration: [in situ, resonant, non-resonant, imaging, tip-enhanced (TERS), surface-enhanced (SERS), surface plasmon polariton enhanced (SPPERS), hyper Raman spectroscopy (HRS), stimulated (SRS), inverse (IRS), coherent anti-Stokes (CARS), other]-->
         <field name="raman_experiment_type_other" optional="true">
             <doc>
                 If the raman_experiment_type is `other`, a name should be specified here.

contributed_definitions/nyaml/NXellipsometry.yaml

@@ -294,7 +294,7 @@ NXellipsometry(NXoptical_spectroscopy):
             such a way that result files can be created ideally in a
             deterministic manner.
         \@URL:
-          exists: optional
+          exists: recommended
           doc: |
             Website of the software.
 

contributed_definitions/nyaml/NXoptical_spectroscopy.yaml

@@ -49,6 +49,7 @@ NXoptical_spectroscopy(NXobject):
           Version number to identify which definition of this application
           definition was used for this entry/data.
       \@URL:
+        exists: recommended
         doc: |
           URL where to find further material (documentation, examples) relevant
           to the application definition.
@@ -239,6 +240,7 @@ NXoptical_spectroscopy(NXobject):
       detector_TYPE(NXdetector):
         exists: ['min', '1', 'max', 'unbounded']
         detector_channel_type:
+          exists: recommended
           enumeration: [single-channel, multichannel]
         detector_type:
           exists: recommended
@@ -780,7 +782,7 @@ NXoptical_spectroscopy(NXobject):
         exists: recommended
         doc: |
           A set of activities that occurred to the sample prior to/during the experiment.
-      temperature(NXenvironment):
+      temperature_env(NXenvironment):
         exists: recommended
         doc: |
           Sample temperature (either controlled or just measured).
@@ -796,21 +798,6 @@ NXoptical_spectroscopy(NXobject):
           doc: |
             If temperature_nominal is "other", enter here a nominal/assumed/estimated
             sample temperature.
-        temperature_sensor(NXsensor):
-          exists: recommended
-          doc: |
-            Temperature sensor measuring the sample temperature.
-            This should be a link to /entry/instrument/manipulator/temperature_sensor.
-        sample_heater(NXactuator):
-          exists: optional
-          doc: |
-            Device to heat the sample.
-            This should be a link to /entry/instrument/manipulator/sample_heater.
-        sample_cooler(NXactuator):
-          exists: optional
-          doc: |
-            Device for cooling the sample (Cryostat, Airflow cooler, etc.).
-            This should be a link to /entry/instrument/manipulator/cryostat.
       (NXenvironment):
         exists: optional
         doc: |

contributed_definitions/nyaml/NXraman.yaml

@@ -117,6 +117,7 @@ NXraman(NXoptical_spectroscopy):
           Version number to identify which definition of this application
           definition was used for this entry/data.
       \@URL:
+        exists: recommended
         doc: |
           URL where to find further material (documentation, examples) relevant
           to the application definition.