Merge pull request #1489 from gitj/master

ivanov · ivanov · commit a1f8b4e5578f · 2012-11-24T00:36:44.000-08:00
Documentation update for specgram
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -8604,11 +8604,12 @@ def specgram(self, x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
                    cmap=None, xextent=None, pad_to=None, sides='default',
                    scale_by_freq=None, **kwargs)
 
-        Compute a spectrogram of data in *x*.  Data are split into
+        Compute and plot a spectrogram of data in *x*.  Data are split into
         *NFFT* length segments and the PSD of each section is
         computed.  The windowing function *window* is applied to each
         segment, and the amount of overlap of each segment is
-        specified with *noverlap*.
+        specified with *noverlap*. The spectrogram is plotted in decibels
+        as a colormap (using imshow).
 
         %(PSD)s
 
@@ -8647,6 +8648,9 @@ def specgram(self, x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
         spectrum is shown.  If *x* is complex, both positive and
         negative parts of the spectrum are shown.  This can be
         overridden using the *sides* keyword argument.
+        
+        Also note that while the plot is in dB, the *Pxx* array returned is
+        linear in power.
 
         **Example:**
 
