[python-dtcwt] 224/497: sampling: extend documentation a bit to discuss where pixel centres lie

[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 42fbea1b76ecc9e5f387ca55bb74867959b741f0
Author: Rich Wareham <rjw57 at cam.ac.uk>
Date:   Wed Dec 4 15:35:36 2013 +0000

    sampling: extend documentation a bit to discuss where pixel centres lie
---
 dtcwt/sampling.py | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/dtcwt/sampling.py b/dtcwt/sampling.py
index ee5a559..99ae0b2 100644
--- a/dtcwt/sampling.py
+++ b/dtcwt/sampling.py
@@ -1,4 +1,14 @@
-"""Rescaling and re-sampling high- and low-pass subbands.
+"""This module contains function for rescaling and re-sampling high- and
+low-pass subbands.
+
+.. note::
+
+    All of these functions take an integer co-ordinate (x, y) to be the
+    *centre* of the corresponding pixel. Therefore the upper-left pixel
+    notionally covers the interval (-0.5, 0.5) in x and y. An image with N rows
+    and M columns, therefore, has an extent (-0.5, M-0.5) on the x-axis and an
+    extent of (-0.5, N-0.5) on the y-axis. The rescale and upsample functions
+    in this module will use this region as the extent of the image.
 
 """
 

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