mirror of
https://github.com/wassname/scikit-image.git
synced 2026-07-08 21:51:03 +08:00
Merge pull request #1230 from emmanuelle/clahe
Update CLAHE docstring, and fix numpy docstring conventions link.
This commit is contained in:
+2
-1
@@ -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 <http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines>`_
|
||||
`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.
|
||||
|
||||
@@ -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:
|
||||
|
||||
Reference in New Issue
Block a user