From c8bf2b5d9d329116427d2c22ae531a4dcdaa1464 Mon Sep 17 00:00:00 2001 From: emmanuelle Date: Sun, 23 Nov 2014 22:37:27 +0100 Subject: [PATCH 1/2] Added a short paragraph + see also section in docstring of exposure.equalize_adapthist --- skimage/exposure/_adapthist.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/skimage/exposure/_adapthist.py b/skimage/exposure/_adapthist.py index 9cfc716e..da80414d 100644 --- a/skimage/exposure/_adapthist.py +++ b/skimage/exposure/_adapthist.py @@ -28,7 +28,11 @@ NR_OF_GREY = 2**14 # number of grayscale levels to use in CLAHE algorithm @adapt_rgb(hsv_value) def equalize_adapthist(image, ntiles_x=8, ntiles_y=8, clip_limit=0.01, nbins=256): - """Contrast Limited Adaptive Histogram Equalization. + """Contrast Limited Adaptive Histogram Equalization (CLAHE). + + An algorithm for local contrast enhancement, that uses histograms computed + over different tile regions of the image. Local details can therefore be + enhanced even in regions that are darker or lighter than most of the image. Parameters ---------- @@ -49,6 +53,10 @@ def equalize_adapthist(image, ntiles_x=8, ntiles_y=8, clip_limit=0.01, out : ndarray Equalized image. + See Also + -------- + equalize_hist, rescale_intensity + Notes ----- * For color images, the following steps are performed: From 568810f6889ede48e5b9b38dcb6bec98cff526eb Mon Sep 17 00:00:00 2001 From: emmanuelle Date: Sun, 23 Nov 2014 22:40:15 +0100 Subject: [PATCH 2/2] Fixed broken link to NumPy's docstring standard. --- CONTRIBUTING.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt index 837dca2a..fcb36547 100644 --- a/CONTRIBUTING.txt +++ b/CONTRIBUTING.txt @@ -123,7 +123,8 @@ Guidelines * All code should have tests (see `test coverage`_ below for more details). * All code should be documented, to the same - `standard `_ + `standard +<://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#docstring-standard>`_ as NumPy and SciPy. * For new functionality, always add an example to the gallery.