[python-dtcwt] 272/497: split registration into explicit numpy backend

[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 3eb9e003eaad7a0f34d19a3b4f5a68dc53cd2ce1
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date:   Thu Jan 30 12:09:51 2014 +0000

    split registration into explicit numpy backend
---
 dtcwt/registration/__init__.py                     | 22 ++++++++++++++++++++++
 .../numpybackend.py}                               | 11 ++---------
 2 files changed, 24 insertions(+), 9 deletions(-)

diff --git a/dtcwt/registration/__init__.py b/dtcwt/registration/__init__.py
new file mode 100644
index 0000000..b45c48c
--- /dev/null
+++ b/dtcwt/registration/__init__.py
@@ -0,0 +1,22 @@
+"""
+.. note::
+  This module is experimental. It's API may change between versions.
+
+This module implements function for DTCWT-based image registration as outlined in
+`[1] <http://ieeexplore.ieee.org/xpls/abs_all.jsp?arnumber=5936113>`_.
+These functions are 2D-only for the moment.
+
+The functions in the top-level :py:mod:`dtcwt.registration` module are imported
+as a convenience from :py:mod:`dtcwt.numpybackend`. You could also import
+:py:mod:`dtcwt.numpybackend` directly to explicitly select backend.
+
+"""
+
+from .numpybackend import *
+
+__all__ = [
+    'estimatereg',
+    'velocityfield',
+    'warp',
+    'warptransform',
+]
diff --git a/dtcwt/registration.py b/dtcwt/registration/numpybackend.py
similarity index 97%
rename from dtcwt/registration.py
rename to dtcwt/registration/numpybackend.py
index 1eadc97..3582dad 100644
--- a/dtcwt/registration.py
+++ b/dtcwt/registration/numpybackend.py
@@ -1,10 +1,5 @@
 """
-.. note::
-  This module is experimental. It's API may change between versions.
-
-Functions for DTCWT-based image registration as outlined in
-`[1] <http://ieeexplore.ieee.org/xpls/abs_all.jsp?arnumber=5936113>`_.
-These functions are 2D-only for the moment.
+NumPy implementation of image registration
 
 """
 
@@ -21,8 +16,6 @@ import dtcwt.utils
 import numpy as np
 
 __all__ = [
-    'EXPECTED_SHIFTS',
-
     'estimatereg',
     'velocityfield',
     'warp',
@@ -253,7 +246,7 @@ def warptransform(t, avecs, levels, method=None):
     :param levels: a sequence of 0-based indices specifying which levels to act on
 
     *t* should be a
-    :pyclass:`dtcwt.backend.base.TransformDomainSignal`-compatible instance.
+    :py:class:`dtcwt.backend.base.TransformDomainSignal`-compatible instance.
 
     The *method* parameter is interpreted as in :py:func:`dtcwt.sampling.rescale` and
     is the sampling method used to resize *avecs* to *shape*.

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