Fix typo in doc string

This commit is contained in:
Johannes Schönberger
2013-07-25 22:35:12 +02:00
parent 1cf83b513f
commit ab4e95e4f3
+7 -7
View File
@@ -98,7 +98,7 @@ def denoise_bilateral(image, Py_ssize_t win_size=5, sigma_range=None,
"""
image = np.atleast_3d(img_as_float(image))
# if image.max() is 0, then dist_scale can have an unverified value
# and color_lut[<int>(dist * dist_scale)] may cause a segmentation fault
# so we verify we have a positive image and that the max is not 0.0.
@@ -112,7 +112,7 @@ def denoise_bilateral(image, Py_ssize_t win_size=5, sigma_range=None,
Py_ssize_t window_ext = (win_size - 1) / 2
double max_value
cnp.ndarray[dtype=cnp.double_t, ndim=3, mode='c'] cimage
cnp.ndarray[dtype=cnp.double_t, ndim=3, mode='c'] out
@@ -136,12 +136,12 @@ def denoise_bilateral(image, Py_ssize_t win_size=5, sigma_range=None,
csigma_range = sigma_range
max_value = image.max()
if max_value == 0.0:
raise ValueError("The maximum value found in the image was 0.")
cimage = np.ascontiguousarray(image)
out = np.zeros((rows, cols, dims), dtype=np.double)
image_data = <double*>cimage.data
out_data = <double*>out.data
@@ -224,8 +224,8 @@ def denoise_tv_bregman(image, double weight, int max_iter=100, double eps=1e-3,
max_iter: int, optional
Maximal number of iterations used for the optimization.
isotropic: boolean, optimal
Switch between isotropic and anisotropic tv denoising
isotropic: boolean, optional
Switch between isotropic and anisotropic TV denoising.
Returns
-------
@@ -241,7 +241,7 @@ def denoise_tv_bregman(image, double weight, int max_iter=100, double eps=1e-3,
.. [3] Pascal Getreuer, "RudinOsherFatemi Total Variation Denoising
using Split Bregman" in Image Processing On Line on 20120519,
http://www.ipol.im/pub/art/2012/g-tvd/article_lr.pdf
.. [4] http://www.math.ucsb.edu/~cgarcia/UGProjects/BregmanAlgorithms_JacquelineBush.pdf
.. [4] http://www.math.ucsb.edu/~cgarcia/UGProjects/BregmanAlgorithms_JacquelineBush.pdf
"""