[python-dtcwt] 192/497: update documentation on backends
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Tue Jul 21 18:06:03 UTC 2015
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 b43b7aa1f969277f826412f23d80a6a172c1944a
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date: Mon Nov 11 18:03:43 2013 +0000
update documentation on backends
---
docs/reference.rst | 8 ++++++++
dtcwt/backend/__init__.py | 4 ++--
dtcwt/backend/backend_numpy/transform2d.py | 26 +++++++++++++++++++++++++-
dtcwt/backend/backend_opencl/lowlevel.py | 6 +++---
dtcwt/backend/backend_opencl/transform2d.py | 27 ++++++++++++++++++++++++++-
5 files changed, 64 insertions(+), 7 deletions(-)
diff --git a/docs/reference.rst b/docs/reference.rst
index 2e9d30d..d90b8db 100644
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -46,8 +46,16 @@ NumPy
.. automodule:: dtcwt.backend.backend_numpy
:members:
+.. automodule:: dtcwt.backend.backend_numpy.transform2d
+ :members:
+ :inherited-members:
+
OpenCL
''''''
.. automodule:: dtcwt.backend.backend_opencl
:members:
+
+.. automodule:: dtcwt.backend.backend_opencl.transform2d
+ :members:
+ :inherited-members:
diff --git a/dtcwt/backend/__init__.py b/dtcwt/backend/__init__.py
index b0f91e7..e37883c 100644
--- a/dtcwt/backend/__init__.py
+++ b/dtcwt/backend/__init__.py
@@ -72,7 +72,7 @@ class Transform2d(object):
:param X: 2D real array
:param nlevels: Number of levels of wavelet decomposition
- :returns td: A :py:class:`dtcwt.backend.TransformDomainSignal` compatible object representing the transform-domain signal
+ :returns: A :py:class:`dtcwt.backend.TransformDomainSignal` compatible object representing the transform-domain signal
"""
raise NotImplementedError()
@@ -84,7 +84,7 @@ class Transform2d(object):
:param td_signal: A :py:class:`dtcwt.backend.TransformDomainSignal`-like class holding the transform domain representation to invert.
:param gain_mask: Gain to be applied to each subband.
- :returns Z: A :py:class:`dtcwt.backend.ReconstructedSignal` compatible instance with the reconstruction.
+ :returns: A :py:class:`dtcwt.backend.ReconstructedSignal` compatible instance with the reconstruction.
The (*d*, *l*)-th element of *gain_mask* is gain for subband with direction
*d* at level *l*. If gain_mask[d,l] == 0, no computation is performed for
diff --git a/dtcwt/backend/backend_numpy/transform2d.py b/dtcwt/backend/backend_numpy/transform2d.py
index 7497a0a..ff99beb 100644
--- a/dtcwt/backend/backend_numpy/transform2d.py
+++ b/dtcwt/backend/backend_numpy/transform2d.py
@@ -3,17 +3,26 @@ import logging
from six.moves import xrange
+__all__ = ['Transform2dNumPy',]
+
from dtcwt.backend import TransformDomainSignal, ReconstructedSignal
from dtcwt.coeffs import biort as _biort, qshift as _qshift
from dtcwt.defaults import DEFAULT_BIORT, DEFAULT_QSHIFT
from dtcwt.utils import appropriate_complex_type_for, asfarray
+from dtcwt.backend import Transform2d
from dtcwt.backend.backend_numpy.lowlevel import LowLevelBackendNumPy
# Use the NumPy low-level backend
_BACKEND = LowLevelBackendNumPy()
-class Transform2dNumPy(object):
+class Transform2dNumPy(Transform2d):
+ """
+ An implementation of the 2D DT-CWT via NumPy. *biort* and *qshift* are the
+ wavelets which parameterise the transform. Valid values are documented in
+ :py:func:`dtcwt.dtwavexfm2`.
+
+ """
def __init__(self, biort=DEFAULT_BIORT, qshift=DEFAULT_QSHIFT):
# Load bi-orthogonal wavelets
try:
@@ -30,6 +39,11 @@ class Transform2dNumPy(object):
def forward(self, X, nlevels=3, include_scale=False):
"""Perform a *n*-level DTCWT-2D decompostion on a 2D matrix *X*.
+ :param X: 2D real array
+ :param nlevels: Number of levels of wavelet decomposition
+
+ :returns: A :py:class:`dtcwt.backend.TransformDomainSignal` compatible object representing the transform-domain signal
+
.. codeauthor:: Rich Wareham <rjw57 at cantab.net>, Aug 2013
.. codeauthor:: Nick Kingsbury, Cambridge University, Sept 2001
.. codeauthor:: Cian Shaffrey, Cambridge University, Sept 2001
@@ -174,6 +188,16 @@ class Transform2dNumPy(object):
"""Perform an *n*-level dual-tree complex wavelet (DTCWT) 2D
reconstruction.
+ :param td_signal: A :py:class:`dtcwt.backend.TransformDomainSignal`-like class holding the transform domain representation to invert.
+ :param gain_mask: Gain to be applied to each subband.
+
+ :returns: A :py:class:`dtcwt.backend.ReconstructedSignal` compatible instance with the reconstruction.
+
+ The (*d*, *l*)-th element of *gain_mask* is gain for subband with direction
+ *d* at level *l*. If gain_mask[d,l] == 0, no computation is performed for
+ band (d,l). Default *gain_mask* is all ones. Note that both *d* and *l* are
+ zero-indexed.
+
.. codeauthor:: Rich Wareham <rjw57 at cantab.net>, Aug 2013
.. codeauthor:: Nick Kingsbury, Cambridge University, May 2002
.. codeauthor:: Cian Shaffrey, Cambridge University, May 2002
diff --git a/dtcwt/backend/backend_opencl/lowlevel.py b/dtcwt/backend/backend_opencl/lowlevel.py
index 3a350ad..4004474 100644
--- a/dtcwt/backend/backend_opencl/lowlevel.py
+++ b/dtcwt/backend/backend_opencl/lowlevel.py
@@ -241,18 +241,18 @@ def axis_convolve(X, h, axis=0, queue=None, output=None):
of each pair of input samples, and the output matrix's shape is increased
by one along the convolution axis.
- After convolution, the :pyclass:`pyopencl.array.Array` instance holding the
+ After convolution, the :py:class:`pyopencl.array.Array` instance holding the
device-side output is returned. This may be accessed on the host via
:pyfunc:`to_array`.
The axis of convolution is specified by *axis*. The default direction of
convolution is column-wise.
- If *queue* is non-``None``, it should be a :pyclass:`pyopencl.CommandQueue`
+ If *queue* is non-``None``, it should be a :py:class:`pyopencl.CommandQueue`
instance which is used to perform the computation. If ``None``, a default
global queue is used.
- If *output* is non-``None``, it should be a :pyclass:`pyopencl.array.Array`
+ If *output* is non-``None``, it should be a :py:class:`pyopencl.array.Array`
instance which the result is written into. If ``None``, an output array is
created.
"""
diff --git a/dtcwt/backend/backend_opencl/transform2d.py b/dtcwt/backend/backend_opencl/transform2d.py
index abdb6f2..50becdb 100644
--- a/dtcwt/backend/backend_opencl/transform2d.py
+++ b/dtcwt/backend/backend_opencl/transform2d.py
@@ -29,13 +29,38 @@ def dtwavexfm2(X, nlevels=3, biort=DEFAULT_BIORT, qshift=DEFAULT_QSHIFT, include
return r.lowpass, r.subbands
class Transform2dOpenCL(Transform2dNumPy):
+ """
+ An implementation of the 2D DT-CWT via OpenCL. *biort* and *qshift* are the
+ wavelets which parameterise the transform. Valid values are documented in
+ :py:func:`dtcwt.dtwavexfm2`.
+
+ If *queue* is non-*None* it is an instance of
+ :py:class:`pyopencl.CommandQueue` which is used to compile and execute the
+ OpenCL kernels which implement the transform. If it is *None*, the first
+ available compute device is used.
+
+ .. note::
+
+ At the moment *only* the **forward** transform is accelerated. The
+ inverse transform uses the NumPy backend.
+
+ """
def __init__(self, biort=DEFAULT_BIORT, qshift=DEFAULT_QSHIFT, queue=None):
super(Transform2dOpenCL, self).__init__(biort=biort, qshift=qshift)
self.queue = to_queue(queue)
def forward(self, X, nlevels=3, include_scale=False):
"""Perform a *n*-level DTCWT-2D decompostion on a 2D matrix *X*.
-
+
+ :param X: 2D real array
+ :param nlevels: Number of levels of wavelet decomposition
+
+ :returns: A :py:class:`dtcwt.backend.TransformDomainSignal` compatible object representing the transform-domain signal
+
+ .. codeauthor:: Rich Wareham <rjw57 at cantab.net>, Aug 2013
+ .. codeauthor:: Nick Kingsbury, Cambridge University, Sept 2001
+ .. codeauthor:: Cian Shaffrey, Cambridge University, Sept 2001
+
"""
queue = self.queue
X = np.atleast_2d(asfarray(X))
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/python-dtcwt.git
More information about the debian-science-commits
mailing list