From a0f7eb51cd69096d240ee104ca51702395ff17a1 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 30 May 2011 23:11:04 +0200 Subject: [PATCH] documented the input dtype in tv_denoise --- scikits/image/filter/tv_denoise.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/scikits/image/filter/tv_denoise.py b/scikits/image/filter/tv_denoise.py index 3b96f9e8..0536d57d 100644 --- a/scikits/image/filter/tv_denoise.py +++ b/scikits/image/filter/tv_denoise.py @@ -198,12 +198,14 @@ def tv_denoise(im, eps=2.e-4, weight=50, keep_type=False, n_iter_max=200): Parameters ---------- - im: ndarray (2d or 3d) - input data to be denoised + im: ndarray (2d or 3d) of ints, uints or floats + input data to be denoised. `im` can be of any numeric type, + but it is cast into an ndarray of floats for the computation + of the denoised image. eps: float, optional - relative difference of the value of the cost function that determines - the stop criterion. The algorithm stops when + relative difference of the value of the cost function that + determines the stop criterion. The algorithm stops when (E_(n-1) - E_n) < eps * E_0 weight: float, optional