From 955b1761f151c06c4e6a0c3a3e5ee3d84bee95ce Mon Sep 17 00:00:00 2001 From: Arnaud De Bruecker Date: Fri, 28 Aug 2015 19:10:09 +0100 Subject: [PATCH 1/2] Add documantation to `denoise_bilateral` for `sigma_range` closes #1630 --- skimage/restoration/_denoise.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/skimage/restoration/_denoise.py b/skimage/restoration/_denoise.py index c44ab1f1..002eb257 100644 --- a/skimage/restoration/_denoise.py +++ b/skimage/restoration/_denoise.py @@ -31,7 +31,8 @@ def denoise_bilateral(image, win_size=5, sigma_range=None, sigma_spatial=1, similarity). A larger value results in averaging of pixels with larger radiometric differences. Note, that the image will be converted using the `img_as_float` function and thus the standard deviation is in - respect to the range `[0, 1]`. + respect to the range `[0, 1]`. If the value is `None` the standard + deviation of the `image` will be used. sigma_spatial : float Standard deviation for range distance. A larger value results in averaging of pixels with larger spatial differences. From 50804d1e9b0663936f59cedfb31a74bca9c5184f Mon Sep 17 00:00:00 2001 From: Arnaud De Bruecker Date: Fri, 28 Aug 2015 19:43:14 +0100 Subject: [PATCH 2/2] Correct documentation to `denoise_bilateral` for `sigma_range` Closes #1630 --- skimage/restoration/_denoise.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skimage/restoration/_denoise.py b/skimage/restoration/_denoise.py index 002eb257..66cd854b 100644 --- a/skimage/restoration/_denoise.py +++ b/skimage/restoration/_denoise.py @@ -31,8 +31,8 @@ def denoise_bilateral(image, win_size=5, sigma_range=None, sigma_spatial=1, similarity). A larger value results in averaging of pixels with larger radiometric differences. Note, that the image will be converted using the `img_as_float` function and thus the standard deviation is in - respect to the range `[0, 1]`. If the value is `None` the standard - deviation of the `image` will be used. + respect to the range ``[0, 1]``. If the value is ``None`` the standard + deviation of the ``image`` will be used. sigma_spatial : float Standard deviation for range distance. A larger value results in averaging of pixels with larger spatial differences.