From 288ee694834ee20c4b750085a40ef598fe807e2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jostein=20B=C3=B8=20Fl=C3=B8ystad?= Date: Sat, 13 Jul 2013 19:50:20 +0200 Subject: [PATCH] radon: Correct docstring of order_angles_golden_ratio. --- skimage/transform/radon_transform.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/skimage/transform/radon_transform.py b/skimage/transform/radon_transform.py index da01d1b4..6ae6e1b9 100644 --- a/skimage/transform/radon_transform.py +++ b/skimage/transform/radon_transform.py @@ -269,9 +269,11 @@ def order_angles_golden_ratio(theta): Returns ------- - indices : 1D array of unsigned integers - Indices into ``theta`` such that ``theta[indices]`` gives the - approximate golden ratio ordering of the projections. + indices_generator : generator yielding unsigned integers + The returned generator yields indices into ``theta`` such that + ``theta[indices]`` gives the approximate golden ratio ordering + of the projections. In total, ``len(theta)`` indices are yielded. + All non-negative integers < ``len(theta)`` are yielded exactly once. Notes -----