From 27d765abd5f54fe700f5d27acb08d8b6f6b3ce2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Thu, 11 Sep 2014 11:28:06 -0400 Subject: [PATCH] Highlight fact that warp_coords is only meant for 2(+1)-D images --- skimage/transform/_geometric.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/skimage/transform/_geometric.py b/skimage/transform/_geometric.py index 1c397a1e..cf099c74 100644 --- a/skimage/transform/_geometric.py +++ b/skimage/transform/_geometric.py @@ -912,7 +912,7 @@ def _stackcopy(a, b): def warp_coords(coord_map, shape, dtype=np.float64): - """Build the source coordinates for the output pixels of an image warp. + """Build the source coordinates for the output of a 2-D image warp. Parameters ---------- @@ -934,8 +934,9 @@ def warp_coords(coord_map, shape, dtype=np.float64): Notes ----- - This is a lower-level routine that produces the source coordinates used by - `warp()`. + + This is a lower-level routine that produces the source coordinates for 2-D + images used by `warp()`. It is provided separately from `warp` to give additional flexibility to users who would like, for example, to re-use a particular coordinate @@ -946,7 +947,7 @@ def warp_coords(coord_map, shape, dtype=np.float64): Examples -------- - Produce a coordinate map that Shifts an image up and to the right: + Produce a coordinate map that shifts an image up and to the right: >>> from skimage import data >>> from scipy.ndimage import map_coordinates