From 635b836c087c464a8f0c191925e5866f2d83bc1e Mon Sep 17 00:00:00 2001
From: Stefan van der Walt <stefan@sun.ac.za>
Date: Wed, 8 Feb 2012 20:02:49 -0800
Subject: [PATCH] PKG: Rename as_windows to view_as_windows.

---
 skimage/measure/_structural_similarity.py | 8 ++++----
 skimage/util/shape.py                     | 7 ++++---
 2 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/skimage/measure/_structural_similarity.py b/skimage/measure/_structural_similarity.py
index 1837322a..e8e4edba 100644
--- a/skimage/measure/_structural_similarity.py
+++ b/skimage/measure/_structural_similarity.py
@@ -5,7 +5,7 @@ __all__ = ['structural_similarity']
 import numpy as np
 
 from ..util.dtype import dtype_range
-from ..util.shape import as_windows
+from ..util.shape import view_as_windows
 
 def structural_similarity(X, Y, win_size=7,
                           gradient=False, dynamic_range=None):
@@ -54,8 +54,8 @@ def structural_similarity(X, Y, win_size=7,
         dmin, dmax = dtype_range[X.dtype.type]
         dynamic_range = dmax - dmin
 
-    XW = as_windows(X, win_size=win_size)
-    YW = as_windows(Y, win_size=win_size)
+    XW = view_as_windows(X, win_size=win_size)
+    YW = view_as_windows(Y, win_size=win_size)
 
     NS = len(XW)
     NP = win_size * win_size
@@ -94,7 +94,7 @@ def structural_similarity(X, Y, win_size=7,
             )
 
         grad = np.zeros_like(X, dtype=float)
-        OW = as_windows(grad, win_size=win_size)
+        OW = view_as_windows(grad, win_size=win_size)
 
         OW += local_grad
         grad /= NS
diff --git a/skimage/util/shape.py b/skimage/util/shape.py
index 0b82be1d..73a40142 100644
--- a/skimage/util/shape.py
+++ b/skimage/util/shape.py
@@ -234,9 +234,9 @@ def view_as_windows(arr_in, window_shape):
 import numpy as np
 from numpy.lib import stride_tricks
 
-__all__ = ['as_windows']
+__all__ = ['view_as_windows']
 
-def as_windows(X, win_size=7):
+def view_as_windows(X, win_size=7):
     """Re-stride an array to simulate a sliding window.
 
     Parameters
@@ -249,7 +249,8 @@ def as_windows(X, win_size=7):
     Returns
     -------
     window : (N, M, win_size, win_size) ndarray
-        Sliding windows.
+        A view on the original data, representing sliding windows.  Note:
+        modifying this view will also modify the original data.
 
     """
     if not X.ndim == 2: