10000 Documentation update for specgram by gitj · Pull Request #1489 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Documentation update for specgram #1489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 24, 2012
Merged

Documentation update for specgram #1489

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
016f644
Update documentation of specgram
Nov 12, 2012
930a9db
DOC: Update return value units in specgram
Nov 13, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions lib/matplotlib/axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8573,11 +8573,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

Expand Down Expand Up @@ -8616,6 +8617,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:**

Expand Down
0