Raise on unsupported mode in morph. operators

lagru · lagru · commit 9bab0e46cbbf · 2023-11-01T13:52:17.000+01:00
diff --git a/skimage/morphology/binary.py b/skimage/morphology/binary.py
@@ -99,6 +99,8 @@ def binary_erosion(image, footprint=None, out=None, mode='ignore'):
     if out is None:
         out = np.empty(image.shape, dtype=bool)
 
+    if mode not in {"max", "min", "ignore"}:
+        raise ValueError(f"unsupported mode, got {mode!r}")
     border_value = False if mode == 'min' else True
 
     footprint = pad_footprint(footprint, pad_end=True)
@@ -177,6 +179,8 @@ def binary_dilation(image, footprint=None, out=None, mode='ignore'):
     if out is None:
         out = np.empty(image.shape, dtype=bool)
 
+    if mode not in {"max", "min", "ignore"}:
+        raise ValueError(f"unsupported mode, got {mode!r}")
     border_value = True if mode == 'max' else False
 
     footprint = pad_footprint(footprint, pad_end=True)
diff --git a/skimage/morphology/gray.py b/skimage/morphology/gray.py
@@ -109,6 +109,18 @@ def _min_max_to_constant_mode(dtype, mode, cval):
     return mode, cval
 
 
+_SUPPORTED_MODES = {
+    "reflect",
+    "constant",
+    "nearest",
+    "mirror",
+    "wrap",
+    "max",
+    "min",
+    "ignore",
+}
+
+
 @default_footprint
 def erosion(
     image,
@@ -203,6 +215,8 @@ def erosion(
     if out is None:
         out = np.empty_like(image)
 
+    if mode not in _SUPPORTED_MODES:
+        raise ValueError(f"unsupported mode, got {mode!r}")
     if mode == "ignore":
         mode = "max"
     mode, cval = _min_max_to_constant_mode(image.dtype, mode, cval)
@@ -312,6 +326,8 @@ def dilation(
     if out is None:
         out = np.empty_like(image)
 
+    if mode not in _SUPPORTED_MODES:
+        raise ValueError(f"unsupported mode, got {mode!r}")
     if mode == "ignore":
         mode = "min"
     mode, cval = _min_max_to_constant_mode(image.dtype, mode, cval)
diff --git a/skimage/morphology/tests/test_binary.py b/skimage/morphology/tests/test_binary.py
@@ -235,6 +235,21 @@ def test_out_argument():
 ]
 
 
+@pytest.mark.parametrize("func", binary_functions)
+@pytest.mark.parametrize("mode", ['max', 'min', 'ignore'])
+def test_supported_mode(func, mode):
+    img = np.ones((10, 10), dtype=bool)
+    func(img, mode=mode)
+
+
+@pytest.mark.parametrize("func", binary_functions)
+@pytest.mark.parametrize("mode", ["reflect", 3, None])
+def test_unsupported_mode(func, mode):
+    img = np.ones((10, 10))
+    with pytest.raises(ValueError, match="unsupported mode"):
+        func(img, mode=mode)
+
+
 @pytest.mark.parametrize("function", binary_functions)
 def test_default_footprint(function):
     footprint = morphology.diamond(radius=1)
diff --git a/skimage/morphology/tests/test_gray.py b/skimage/morphology/tests/test_gray.py
@@ -24,6 +24,16 @@ def cell3d_image():
     return np.ascontiguousarray(data.cells3d()[30:48, 0, 20:36, 20:32])
 
 
+gray_morphology_funcs = (
+    gray.erosion,
+    gray.dilation,
+    gray.opening,
+    gray.closing,
+    gray.white_tophat,
+    gray.black_tophat,
+)
+
+
 class TestMorphology:
     # These expected outputs were generated with skimage v0.22.0 + PR #6695
     # using:
@@ -34,14 +44,6 @@ class TestMorphology:
     #   np.savez_compressed('gray_morph_output.npz', **output)
 
     def _build_expected_output(self):
-        funcs = (
-            gray.erosion,
-            gray.dilation,
-            gray.opening,
-            gray.closing,
-            gray.white_tophat,
-            gray.black_tophat,
-        )
         footprints_2D = (
             footprints.square,
             footprints.diamond,
@@ -56,7 +58,7 @@ def _build_expected_output(self):
         output = {}
         for n in range(1, 4):
             for strel in footprints_2D:
-                for func in funcs:
+                for func in gray_morphology_funcs:
                     key = f'{strel.__name__}_{n}_{func.__name__}'
                     output[key] = func(image, strel(n))
 
@@ -89,6 +91,19 @@ def test_gray_opening_anti_extensive(self):
         result_ignore = gray.opening(img, footprint=footprint, mode="ignore")
         assert np.all(result_ignore <= img)
 
+    @pytest.mark.parametrize("func", gray_morphology_funcs)
+    @pytest.mark.parametrize("mode", gray._SUPPORTED_MODES)
+    def test_supported_mode(self, func, mode):
+        img = np.ones((10, 10))
+        func(img, mode=mode)
+
+    @pytest.mark.parametrize("func", gray_morphology_funcs)
+    @pytest.mark.parametrize("mode", ["", "symmetric", 3, None])
+    def test_unsupported_mode(self, func, mode):
+        img = np.ones((10, 10))
+        with pytest.raises(ValueError, match="unsupported mode"):
+            func(img, mode=mode)
+
 
 class TestEccentricStructuringElements:
     def setup_class(self):
