[python-dtcwt] 116/497: add note on pre-release nature of keypoint stuff

[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 71f441844edaea3200e9fad2b1790d904b12bea4
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date:   Tue Aug 20 20:14:53 2013 +0100

    add note on pre-release nature of keypoint stuff
---
 dtcwt/keypoint.py | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/dtcwt/keypoint.py b/dtcwt/keypoint.py
index 0932a26..58fa3fc 100644
--- a/dtcwt/keypoint.py
+++ b/dtcwt/keypoint.py
@@ -24,6 +24,12 @@ def find_keypoints(highpass_subbands, method=None,
 
     :returns: (Px4) array of P keypoints in image co-ordinates
 
+    .. warning::
+
+        The interface and behaviour of this function is the subject of an open
+        research project. It is provided in this release as a preview of
+        forthcoming functionality but it is subject to change between releases.
+
     The rows of the returned keypoint array give the x co-ordinate, y
     co-ordinate, scale and keypoint energy. The rows are sorted in order of
     decreasing keypoint energy.
@@ -57,7 +63,6 @@ def find_keypoints(highpass_subbands, method=None,
     fauqueur    Geometric mean of absolute values[1]    *alpha*, *beta*
     bendale     Minimum absolute value[2]               none
     kingsbury   Cross-product of orthogonal subbands    *kappa*
-    gale        Gradient of subbands                    none
     =========== ======================================= ======================
 
     [1] Julien Fauqueur, Nick Kingsbury, and Ryan Anderson. *Multiscale

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