[python-dtcwt] 32/38: docs: add note on comparison of dtcwt and original toolbox

[Ghislain Vaillant]

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

ghisvail-guest pushed a commit to branch master
in repository python-dtcwt.

commit 62b99fc683f15db548b524f6004f99124e4a8155
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date:   Wed Aug 5 11:12:32 2015 +0100

    docs: add note on comparison of dtcwt and original toolbox
---
 docs/index.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/docs/index.rst b/docs/index.rst
index 460228a..224c1a4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,6 +1,30 @@
 The dtcwt library
 =================
 
+The ``dtcwt`` library provides a Python implementation of the 1, 2 and 3-D
+dual-tree complex wavelet transform along with some associated algorithms. It
+contains a pure CPU implementation which makes use of NumPy along with an
+accelerated GPU implementation using OpenCL.
+
+Comparison with MATLAB toolbox
+------------------------------
+
+The canonical implementation of the DT-CWT is that provided by Professor Nick
+Kingsbury on `his website <http://www-sigproc.eng.cam.ac.uk/Main/NGK>`_. This
+library aims to have near-identical output (to within a small multiple of
+machine precision). Significant deviation is a bug and should be `reported
+<https://github.com/rjw57/dtcwt/issues>`_. Cross-verification of the transform
+output is part of the test suite and each and every change is checked against
+that test suite automatically.
+
+It is hoped that testing this will allow confidence in this library being
+suitable for porting existing MATLAB scripts over to Python. To that end there
+is a :py:mod:`dtcwt.compat` module which provides an API similar to the original
+MATLAB toolbox.
+
+Contents
+--------
+
 .. toctree::
     :maxdepth: 2
 

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