SF.net SVN: matplotlib:[6386] trunk/matplotlib/lib/matplotlib/axes.py

[<ry...@us...>]

Revision: 6386
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=6386&view=rev
Author:   ryanmay
Date:     2008-11-10 22:41:27 +0000 (Mon, 10 Nov 2008)

Log Message:
-----------
Clean up some of axes.psd() docstring.  Add a reference to the psd_demo.py example.

Modified Paths:
--------------
    trunk/matplotlib/lib/matplotlib/axes.py

Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py	2008-11-10 18:59:18 UTC (rev 6385)
+++ trunk/matplotlib/lib/matplotlib/axes.py	2008-11-10 22:41:27 UTC (rev 6386)
@@ -6526,7 +6526,7 @@
         The power spectral density by Welches average periodogram
         method.  The vector *x* is divided into *NFFT* length
         segments.  Each segment is detrended by function *detrend* and
-        windowed by function *window*.  *noperlap* gives the length of
+        windowed by function *window*.  *noverlap* gives the length of
         the overlap between segments.  The :math:`|\mathrm{fft}(i)|^2`
         of each segment :math:`i` are averaged to compute *Pxx*, with a
         scaling to correct for power loss due to windowing.  *Fs* is the
@@ -6542,7 +6542,7 @@
 
           *Fc*: integer
             The center frequency of *x* (defaults to 0), which offsets
-            the yextents of the image to reflect the frequency range used
+            the x extents of the plot to reflect the frequency range used
             when a signal is acquired and then filtered and downsampled to
             baseband.
 
@@ -6580,6 +6580,10 @@
         kwargs control the :class:`~matplotlib.lines.Line2D` properties:
 
         %(Line2D)s
+
+        **Example:**
+
+        .. plot:: mpl_examples/pylab_examples/psd_demo.py
         """
         if not self._hold: self.cla()
         pxx, freqs = mlab.psd(x, NFFT, Fs, detrend, window, noverlap)


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.