[python-dtcwt] 305/497: plotting: flesh out docs for overlay_quiver_DTCWT

[Ghislain Vaillant]

This is an automated email from the git hooks/post-receive script.

ghisvail-guest pushed a commit to branch debian/sid
in repository python-dtcwt.

commit 36c0d24bd991708860695e1bbaf00f07819f4a1f
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date:   Fri Jan 31 15:59:40 2014 +0000

    plotting: flesh out docs for overlay_quiver_DTCWT
---
 dtcwt/plotting.py | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/dtcwt/plotting.py b/dtcwt/plotting.py
index ad97c51..d7c8c6a 100644
--- a/dtcwt/plotting.py
+++ b/dtcwt/plotting.py
@@ -26,10 +26,20 @@ __all__ = (
 
 def overlay_quiver_DTCWT(image, vectorField, level, offset):
     """Overlays nicely coloured quiver plot of complex coefficients over original full-size image,
-    providing a useful phase visualisation. vectorField is a single [MxNx6] numpy array of DTCWT 
-    coefficients, level specifies the transform level of vectorField. Offset for DTCWT coefficients
-    is typically 0.5. Should also work with other types of complex arrays (e.g., SLP coefficients),
-    as long as the format is the same.
+    providing a useful phase visualisation.
+
+    :param vectorField: a single [MxNx6] numpy array of DTCWT coefficients
+    :param level: the transform level (1-indexed) of *vectorField*.
+    :param offset: Offset for DTCWT coefficients (typically 0.5)
+
+    .. note::
+
+        The *level* parameter is 1-indexed meaning that the third level has
+        index "3". This is unusual in Python but is kept for compatibility
+        with similar MATLAB routines.
+
+    Should also work with other types of complex arrays (e.g., SLP
+    coefficients), as long as the format is the same.
 
     Usage example:
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/python-dtcwt.git