[python-dtcwt] 354/497: add biort/qshift documentation to Transform2d

[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 7d94b40281d5dd5897a0e1d6554d0bd9c5f773b5
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date:   Fri Feb 7 14:43:03 2014 +0000

    add biort/qshift documentation to Transform2d
---
 dtcwt/numpy/transform2d.py  | 6 ++++++
 dtcwt/opencl/transform2d.py | 6 ++++++
 2 files changed, 12 insertions(+)

diff --git a/dtcwt/numpy/transform2d.py b/dtcwt/numpy/transform2d.py
index bd29ec4..8ff2fec 100644
--- a/dtcwt/numpy/transform2d.py
+++ b/dtcwt/numpy/transform2d.py
@@ -46,6 +46,12 @@ class Transform2d(object):
     wavelets which parameterise the transform. Valid values are documented in
     :py:func:`dtcwt.dtwavexfm2`.
 
+    If *biort* or *qshift* are strings, they are used as an argument to the
+    :py:func:`dtcwt.coeffs.biort` or :py:func:`dtcwt.coeffs.qshift` functions.
+    Otherwise, they are interpreted as tuples of vectors giving filter
+    coefficients. In the *biort* case, this should be (h0o, g0o, h1o, g1o). In
+    the *qshift* case, this should be (h0a, h0b, g0a, g0b, h1a, h1b, g1a, g1b).
+
     """
     def __init__(self, biort=DEFAULT_BIORT, qshift=DEFAULT_QSHIFT):
         # Load bi-orthogonal wavelets
diff --git a/dtcwt/opencl/transform2d.py b/dtcwt/opencl/transform2d.py
index b4fdff4..e63d6ae 100644
--- a/dtcwt/opencl/transform2d.py
+++ b/dtcwt/opencl/transform2d.py
@@ -95,6 +95,12 @@ class Transform2d(Transform2dNumPy):
     OpenCL kernels which implement the transform. If it is *None*, the first
     available compute device is used.
 
+    If *biort* or *qshift* are strings, they are used as an argument to the
+    :py:func:`dtcwt.coeffs.biort` or :py:func:`dtcwt.coeffs.qshift` functions.
+    Otherwise, they are interpreted as tuples of vectors giving filter
+    coefficients. In the *biort* case, this should be (h0o, g0o, h1o, g1o). In
+    the *qshift* case, this should be (h0a, h0b, g0a, g0b, h1a, h1b, g1a, g1b).
+
     .. note::
         
         At the moment *only* the **forward** transform is accelerated. The

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