NXdetector/NXmx: Add countrate_correction_lookup_table

nexusformat · Feb 3, 2022 · 2ac8c51 · 2ac8c51
1 parent 493adbe
commit 2ac8c51
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 4 deletions.
diff --git a/applications/NXmx.nxdl.xml b/applications/NXmx.nxdl.xml
@@ -622,14 +622,33 @@
 							<dim index="2" value="j" />
 						</dimensions>
 					</field>
+
 					<field name="countrate_correction_applied" type="NX_BOOLEAN"
 						minOccurs="0">
 						<doc>
-							True when a count-rate correction has already been applied in
-							the data recorded here, false otherwise.
+							Counting detectors usually are not able to measure all
+							incoming particles, especially at higher count-rates.
+							Count-rate correction is applied to account for these errors.
+
+							True when count-rate correction has been applied, false
+							otherwise.
 						</doc>
 					</field>
 
+					<field name="countrate_correction_lookup_table" type="NX_NUMBER" >
+						<doc>
+							The countrate_correction_lookup_table defines the LUT used
+							for count-rate correction. It maps a measured count :math:`c`
+							to its corrected value
+							:math:`countrate\_correction\_lookup\_table[c]`.
+
+							:math:`m` denotes the length of the table.
+						</doc>
+						<dimensions rank="1">
+							<dim index="1" value="m"/>
+						</dimensions>
+					</field>
+
 					<field name="bit_depth_readout" type="NX_INT" recommended="true">
 						<doc>
 							How many bits the electronics record per pixel.

diff --git a/base_classes/NXdetector.nxdl.xml b/base_classes/NXdetector.nxdl.xml
@@ -648,9 +648,24 @@
   </field>
   <field name="countrate_correction_applied" type="NX_BOOLEAN" >
     <doc>
-      True when a count-rate correction has already been applied in the
-      electronics, false otherwise.
+      Counting detectors usually are not able to measure all incoming particles,
+      especially at higher count-rates. Count-rate correction is applied to
+      account for these errors.
+
+      True when count-rate correction has been applied, false otherwise.
+    </doc>
+  </field>
+  <field name="countrate_correction_lookup_table" type="NX_NUMBER" >
+    <doc>
+      The countrate_correction_lookup_table defines the LUT used for count-rate
+      correction. It maps a measured count :math:`c` to its corrected value
+      :math:`countrate\_correction\_lookup\_table[c]`.
+
+      :math:`m` denotes the length of the table.
     </doc>
+    <dimensions rank="1">
+      <dim index="1" value="m"/>
+    </dimensions>
   </field>
   <field name="bit_depth_readout" type="NX_INT">
     <doc>