Merge pull request #900 from HEXRD/parse-ims-add-group-support

Add group support when parsing imageseries

Author: psavery

hexrd/core/instrument/hedm_instrument.py

@@ -246,6 +246,7 @@ def _parse_imgser_dict(
     imgser_dict: Mapping[str, OmegaImageSeries | NDArray[np.float64]],
     det_key: str,
     roi: Optional[tuple[tuple[int, int], ...]] = None,
+    group: Optional[str] = None,
 ) -> OmegaImageSeries | ProcessedImageSeries | NDArray[np.float64]:
     """
     Associates a dict of imageseries to the target panel(s).
@@ -262,6 +263,9 @@ def _parse_imgser_dict(
         The roi of the target images.  Format is
             ((row_start, row_stop), (col_start, col_stop))
         The stops are used in the normal sense of a slice. The default is None.
+    group : str or None, optional
+        The detector group name. Used as a fallback key when `det_key` is not
+        found in `imgser_dict`. The default is None.
 
     Raises
     ------
@@ -290,6 +294,9 @@ def _parse_imgser_dict(
             img_keys: NDArray[np.str_] = np.asarray(list(imgser_dict.keys()))
             matched_det_key = img_keys[matched_det_keys][0]
             images_in = imgser_dict[matched_det_key]
+        elif group is not None and group in imgser_dict:
+            # match by detector group name
+            images_in = imgser_dict[group]
         else:
             raise RuntimeError(
                 f"neither '{det_key}' nor '{multi_ims_key}' found"
@@ -1140,7 +1147,9 @@ def extract_polar_maps(
             ptth, peta = panel.pixel_angles()
 
             # grab imageseries for this detector
-            ims = _parse_imgser_dict(imgser_dict, det_key, roi=panel.roi)
+            ims = _parse_imgser_dict(
+                imgser_dict, det_key, roi=panel.roi, group=panel.group
+            )
             assert isinstance(ims, OmegaImageSeries)
 
             # grab omegas from imageseries and squawk if missing
@@ -1321,7 +1330,9 @@ def make_instr_cfg(panel):
 
         images = []
         for detector_id, panel in self.detectors.items():
-            images.append(_parse_imgser_dict(imgser_dict, detector_id, roi=panel.roi))
+            images.append(_parse_imgser_dict(
+                imgser_dict, detector_id, roi=panel.roi, group=panel.group
+            ))
 
         panels = [self.detectors[k] for k in self.detectors]
         instr_cfgs = [make_instr_cfg(x) for x in panels]
@@ -1677,7 +1688,7 @@ def _pull_spots_check_only(
         for detector_id, panel in self.detectors.items():
             # pull out the OmegaImageSeries for this panel from input dict
             omega_image_series = _parse_imgser_dict(
-                imgser_dict, detector_id, roi=panel.roi
+                imgser_dict, detector_id, roi=panel.roi, group=panel.group
             )
             assert isinstance(omega_image_series, OmegaImageSeries)
 
@@ -1889,7 +1900,7 @@ def pull_spots(
                 npdiv,
             )
             omega_image_series = _parse_imgser_dict(
-                imgser_dict, detector_id, roi=panel.roi
+                imgser_dict, detector_id, roi=panel.roi, group=panel.group
             )
             assert isinstance(omega_image_series, OmegaImageSeries)
 

tests/core/instrument/test_parse_imgser_dict.py

@@ -0,0 +1,37 @@
+import numpy as np
+import pytest
+
+from hexrd.core.instrument.hedm_instrument import _parse_imgser_dict
+
+
+class TestParseImgserDictGroupFallback:
+    """Test that _parse_imgser_dict falls back to the group name."""
+
+    def test_group_fallback_with_ndarray(self):
+        # Image keyed by group name, not detector name
+        img = np.arange(20, dtype=np.float64).reshape(4, 5)
+        imgser_dict = {'my_group': img}
+        roi = ((1, 3), (0, 5))
+
+        result = _parse_imgser_dict(
+            imgser_dict, det_key='det_0', roi=roi, group='my_group'
+        )
+
+        expected = img[1:3, 0:5]
+        np.testing.assert_array_equal(result, expected)
+
+    def test_group_fallback_not_used_when_det_key_matches(self):
+        # Direct det_key match should take priority over group
+        img_direct = np.ones((4, 5), dtype=np.float64)
+        img_group = np.zeros((4, 5), dtype=np.float64)
+        imgser_dict = {'det_0': img_direct, 'my_group': img_group}
+
+        result = _parse_imgser_dict(imgser_dict, det_key='det_0', group='my_group')
+
+        np.testing.assert_array_equal(result, img_direct)
+
+    def test_group_none_raises_when_no_match(self):
+        imgser_dict = {'other': np.zeros((4, 5))}
+
+        with pytest.raises(RuntimeError, match="neither"):
+            _parse_imgser_dict(imgser_dict, det_key='det_0', group=None)