Restructure some helper functions

src/calng/AgipdCorrection.py

@@ -98,13 +98,7 @@ class AgipdCorrection(BaseCorrection):
             .key("corrections.relGainXray.gGainValue")
             .displayedName("G_gain_value")
             .description(
-                "The booleans under this node allow for selecting a subset of bad "
-                "pixel types to take into account when doing bad pixel masking. "
-                "Upon updating these flags, the map used for bad pixel masking will "
-                "be ANDed with this selection. Therefore, if you want to toggle a "
-                "disabled flag back on, please reload constants for this to take "
-                "effect (will be triggered automatically in future version)."
-                "Modern X-ray gain correction constants are absolute. The default "
+                "Newer X-ray gain correction constants are absolute. The default "
                 "G_gain_value of 1 means that output is expected to be in keV. If "
                 "this is not desired, one can here specify the mean X-ray gain value "
                 "over all modules to get ADU values out - operator must manually "
@@ -129,9 +123,19 @@ class AgipdCorrection(BaseCorrection):
             NODE_ELEMENT(expected)
             .key("corrections.badPixels.subsetToUse")
             .displayedName("Bad pixel flags to use")
+            .description(
+                "The booleans under this node allow for selecting a subset of bad "
+                "pixel types to take into account when doing bad pixel masking. "
+                "Upon updating these flags, the map used for bad pixel masking will "
+                "be ANDed with this selection. Therefore, if you want to toggle a "
+                "disabled flag back on, please reload constants for this to take "
+                "effect (will be triggered automatically in future version)."
+            )
             .commit(),
         )
-        AgipdCorrection._managed_keys.append("corrections.relGainPc.overrideMdAdditionalOffset")
+        AgipdCorrection._managed_keys.append(
+            "corrections.relGainPc.overrideMdAdditionalOffset"
+        )
         AgipdCorrection._managed_keys.append("corrections.relGainPc.mdAdditionalOffset")
         AgipdCorrection._managed_keys.append("corrections.relGainXray.gGainValue")
         AgipdCorrection._managed_keys.append("corrections.badPixels.maskingValue")
@@ -145,7 +149,11 @@ class AgipdCorrection(BaseCorrection):
                 .reconfigurable()
                 .commit()
             )
-            AgipdCorrection._managed_keys.append(f"corrections.badPixels.subsetToUse.{field.name}")
+            AgipdCorrection._managed_keys.append(
+                f"corrections.badPixels.subsetToUse.{field.name}"
+            )
+
+        # mandatory: manager needs this in schema
         (
             VECTOR_STRING_ELEMENT(expected)
             .key("managedKeys")
@@ -347,16 +355,7 @@ class AgipdCorrection(BaseCorrection):
                 selection |= field
         self._override_bad_pixel_flags = selection
 
-    def preReconfigure(self, config):
-        super().preReconfigure(config)
-        if any(
-            path.startswith("corrections.badPixels.subsetToUse")
-            for path in config.getPaths()
-        ):
-            self._has_updated_bad_pixel_selection = False
-
     def postReconfigure(self):
-        # TODO: keep track of which things actually need updating
         super().postReconfigure()
 
         if self.get("corrections.relGainPc.overrideMdAdditionalOffset"):
@@ -369,16 +368,32 @@ class AgipdCorrection(BaseCorrection):
         else:
             self._override_md_additional_offset = None
 
-        self.gpu_runner.set_g_gain_value(self.get("corrections.relGainXray.gGainValue"))
-        self._gpu_runner_init_args["g_gain_value"] = self.get(
-            "corrections.relGainXray.gGainValue"
-        )
+        if not hasattr(self, "_prereconfigure_update_hash"):
+            return
 
-        self.bad_pixel_mask_value = eval(self.get("corrections.badPixels.maskingValue"))
-        self.gpu_runner.set_bad_pixel_mask_value(self.bad_pixel_mask_value)
-        self._gpu_runner_init_args["bad_pixel_mask_value"] = self.bad_pixel_mask_value
+        update = self._prereconfigure_update_hash
 
-        if not self._has_updated_bad_pixel_selection:
+        if update.has("corrections.relGainXray.gGainValue"):
+            self.gpu_runner.set_g_gain_value(
+                self.get("corrections.relGainXray.gGainValue")
+            )
+            self._gpu_runner_init_args["g_gain_value"] = self.get(
+                "corrections.relGainXray.gGainValue"
+            )
+
+        if update.has("corrections.badPixels.maskingValue"):
+            self.bad_pixel_mask_value = eval(
+                self.get("corrections.badPixels.maskingValue")
+            )
+            self.gpu_runner.set_bad_pixel_mask_value(self.bad_pixel_mask_value)
+            self._gpu_runner_init_args[
+                "bad_pixel_mask_value"
+            ] = self.bad_pixel_mask_value
+
+        if any(
+            path.startswith("corrections.badPixels.subsetToUse")
+            for path in update.getPaths()
+        ):
             self._update_bad_pixel_selection()
             self.gpu_runner.override_bad_pixel_flags_to_use(
                 self._override_bad_pixel_flags

src/calng/base_correction.py

@@ -410,13 +410,21 @@ class BaseCorrection(PythonDevice):
             )
 
     def preReconfigure(self, config):
-        for path in config.getPaths():
+        self._prereconfigure_update_hash = config
+
+    def postReconfigure(self):
+        if not hasattr(self, "_prereconfigure_update_hash"):
+            self.log_status_warn("postReconfigure without knowing update hash")
+            return
+
+        update = self._prereconfigure_update_hash
+        for path in update.getPaths():
             if path in self._schema_cache_fields:
-                self._schema_cache[path] = config.get(path)
+                self._schema_cache[path] = update.get(path)
 
         # TODO: pulse filter (after reimplementing)
         if any(
-            config.has(shape_param)
+            update.has(shape_param)
             for shape_param in (
                 "dataFormat.pixelsX",
                 "dataFormat.pixelsY",
@@ -424,31 +432,10 @@ class BaseCorrection(PythonDevice):
                 "constantParameters.memoryCells",
             )
         ):
-            # will make postReconfigure handle shape update after merging schema
-            self._has_updated_shapes = False
-
-    def log_status_info(self, msg):
-        self.log.INFO(msg)
-        self.set("status", msg)
-
-    def log_status_warn(self, msg):
-        self.log.WARN(msg)
-        self.set("status", msg)
-
-    def postReconfigure(self):
-        if not self._has_updated_shapes:
             self._update_shapes()
         # TODO: only call this if they are changed (is cheap, though)
         self._update_correction_flags()
 
-    def set(self, *args):
-        """Wrapper around PythonDevice.set to enable caching "hot" schema elements"""
-        if len(args) == 2:
-            key, value = args
-            if key in self._schema_cache_fields:
-                self._schema_cache[key] = value
-        super().set(*args)
-
     def loadMostRecentConstants(self):
         self.flush_constants()
         self.calcat_friend.flush_constants()
@@ -464,6 +451,27 @@ class BaseCorrection(PythonDevice):
         self.gpu_runner.flush_buffers()
         self._update_correction_flags()
 
+    def log_status_info(self, msg):
+        self.log.INFO(msg)
+        self.set("status", msg)
+
+    def log_status_warn(self, msg):
+        self.log.WARN(msg)
+        self.set("status", msg)
+
+    def log_status_error(self, msg):
+        self.set("status", msg)
+        self.log.ERROR(msg)
+        self.updateState(State.ERROR)
+
+    def set(self, *args):
+        """Wrapper around PythonDevice.set to enable caching "hot" schema elements"""
+        if len(args) == 2:
+            key, value = args
+            if key in self._schema_cache_fields:
+                self._schema_cache[key] = value
+        super().set(*args)
+
     def requestScene(self, params):
         payload = Hash()
         scene_name = params.get("name", default="")

src/tests/test_dssc_kernels.py

@@ -74,7 +74,7 @@ def test_correct_oob_cells():
 
 def test_reshape():
     kernel_runner.processed_data_gpu.set(corrected_data)
-    assert np.allclose(kernel_runner.reshape(), corrected_data.transpose())
+    assert np.allclose(kernel_runner.reshape(output_order="xyc"), corrected_data.transpose())
 
 
 def test_preview_slice():