Plot the power spectral density across channels.
Different channel types are drawn in sub-plots. When the data have been processed with a bandpass, lowpass or highpass filter, dashed lines (╎) indicate the boundaries of the filter. The line noise frequency is also indicated with a dashed line (⋮).
Raw
The raw object.
float
Start frequency to consider.
float
End frequency to consider.
float
| None
Start time to consider.
float
| None
End time to consider.
Apply projection.
int
| None
Number of points to use in Welch FFT calculations. Default is None, which uses the minimum of 2048 and the number of time points.
int
The number of points of overlap between blocks. The default value is 0 (no overlap).
Whether to omit bad segments from the data before fitting. If True
(default), annotated segments whose description begins with 'bad'
are
omitted. If False
, no rejection based on annotations is performed.
Has no effect if inst
is not a mne.io.Raw
object.
str
| list
| slice
| None
Channels to include. Slices and lists of integers will be interpreted as channel indices. In lists, channel type strings
(e.g., ['meg', 'eeg']
) will pick channels of those
types, channel name strings (e.g., ['MEG0111', 'MEG2623']
will pick the given channels. Can also be the string values
“all” to pick all channels, or “data” to pick data channels.
None (default) will pick good data channels. Note that channels in info['bads']
will be included if their names or indices are explicitly provide
Cannot be None if ax
is supplied.If both picks
and ax
are None
separate subplots will be created for each standard channel type
(mag
, grad
, and eeg
).
Axes
| None
Axes to plot into. If None, axes will be created.
str
| tuple
A matplotlib-compatible color to use. Has no effect when spatial_colors=True.
str
Can be ‘linear’ (default) or ‘log’.
str
| None
Mode for plotting area. If ‘std’, the mean +/- 1 STD (across channels) will be plotted. If ‘range’, the min and max (across channels) will be plotted. Bad channels will be excluded from these calculations. If None, no area will be plotted. If average=False, no area is plotted.
float
Alpha for the area.
Plot Power Spectral Density (PSD), in units (amplitude**2/Hz (dB)) if
dB=True
, and estimate='power'
or estimate='auto'
. Plot PSD
in units (amplitude**2/Hz) if dB=False
and,
estimate='power'
. Plot Amplitude Spectral Density (ASD), in units
(amplitude/sqrt(Hz)), if dB=False
and estimate='amplitude'
or
estimate='auto'
. Plot ASD, in units (amplitude/sqrt(Hz) (db)), if
dB=True
and estimate='amplitude'
.
str
, {‘auto’, ‘power’, ‘amplitude’}Can be “power” for power spectral density (PSD), “amplitude” for amplitude spectrum density (ASD), or “auto” (default), which uses “power” when dB is True and “amplitude” otherwise.
Show the figure if True
.
int
| None
The number of jobs to run in parallel. If -1
, it is set
to the number of CPU cores. Requires the joblib
package.
None
(default) is a marker for ‘unset’ that will be interpreted
as n_jobs=1
(sequential execution) unless the call is performed under
a joblib.parallel_backend()
context manager that sets another
value for n_jobs
.
If False, the PSDs of all channels is displayed. No averaging is done and parameters area_mode and area_alpha are ignored. When False, it is possible to paint an area (hold left mouse button and drag) to plot a topomap.
float
| None
Alpha for the PSD line. Can be None (default) to use 1.0 when
average=True
and 0.1 when average=False
.
Whether to use spatial colors. Only used when average=False
.
float
| array-like | instance of ConductorModel
| None
| ‘auto’ | ‘eeglab’The sphere parameters to use for the head outline. Can be array-like of
shape (4,) to give the X/Y/Z origin and radius in meters, or a single float
to give just the radius (origin assumed 0, 0, 0). Can also be an instance
of a spherical ConductorModel
to use the origin and
radius from that object. If 'auto'
the sphere is fit to digitization
points. If 'eeglab'
the head circle is defined by EEG electrodes
'Fpz'
, 'Oz'
, 'T7'
, and 'T8'
(if 'Fpz'
is not present,
it will be approximated from the coordinates of 'Oz'
). None
(the
default) is equivalent to 'auto'
when enough extra digitization points
are available, and (0, 0, 0, 0.095) otherwise. Currently the head radius
does not affect plotting.
New in version 0.20.
Changed in version 1.1: Added 'eeglab'
option.
str
| float
| tuple
Windowing function to use. See scipy.signal.get_window()
.
New in version 0.22.0.
list
of str
| ‘bads’Channels names to exclude from being shown. If ‘bads’, the bad channels are excluded. Pass an empty list to plot all channels (including channels marked “bad”, if any).
New in version 0.24.0.
str
| int
| None
Control verbosity of the logging output. If None
, use the default
verbosity level. See the logging documentation and
mne.verbose()
for details. Should only be passed as a keyword
argument.
Figure
Figure with frequency spectra of the data channels.