From c86d9196d8a631a388c39d0ab2a2e7197990106a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Sun, 9 Sep 2012 19:55:46 +0200 Subject: [PATCH] Add information about return dtype --- skimage/transform/pyramids.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/skimage/transform/pyramids.py b/skimage/transform/pyramids.py index dc35db7b..b6442bc6 100644 --- a/skimage/transform/pyramids.py +++ b/skimage/transform/pyramids.py @@ -53,7 +53,7 @@ def pyramid_reduce(image, downscale=2, sigma=None, order=1, Returns ------- out : array - Smoothed and downsampled image. + Smoothed and downsampled float image. References ---------- @@ -107,7 +107,7 @@ def pyramid_expand(image, upscale=2, sigma=None, order=1, Returns ------- out : array - Upsampled and smoothed image. + Upsampled and smoothed float image. References ---------- @@ -139,7 +139,9 @@ def build_gaussian_pyramid(image, max_layer=-1, downscale=2, sigma=None, order=1, mode='reflect', cval=0): """Yield images of the gaussian pyramid formed by the input image. - Recursively applies the `pyramid_reduce` function to the image. + Recursively applies the `pyramid_reduce` function to the image, and yields + the downscaled images. Note that the first image of the pyramid will be the + original, unscaled image. Parameters ---------- @@ -166,7 +168,7 @@ def build_gaussian_pyramid(image, max_layer=-1, downscale=2, sigma=None, Returns ------- pyramid : generator - Generator yielding pyramid layers. + Generator yielding pyramid layers as float images. References ---------- @@ -239,7 +241,7 @@ def build_laplacian_pyramid(image, max_layer=-1, downscale=2, sigma=None, Returns ------- pyramid : generator - Generator yielding pyramid layers. + Generator yielding pyramid layers as float images. References ----------