Bring in additional fields from NXdetector into NXchannel

nexusformat · Jun 19, 2023 · 146a96a · 146a96a
1 parent 65b8c8e
commit 146a96a
Showing 1 changed file with 52 additions and 0 deletions.
diff --git a/base_classes/NXdetector_channel.nxdl.xml b/base_classes/NXdetector_channel.nxdl.xml
@@ -83,6 +83,13 @@
     <doc>Energy at which a photon will be recorded</doc>
   </field>
 
+  <field name="flatfield_applied" type="NX_BOOLEAN" >
+    <doc>
+      True when the flat field correction has been applied in the
+      electronics, false otherwise.
+    </doc>
+  </field>
+
   <field name="flatfield" type="NX_NUMBER">
     <doc>Response of each pixel given a constant input</doc>
       <dimensions rank="dataRank">
@@ -92,6 +99,24 @@
       </dimensions>
   </field>
 
+  <field name="flatfield_errors" type="NX_FLOAT" >
+    <doc>
+        Errors of the flat field correction data.
+        The form flatfield_error is deprecated.
+    </doc>
+    <dimensions rank="2">
+      <dim index="1" value="i"/>
+      <dim index="2" value="j"/>
+    </dimensions>
+  </field>
+
+  <field name="pixel_mask_applied" type="NX_BOOLEAN" >
+    <doc>
+      True when the pixel mask correction has been applied in the
+      electronics, false otherwise.
+    </doc>
+  </field>
+
   <field name="pixel_mask" type="NX_INT">
     <doc>
       Custom pixel mask for this channel. May include nP as the first dimension for
@@ -103,4 +128,31 @@
           <dim index="4" value="k" required="false"/>
       </dimensions>
   </field>
+
+  <field name="saturation_value" type="NX_NUMBER">
+    <doc>
+      The value at which the detector goes into saturation.
+      Especially common to CCD detectors, the data
+      is known to be invalid above this value.
+
+      For example, given a saturation_value and an underload_value, the valid
+      pixels are those less than or equal to the saturation_value and greater
+      than or equal to the underload_value.
+
+      The precise type should match the type of the data.
+    </doc>
+  </field>
+
+  <field name="underload_value" type="NX_NUMBER">
+    <doc>
+      The lowest value at which pixels for this detector would be reasonably
+      measured. The data is known to be invalid below this value.
+
+      For example, given a saturation_value and an underload_value, the valid
+      pixels are those less than or equal to the saturation_value and greater
+      than or equal to the underload_value.
+
+      The precise type should match the type of the data.
+    </doc>
+  </field>
 </definition>