This documentation is for development version 0.18.dev0.

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=1, verbose=None)[source]

Estimate cross-spectral density from epochs using Morlet wavelets.

Parameters:
epochs : instance of Epochs

The epochs to compute the CSD for.

fmin : float | None

Minimum frequency of interest, in Hertz.

fmax : float | np.inf

Maximum frequency of interest, in Hertz.

tmin : float

Minimum time instant to consider, in seconds. If None start at first sample.

tmax : float | None

Maximum time instant to consider, in seconds. If None end at last sample.

picks : 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(excluding reference MEG channels).

n_fft : int | None

Length of the FFT. If None, the exact number of samples between tmin and tmax will be used.

bandwidth : float | None

The bandwidth of the multitaper windowing function in Hz.

adaptive : bool

Use adaptive weights to combine the tapered spectra into PSD.

low_bias : bool

Only use tapers with more than 90% spectral concentration within bandwidth.

projs : list 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_jobs : int

Number of jobs to run in parallel. Defaults to 1.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:
csd : instance of CrossSpectralDensity

The computed cross-spectral density.

Examples using mne.time_frequency.csd_multitaper