From 933e2c77f3affc4043b78f430e01c8c01c1f86c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jostein=20B=C3=B8=20Fl=C3=B8ystad?= Date: Mon, 8 Jul 2013 11:52:06 +0200 Subject: [PATCH] unwrap: Add unfinished docstrings. Conflicts: skimage/exposure/unwrap.py --- skimage/exposure/unwrap.py | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/skimage/exposure/unwrap.py b/skimage/exposure/unwrap.py index b5f32fed..76dc3dbe 100644 --- a/skimage/exposure/unwrap.py +++ b/skimage/exposure/unwrap.py @@ -5,10 +5,21 @@ import _unwrap_3d def unwrap(wrapped_array, - wrap_around_axis_0 = False, - wrap_around_axis_1 = False, - wrap_around_axis_2 = False): + wrap_around_axis_0=False, + wrap_around_axis_1=False, + wrap_around_axis_2=False): + '''From ``image``, wrapped to lie in the interval [-pi, pi), recover the + original, unwrapped image. + Parameters + ---------- + image : 2D or 3D ndarray, optionally a masked array + wrap_around : bool or sequence of bool + + Returns + ------- + image_unwrapped : array_like + ''' wrapped_array = np.require(wrapped_array, np.float32, ['C']) if wrapped_array.ndim not in [2,3]: raise ValueError('input array needs to have 2 or 3 dimensions')