From ed21622cafd60a744f287f339745d75dd9480595 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Sun, 7 Jul 2013 18:32:18 +0200 Subject: [PATCH] Use consistent description of output image --- skimage/filter/rank/bilateral.py | 8 ++++---- skimage/filter/rank/generic.py | 32 +++++++++++++++---------------- skimage/filter/rank/percentile.py | 32 +++++++++++++++---------------- 3 files changed, 36 insertions(+), 36 deletions(-) diff --git a/skimage/filter/rank/bilateral.py b/skimage/filter/rank/bilateral.py index 6e11d6e5..560bc68c 100644 --- a/skimage/filter/rank/bilateral.py +++ b/skimage/filter/rank/bilateral.py @@ -76,8 +76,8 @@ def bilateral_mean(image, selem, out=None, mask=None, shift_x=False, Returns ------- - out : ndarray (same dtype as input) - The result of the local bilateral mean. + out : ndarray (same dtype as input image) + Output image. See also -------- @@ -126,8 +126,8 @@ def bilateral_pop(image, selem, out=None, mask=None, shift_x=False, Returns ------- - out : ndarray (same dtype as input) - the local number of pixels inside the bilateral neighborhood + out : ndarray (same dtype as input image) + Output image. Examples -------- diff --git a/skimage/filter/rank/generic.py b/skimage/filter/rank/generic.py index f22dcc4c..595a55ee 100644 --- a/skimage/filter/rank/generic.py +++ b/skimage/filter/rank/generic.py @@ -94,7 +94,7 @@ def autolevel(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - The result of the local autolevel. + Output image. Examples -------- @@ -164,7 +164,7 @@ def equalize(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - The result of the local equalize. + Output image. Examples -------- @@ -206,7 +206,7 @@ def gradient(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - The local gradient. + Output image. """ @@ -237,7 +237,7 @@ def maximum(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - The local maximum. + Output image. See also -------- @@ -276,7 +276,7 @@ def mean(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - The local mean. + Output image. Examples -------- @@ -317,7 +317,7 @@ def subtract_mean(image, selem, out=None, mask=None, shift_x=False, Returns ------- out : ndarray (same dtype as input image) - The result of the local mean subtraction. + Output image. """ @@ -347,7 +347,7 @@ def median(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - The local median. + Output image. Examples -------- @@ -387,7 +387,7 @@ def minimum(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - The local minimum. + Output image. See also -------- @@ -426,7 +426,7 @@ def modal(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - The local modal. + Output image. """ @@ -457,7 +457,7 @@ def enhance_contrast(image, selem, out=None, mask=None, shift_x=False, structuring element). Returns - ------- + Output image. out : ndarray (same dtype as input image) The result of the local enhance_contrast. @@ -500,7 +500,7 @@ def pop(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - The number of pixels belonging to the neighborhood. + Output image. Examples -------- @@ -547,7 +547,7 @@ def threshold(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - The result of the local threshold. + Output image. Examples -------- @@ -594,7 +594,7 @@ def tophat(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - The image tophat. + Output image. """ @@ -630,7 +630,7 @@ def noise_filter(image, selem, out=None, mask=None, shift_x=False, Returns ------- out : ndarray (same dtype as input image) - The image noise. + Output image. """ @@ -669,7 +669,7 @@ def entropy(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - Entropy of image. + Output image. References ---------- @@ -712,7 +712,7 @@ def otsu(image, selem, out=None, mask=None, shift_x=False, shift_y=False): Returns ------- out : ndarray (same dtype as input image) - Otsu's threshold values. + Output image. References ---------- diff --git a/skimage/filter/rank/percentile.py b/skimage/filter/rank/percentile.py index 73929b0a..b01d314d 100644 --- a/skimage/filter/rank/percentile.py +++ b/skimage/filter/rank/percentile.py @@ -71,8 +71,8 @@ def percentile_autolevel(image, selem, out=None, mask=None, shift_x=False, Returns ------- - local autolevel : ndarray (same dtype as input) - The result of the local autolevel. + out : ndarray (same dtype as input image) + Output image. """ @@ -109,8 +109,8 @@ def percentile_gradient(image, selem, out=None, mask=None, shift_x=False, Returns ------- - local percentile_gradient : ndarray (same dtype as input) - The result of the local percentile_gradient. + out : ndarray (same dtype as input image) + Output image. """ @@ -147,8 +147,8 @@ def percentile_mean(image, selem, out=None, mask=None, shift_x=False, Returns ------- - local mean : ndarray (same dtype as input) - The result of the local mean. + out : ndarray (same dtype as input image) + Output image. """ @@ -185,8 +185,8 @@ def percentile_subtract_mean(image, selem, out=None, mask=None, Returns ------- - local subtract_mean : ndarray (same dtype as input) - The result of the local subtract_mean. + out : ndarray (same dtype as input image) + Output image. """ @@ -223,8 +223,8 @@ def percentile_enhance_contrast(image, selem, out=None, mask=None, Returns ------- - local enhance_contrast : ndarray (same dtype as input) - The result of the local enhance_contrast. + out : ndarray (same dtype as input image) + Output image. """ @@ -260,8 +260,8 @@ def percentile(image, selem, out=None, mask=None, shift_x=False, shift_y=False, Returns ------- - local percentile : ndarray (same dtype as input) - The result of the local percentile. + out : ndarray (same dtype as input image) + Output image. """ @@ -298,8 +298,8 @@ def percentile_pop(image, selem, out=None, mask=None, shift_x=False, Returns ------- - local pop : ndarray (same dtype as input) - The result of the local pop. + out : ndarray (same dtype as input image) + Output image. """ @@ -335,8 +335,8 @@ def percentile_threshold(image, selem, out=None, mask=None, shift_x=False, p0 : float in [0, ..., 1] Set the percentile value. - Returns - ------- + out : ndarray (same dtype as input image) + Output image. local threshold : ndarray (same dtype as input) The result of the local threshold.