ENH Added the origin option to spy

NelleV · NelleV · commit 476ba2a0edc1 · 2014-02-28T16:19:08.000+01:00
This option allows to place either the origin at the bottom of the axes, or at
the top.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -6547,33 +6547,41 @@ def specgram(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
         return spec, freqs, t, im
 
     def spy(self, Z, precision=0, marker=None, markersize=None,
-            aspect='equal', **kwargs):
+            aspect='equal', origin="upper", **kwargs):
         """
         Plot the sparsity pattern on a 2-D array.
 
-        Call signature::
+        ``spy(Z)`` plots the sparsity pattern of the 2-D array *Z*.
 
-          spy(Z, precision=0, marker=None, markersize=None,
-              aspect='equal', **kwargs)
+        Parameters
+        ----------
 
-        ``spy(Z)`` plots the sparsity pattern of the 2-D array *Z*.
+        Z : sparse array (n, m)
+            The array to be plotted.
+
+        precision : float, optional, default: 0
+            If *precision* is 0, any non-zero value will be plotted; else,
+            values of :math:`|Z| > precision` will be plotted.
+
+            For :class:`scipy.sparse.spmatrix` instances, there is a special
+            case: if *precision* is 'present', any value present in the array
+            will be plotted, even if it is identically zero.
 
-        If *precision* is 0, any non-zero value will be plotted;
-        else, values of :math:`|Z| > precision` will be plotted.
+        origin : ["upper", "lower"], optional, default: "upper"
+            Place the [0,0] index of the array in the upper left or lower left
+            corner of the axes.
 
-        For :class:`scipy.sparse.spmatrix` instances, there is a
-        special case: if *precision* is 'present', any value present in
-        the array will be plotted, even if it is identically zero.
+        aspect : ['auto' | 'equal' | scalar], optional, default: "equal"
 
-        The array will be plotted as it would be printed, with
-        the first index (row) increasing down and the second
-        index (column) increasing to the right.
+            If 'equal', and `extent` is None, changes the axes aspect ratio to
+            match that of the image. If `extent` is not `None`, the axes
+            aspect ratio is changed to match that of the extent.
+
+
+            If 'auto', changes the image aspect ratio to match that of the
+            axes.
 
-        By default aspect is 'equal', so that each array element
-        occupies a square space; set the aspect kwarg to 'auto'
-        to allow the plot to fill the plot box, or to any scalar
-        number to specify the aspect ratio of an array element
-        directly.
+            If None, default to rc ``image.aspect`` value.
 
         Two plotting styles are available: image or marker. Both
         are available for full arrays, but only the marker style
@@ -6592,33 +6600,10 @@ def spy(self, Z, precision=0, marker=None, markersize=None,
         * *cmap*
         * *alpha*
 
-        .. seealso::
-
-            :func:`~matplotlib.pyplot.imshow`
-               For image options.
-
-        For controlling colors, e.g., cyan background and red marks,
-        use::
-
-          cmap = mcolors.ListedColormap(['c','r'])
-
-        If *marker* or *markersize* is not *None*, useful kwargs include:
-
-        * *marker*
-        * *markersize*
-        * *color*
-
-        Useful values for *marker* include:
-
-        * 's'  square (default)
-        * 'o'  circle
-        * '.'  point
-        * ','  pixel
-
-        .. seealso::
-
-            :func:`~matplotlib.pyplot.plot`
-               For plotting options
+        See also 
+        ---------
+        imshow : for image options.
+        plot : for plotting options
         """
         if marker is None and markersize is None and hasattr(Z, 'tocoo'):
             marker = 's'
@@ -6632,7 +6617,7 @@ def spy(self, Z, precision=0, marker=None, markersize=None,
             nr, nc = Z.shape
             extent = [-0.5, nc - 0.5, nr - 0.5, -0.5]
             ret = self.imshow(mask, interpolation='nearest', aspect=aspect,
-                                extent=extent, origin='upper', **kwargs)
+                                extent=extent, origin=origin, **kwargs)
         else:
             if hasattr(Z, 'tocoo'):
                 c = Z.tocoo()
