Compute power spectral density (PSD) using Welch’s method.
array
, shape=(…, n_times)The data to compute PSD from.
float
The sampling frequency.
float
The lower frequency of interest.
float
The upper frequency of interest.
int
The length of FFT used, must be >= n_per_seg
(default: 256).
The segments will be zero-padded if n_fft > n_per_seg
.
int
The number of points of overlap between segments. Will be adjusted to be <= n_per_seg. The default value is 0.
int
| None
Length of each Welch segment (windowed with a Hamming window). Defaults to None, which sets n_per_seg equal to n_fft.
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
.
str
| None
How to average the segments. If mean
(default), calculate the
arithmetic mean. If median
, calculate the median, corrected for
its bias relative to the mean. If None
, returns the unaggregated
segments.
New in version 0.19.0.
str
| float
| tuple
Windowing function to use. See scipy.signal.get_window()
.
New in version 0.22.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.
ndarray
, shape (…, n_freqs) or (…, n_freqs, n_segments)The power spectral densities. If average='mean
or
average='median'
, the returned array will have the same shape
as the input data plus an additional frequency dimension.
If average=None
, the returned array will have the same shape as
the input data plus two additional dimensions corresponding to
frequencies and the unaggregated segments, respectively.
ndarray
, shape (n_freqs,)The frequencies.
Notes
New in version 0.14.0.
mne.time_frequency.psd_array_welch
#Compute Spectro-Spatial Decomposition (SSD) spatial filters