From 045f6279b441045abf7aeec5c32cda68fb2fec92 Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Sun, 5 Aug 2012 23:36:39 -0500 Subject: [PATCH] Added Notes to the docstring. --- skimage/exposure/exposure.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/skimage/exposure/exposure.py b/skimage/exposure/exposure.py index 71869915..df98da1f 100644 --- a/skimage/exposure/exposure.py +++ b/skimage/exposure/exposure.py @@ -212,6 +212,14 @@ def adapthist(image, nx=8, ny=8, clip_limit=0.01, nbins=256, out_range='full'): ------- out - np.ndarray : equalized image - may be a different shape than the original + + Notes + ----- + * The underlying algorithm relies on an image whose rows and columns are even multiples of + the number of tiles, so the extra rows and columns are left at their original values, thus + preserving the input image shape. + * For RGB or RGBA images, the algorithm is run on each channel. + * For RGBA images, the original alpha channel is removed. ''' in_type = image.dtype.type if out_range == 'full':