Getting Started

This section will guide you through using the dtcwt library. Once installed, you are most likely to use one of these functions:

• dtcwt.dtwavexfm() – 1D DT-CWT transform.
• dtcwt.dtwaveifm() – Inverse 1D DT-CWT transform.
• dtcwt.dtwavexfm2() – 2D DT-CWT transform.
• dtcwt.dtwaveifm2() – Inverse 2D DT-CWT transform.
• dtcwt.dtwavexfm3() – 3D DT-CWT transform.
• dtcwt.dtwaveifm3() – Inverse 3D DT-CWT transform.

See API Reference for full details on how to call these functions. We shall present some simple usage below.

Installation

The easiest way to install dtcwt is via easy_install or pip:

$ pip install dtcwt

If you want to check out the latest in-development version, look at the project’s GitHub page. Once checked out, installation is based on setuptools and follows the usual conventions for a Python project:

$ python setup.py install

(Although the develop command may be more useful if you intend to perform any significant modification to the library.) A test suite is provided so that you may verify the code works on your system:

$ python setup.py nosetests

This will also write test-coverage information to the cover/ directory.

Building the documentation

There is a pre-built version of this documentation available online and you can build your own copy via the Sphinx documentation system:

$ python setup.py build_sphinx

Compiled documentation may be found in build/docs/html/.