added xcorr and acorr plot functions

jdh2358 · jdh2358 · commit 6dcc1bb1c0a5 · 2007-01-11T19:14:57.000Z
svn path=/trunk/matplotlib/; revision=2978
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,5 +1,6 @@
-2007-01-11 Added Axes.xcorr to plot the cross correlation of x vs y -
-           JDH
+2007-01-11 Added Axes.xcorr and Axes.acorr to plot the cross
+           correlation of x vs y or the autocorrelation of x.  pylab
+           wrappers also provided.  See examples/xcorr_demo.py - JDH
 
 2007-01-10 Added "Subplot.label_outer" method.  It will set the
            visibility of the ticklabels so that yticklabels are only
diff --git a/boilerplate.py b/boilerplate.py
@@ -47,6 +47,7 @@ def %(func)s(*args, **kwargs):
 # these methods are all simple wrappers of Axes methods by the same
 # name.
 _plotcommands = (
+    'acorr',
     'arrow',
     'axhline',
     'axhspan',
@@ -83,6 +84,7 @@ def %(func)s(*args, **kwargs):
     'quiver',
     'quiver2',
     'quiverkey',
+    'xcorr',
     )
 
 _misccommands = (
diff --git a/examples/xcorr_demo.py b/examples/xcorr_demo.py
@@ -0,0 +1,16 @@
+from pylab import figure, show, nx
+
+
+x,y = nx.mlab.randn(2,100)
+fig = figure()
+ax1 = fig.add_subplot(211)
+ax1.xcorr(x, y)
+ax1.grid(True)
+ax1.axhline(0, color='black', lw=2)
+
+ax2 = fig.add_subplot(212)
+ax2.acorr(x, normed=True)
+ax2.grid(True)
+ax2.axhline(0, color='black', lw=2)
+
+show()
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -2483,11 +2483,33 @@ def semilogy(self, *args, **kwargs):
         return l
     semilogy.__doc__ = dedent(semilogy.__doc__) % artist.kwdocd
 
+    def acorr(self, x, normed=False, detrend=detrend_none, **kwargs):
+        """
+        Plot the autocorrelation of x.  If normed=True, normalize the
+        data but the autocorrelation at 0-th lag.  x is detrended by
+        the detrend callable (default no normalization. 
+
+        data are plotted as plot(lags, c, **kwargs)
+
+        return value is lags, c, line where lags are a length
+        2*len(x)+1 lag vector, c is the 2*len(x)+1 auto correlation
+        vector, and line is a Line2D instance returned by plot.  The
+        default linestyle is None and the default marker is 'o',
+        though these can be overridden with keyword args.  The cross
+        correlation is performed with numerix cross_correlate with
+        mode=2.
+
+        The valid kwargs are Line2D properties:
+        %(Line2D)s
+        """
+        return self.xcorr(x, x, normed, detrend, **kwargs)
+    acorr.__doc__ = dedent(acorr.__doc__) % artist.kwdocd    
+
     def xcorr(self, x, y, normed=False, detrend=detrend_none, **kwargs):
         """
         Plot the cross correlation between x and y.  If normed=True,
         normalize the data but the cross correlation at 0-th lag.  x
-        and y are deterned by the detrend callable (default no
+        and y are detrended by the detrend callable (default no
         normalization.  x and y must be equal length
 
         data are plotted as plot(lags, c, **kwargs)
diff --git a/lib/matplotlib/pylab.py b/lib/matplotlib/pylab.py
@@ -6,6 +6,7 @@
 The majority of them, however, have matlab analogs
 
 _Plotting commands
+  acorr     - plot the autocorrelation function
   annotate  - annotate something in the figure
   arrow     - add an arrow to the axes
   axes      - Create a new axes
@@ -79,8 +80,8 @@
   table    - add a table to the plot
   text     - add some text at location x,y to the current axes
   thetagrids - customize the radial theta grids and labels for polar
-
   title    - add a title to the current axes
+  xcorr   - plot the autocorrelation function of x and y  
   xlim     - set/get the xlimits
   ylim     - set/get the ylimits
   xticks   - set/get the xticks
@@ -1526,6 +1527,27 @@ def pcolor_classic(*args, **kwargs):
     pcolor_classic.__doc__ = dedent(Axes.pcolor_classic.__doc__)
 
 ### Do not edit below this point
+# This function was autogenerated by boilerplate.py.  Do not edit as
+# changes will be lost
+def acorr(*args, **kwargs):
+    # allow callers to override the hold state by passing hold=True|False
+    b = ishold()
+    h = popd(kwargs, 'hold', None)
+    if h is not None:
+        hold(h)
+    try:
+        ret =  gca().acorr(*args, **kwargs)
+        draw_if_interactive()
+    except:
+        hold(b)
+        raise
+    
+    hold(b)
+    return ret
+if Axes.acorr.__doc__ is not None:
+    acorr.__doc__ = dedent(Axes.acorr.__doc__) + """
+Addition kwargs: hold = [True|False] overrides default hold state"""
+
 # This function was autogenerated by boilerplate.py.  Do not edit as
 # changes will be lost
 def arrow(*args, **kwargs):
@@ -1540,7 +1562,7 @@ def arrow(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.arrow.__doc__ is not None:
@@ -1561,7 +1583,7 @@ def axhline(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.axhline.__doc__ is not None:
@@ -1582,7 +1604,7 @@ def axhspan(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.axhspan.__doc__ is not None:
@@ -1603,7 +1625,7 @@ def axvline(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.axvline.__doc__ is not None:
@@ -1624,7 +1646,7 @@ def axvspan(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.axvspan.__doc__ is not None:
@@ -1645,7 +1667,7 @@ def bar(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.bar.__doc__ is not None:
@@ -1666,7 +1688,7 @@ def barh(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.barh.__doc__ is not None:
@@ -1687,7 +1709,7 @@ def broken_barh(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.broken_barh.__doc__ is not None:
@@ -1708,7 +1730,7 @@ def boxplot(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.boxplot.__doc__ is not None:
@@ -1729,7 +1751,7 @@ def cohere(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.cohere.__doc__ is not None:
@@ -1750,7 +1772,7 @@ def clabel(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.clabel.__doc__ is not None:
@@ -1813,7 +1835,7 @@ def csd(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.csd.__doc__ is not None:
@@ -1834,7 +1856,7 @@ def errorbar(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.errorbar.__doc__ is not None:
@@ -1855,7 +1877,7 @@ def fill(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.fill.__doc__ is not None:
@@ -1876,7 +1898,7 @@ def hist(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.hist.__doc__ is not None:
@@ -1897,7 +1919,7 @@ def hlines(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.hlines.__doc__ is not None:
@@ -1939,7 +1961,7 @@ def loglog(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.loglog.__doc__ is not None:
@@ -2002,7 +2024,7 @@ def pie(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.pie.__doc__ is not None:
@@ -2023,7 +2045,7 @@ def plot(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.plot.__doc__ is not None:
@@ -2044,7 +2066,7 @@ def plot_date(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.plot_date.__doc__ is not None:
@@ -2065,7 +2087,7 @@ def psd(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.psd.__doc__ is not None:
@@ -2107,7 +2129,7 @@ def semilogx(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.semilogx.__doc__ is not None:
@@ -2128,7 +2150,7 @@ def semilogy(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.semilogy.__doc__ is not None:
@@ -2191,7 +2213,7 @@ def stem(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.stem.__doc__ is not None:
@@ -2212,7 +2234,7 @@ def vlines(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.vlines.__doc__ is not None:
@@ -2275,13 +2297,34 @@ def quiverkey(*args, **kwargs):
     except:
         hold(b)
         raise
-
+    
     hold(b)
     return ret
 if Axes.quiverkey.__doc__ is not None:
     quiverkey.__doc__ = dedent(Axes.quiverkey.__doc__) + """
 Addition kwargs: hold = [True|False] overrides default hold state"""
 
+# This function was autogenerated by boilerplate.py.  Do not edit as
+# changes will be lost
+def xcorr(*args, **kwargs):
+    # allow callers to override the hold state by passing hold=True|False
+    b = ishold()
+    h = popd(kwargs, 'hold', None)
+    if h is not None:
+        hold(h)
+    try:
+        ret =  gca().xcorr(*args, **kwargs)
+        draw_if_interactive()
+    except:
+        hold(b)
+        raise
+    
+    hold(b)
+    return ret
+if Axes.xcorr.__doc__ is not None:
+    xcorr.__doc__ = dedent(Axes.xcorr.__doc__) + """
+Addition kwargs: hold = [True|False] overrides default hold state"""
+
 # This function was autogenerated by boilerplate.py.  Do not edit as
 # changes will be lost
 def cla(*args, **kwargs):
