mne.time_frequency.csd_array_multitaper#

mne.time_frequency.csd_array_multitaper(X, sfreq, t0=0, fmin=0, fmax=inf, tmin=None, tmax=None, ch_names=None, n_fft=None, bandwidth=None, adaptive=False, low_bias=True, projs=None, n_jobs=None, max_iter=250, *, verbose=None)[source]#

Estimate cross-spectral density from an array using a multitaper method.

Parameters:

Xarray_like, shape (n_epochs, n_channels, n_times): The time series data consisting of n_epochs separate observations of signals with n_channels time-series of length n_times.
sfreqfloat: Sampling frequency of observations.
t0float: Time of the first sample relative to the onset of the epoch, in seconds. Defaults to 0.
fminfloat: Minimum frequency of interest, in Hertz.
fmaxfloat | numpy.inf: Maximum frequency of interest, in Hertz.
tminfloat | None: Minimum time instant to consider, in seconds. If None start at first sample.
tmaxfloat | None: Maximum time instant to consider, in seconds. If None end at last sample.
ch_nameslist of str | None: A name for each time series. If None (the default), the series will be named ‘SERIES###’.
n_fftint | None: Length of the FFT. If None, the exact number of samples between tmin and tmax will be used.
bandwidthfloat | None: The bandwidth of the multitaper windowing function in Hz.
adaptivebool: Use adaptive weights to combine the tapered spectra into PSD.
low_biasbool: Only use tapers with more than 90% spectral concentration within bandwidth.
projslist of Projection | None: List of projectors to store in the CSD object. Defaults to None, which means no projectors are stored.
n_jobsint | 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.
max_iterint: Maximum number of iterations to reach convergence when combining the tapered spectra with adaptive weights (see argument adaptive). This argument has not effect if adaptive is set to False.
verbosebool | 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.

Returns:

csdinstance of CrossSpectralDensity: The computed cross-spectral density.