From bd2f8ac3d3c7c5413bb9f01724a536d0ab92af8b Mon Sep 17 00:00:00 2001 From: Tony S Yu Date: Mon, 3 Sep 2012 22:36:11 -0400 Subject: [PATCH] DOC: Add note about expanded masking --- skimage/filter/edges.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/skimage/filter/edges.py b/skimage/filter/edges.py index cd91effb..ac27802f 100644 --- a/skimage/filter/edges.py +++ b/skimage/filter/edges.py @@ -22,6 +22,8 @@ def sobel(image, mask=None): Image to process. mask : array_like, dtype=bool, optional An optional mask to limit the application to a certain area. + Note that pixels surrounding masked regions are also masked to + prevent masked regions from affecting the result. Returns ------- @@ -49,6 +51,8 @@ def hsobel(image, mask=None): Image to process. mask : array_like, dtype=bool, optional An optional mask to limit the application to a certain area. + Note that pixels surrounding masked regions are also masked to + prevent masked regions from affecting the result. Returns ------- @@ -88,6 +92,8 @@ def vsobel(image, mask=None): Image to process mask : array_like, dtype=bool, optional An optional mask to limit the application to a certain area + Note that pixels surrounding masked regions are also masked to + prevent masked regions from affecting the result. Returns ------- @@ -127,6 +133,8 @@ def prewitt(image, mask=None): Image to process. mask : array_like, dtype=bool, optional An optional mask to limit the application to a certain area. + Note that pixels surrounding masked regions are also masked to + prevent masked regions from affecting the result. Returns ------- @@ -150,6 +158,8 @@ def hprewitt(image, mask=None): Image to process. mask : array_like, dtype=bool, optional An optional mask to limit the application to a certain area. + Note that pixels surrounding masked regions are also masked to + prevent masked regions from affecting the result. Returns ------- @@ -189,6 +199,8 @@ def vprewitt(image, mask=None): Image to process. mask : array_like, dtype=bool, optional An optional mask to limit the application to a certain area. + Note that pixels surrounding masked regions are also masked to + prevent masked regions from affecting the result. Returns -------