mne.time_frequency.csd_multitaper#

mne.time_frequency.csd_multitaper(epochs, fmin=0, fmax=inf, tmin=None, tmax=None, picks=None, n_fft=None, bandwidth=None, adaptive=False, low_bias=True, projs=None, n_jobs=None, *, verbose=None)[source]#

Estimate cross-spectral density from epochs using a multitaper method.

Parameters:

epochsinstance of Epochs: The epochs to compute the CSD for.
fminfloat | None: Minimum frequency of interest, in Hertz.
fmaxfloat | numpy.inf: Maximum frequency of interest, in Hertz.
tminfloat: 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.
picksstr | array_like | 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 (excluding reference MEG channels). Note that channels in info['bads'] will be included if their names or indices are explicitly provided.
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 the projectors defined in the Epochs object will by copied.
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_config context manager that sets another value for n_jobs.
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.

Examples using `mne.time_frequency.csd_multitaper`#

Compute a cross-spectral density (CSD) matrix

mne.time_frequency.csd_multitaper#

Examples using mne.time_frequency.csd_multitaper#

Examples using `mne.time_frequency.csd_multitaper`#