From 156b484bc2150cfe6089a1658cbff08a7682274a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= <hannesschoenberger@gmail.com>
Date: Mon, 27 Aug 2012 18:49:14 +0200
Subject: [PATCH] Refactor clear_border for better performance

---
 skimage/morphology/_clear_border.py           | 47 ++++++++++++-------
 skimage/morphology/tests/test_clear_border.py |  4 +-
 2 files changed, 33 insertions(+), 18 deletions(-)

diff --git a/skimage/morphology/_clear_border.py b/skimage/morphology/_clear_border.py
index 4185b0d9..47de7e49 100644
--- a/skimage/morphology/_clear_border.py
+++ b/skimage/morphology/_clear_border.py
@@ -1,6 +1,5 @@
 import numpy as np
-from skimage.measure import regionprops
-from skimage.morphology import label
+from scipy.ndimage import label
 
 
 def clear_border(image, buffer_size=0, bgval=0):
@@ -11,26 +10,42 @@ def clear_border(image, buffer_size=0, bgval=0):
     Parameters
     ----------
     image : (N, M) array
-        binary image
+        Binary image.
     buffer_size : int, optional
-        define additional buffer around image border
+        Define additional buffer around image border.
     bgval : float or int, optional
-        value for cleared objects
+        Value for cleared objects.
 
     Returns
     -------
     image : (N, M) array
-        cleared binary image
+        Cleared binary image.
+
     """
+
     rows, cols = image.shape
-    for prop in regionprops(label(image), ['BoundingBox', 'Image']):
-        minr, minc, maxr, maxc = prop['BoundingBox']
-        if (
-            minr <= buffer_size
-            or minc <= buffer_size
-            or maxr >= rows - buffer_size
-            or maxc >= cols - buffer_size
-        ):
-            r, c = np.nonzero(prop['Image'])
-            image[minr + r, minc + c] = bgval
+    if buffer_size >= rows or buffer_size >= cols:
+        raise ValueError("buffer size may not be greater than image size")
+
+    # create borders with buffer_size
+    borders = np.zeros_like(image, np.bool_)
+    ext = buffer_size + 1
+    borders[:ext] = True
+    borders[- ext:] = True
+    borders[:, :ext] = True
+    borders[:, - ext:] = True
+
+    labels, number = label(image)
+
+    # determine all objects that are connected to borders
+    borders_indices = np.unique(labels[borders])
+    indices = np.arange(number + 1)
+    # mask all label indices that are connected to borders
+    label_mask = np.in1d(indices, borders_indices)
+    # create mask for pixels to clear
+    mask = label_mask[labels.ravel()].reshape(labels.shape)
+
+    # clear border pixels
+    image[mask] = bgval
+
     return image
diff --git a/skimage/morphology/tests/test_clear_border.py b/skimage/morphology/tests/test_clear_border.py
index c4cdd4af..6d1cf562 100644
--- a/skimage/morphology/tests/test_clear_border.py
+++ b/skimage/morphology/tests/test_clear_border.py
@@ -3,7 +3,7 @@ from numpy.testing import assert_array_equal, assert_equal
 from skimage.morphology import clear_border
 
 
-def test_possible_hull():
+def test_clear_border():
     image = np.array(
         [[0, 0, 0, 0, 0, 0, 0, 1, 0],
          [0, 0, 0, 0, 1, 0, 0, 0, 0],
@@ -25,7 +25,7 @@ def test_possible_hull():
 
     # test background value
     result = clear_border(image.copy(), 1, 2)
-    assert_array_equal(result, 2 * image)
+    assert_array_equal(result, 2 * np.ones_like(image))
 
 
 if __name__ == "__main__":