Merge pull request #104 from zhujun98/reset_unmatched_empty_image_mask

Reset the image mask in case of different shapes if it is empty

Author: zhujun98

extra_foam/gui/image_tool/tests/test_image_tool.py

@@ -330,10 +330,15 @@ def testDrawMask(self):
         np.testing.assert_array_equal(mask_gt, proc._image_mask)
 
         # test set a mask which has a different shape from the image
-        mask_gt = np.zeros((2, 2), dtype=np.bool)
+        mask_gt = np.ones((2, 2), dtype=np.bool)
         pub.set(mask_gt)
         with self.assertRaises(ImageProcessingError):
             proc.process(data)
+        # an empty image mask with a different shape will be automatically reset
+        mask_gt = np.zeros((2, 2), dtype=np.bool)
+        pub.set(mask_gt)
+        proc.process(data)
+        np.testing.assert_array_equal(np.zeros((10, 10), dtype=np.bool), proc._image_mask)
 
     def testBulletinView(self):
         processed = ProcessedData(1357)

extra_foam/pipeline/processors/image_processor.py

@@ -193,16 +193,20 @@ def _record_dark(self, assembled):
     def _update_image_mask(self, image_shape):
         image_mask = self._mask_sub.update(self._image_mask, image_shape)
         if image_mask is not None and image_mask.shape != image_shape:
-            # This could only happen when the mask is loaded from the files
-            # and the image shapes in the ImageTool is different from the
-            # shape of the live images.
-            # The original image mask remains the same.
-            raise ImageProcessingError(
-                f"[Image processor] The shape of the image mask "
-                f"{image_mask.shape} is different from the shape of the image "
-                f"{image_shape}!")
+            if np.sum(image_mask) == 0:
+                # reset the empty image mask automatically
+                image_mask = None
+            else:
+                # This could only happen when the mask is loaded from the files
+                # and the image shapes in the ImageTool is different from the
+                # shape of the live images.
+                # The original image mask remains the same.
+                raise ImageProcessingError(
+                    f"[Image processor] The shape of the image mask "
+                    f"{image_mask.shape} is different from the shape of the image "
+                    f"{image_shape}!")
 
-        elif image_mask is None:
+        if image_mask is None:
             image_mask = np.zeros(image_shape, dtype=np.bool)
 
         self._image_mask = image_mask