radon: Correct docstring of order_angles_golden_ratio.

This commit is contained in:
Jostein Bø Fløystad
2013-07-13 19:50:20 +02:00
parent 41c6f6d740
commit 288ee69483
+5 -3
View File
@@ -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
-----