Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

DOC specgram() documentation now in numpy style #7038

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.

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

Closed
wants to merge 2 commits into from
Closed
Changes from 1 commit
Commits
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
Prev Previous commit
FIX various trailing spaces, clarity, tabulations.
  • Loading branch information
Florencia Noriega committed Sep 10, 2016
commit a02a575b64f6583cd0345c868ffb614e06098d9b
50 changes: 25 additions & 25 deletions 50 lib/matplotlib/mlab.py
Original file line number Diff line number Diff line change
Expand Up @@ -1255,49 +1255,49 @@ def specgram(x, NFFT=None, Fs=None, detrend=None, window=None,
%(PSD)s

noverlap : int, optional
The number of points of overlap between blocks. The default
The number of points of overlap between blocks. The default
value is 128.
mode : str, optional
What sort of spectrum to use, default is 'psd'.

'psd'
Returns the power spectral density.

'complex'
Returns the complex-valued frequency spectrum.

'magnitude'
Returns the magnitude spectrum.

'angle'
Returns the phase spectrum without unwrapping.

'phase'
Returns the phase spectrum with unwrapping.
What sort of spectrum to use, default is 'psd'.
'psd'
Returns the power spectral density.

'complex'
Returns the complex-valued frequency spectrum.

'magnitude'
Returns the magnitude spectrum.

'angle'
Returns the phase spectrum without unwrapping.

'phase'
Returns the phase spectrum with unwrapping.

Returns
-------
spectrum: array_like
spectrum : array_like
2-D array, columns are the periodograms of successive segments.

freqs: array_like
freqs : array_like
1-D array, frequencies corresponding to the rows in *spectrum*.

t : array_like
1-D array, the times corresponding to midpoints of segments
1-D array, the times corresponding to midpoints of segments
(i.e the columns in *spectrum*).

See Also
--------
psd : differs in the default overlap; in returning the mean of the segment periodograms; and in not returning times.
complex_spectrum : A single spectrum, similar to having a single segment when mode is 'complex'.
magnitude_spectrum : A single spectrum, similar to having a single segment when mode is 'magnitude'.
angle_spectrum : A single spectrum, similar to having a single segment when mode is 'angle'.
phase_spectrum : A single spectrum, similar to having a single segment when mode is 'phase'.
psd : differs in the overlap and in the return values.
complex_spectrum : similar, but with complex valued frequencies.
magnitude_spectrum : similar single segment when mode is 'magnitude'.
angle_spectrum : similar to single segment when mode is 'angle'.
phase_spectrum : similar to single segment when mode is 'phase'.

Notes
-----
detrend and scale_by_freq only apply when *mode* is set to 'psd'.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a blank line at the end of the docstring?


"""
if noverlap is None:
noverlap = 128
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.