mne.time_frequency.csd_morlet

mne.time_frequency.csd_morlet(epochs, frequencies, tmin=None, tmax=None, picks=None, n_cycles=7, use_fft=True, decim=1, projs=None, n_jobs=1, verbose=None)[source]

Estimate cross-spectral density from epochs using Morlet wavelets.

Parameters
epochsinstance of Epochs

The epochs to compute the CSD for.

frequencieslist of float

The frequencies 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.

picksstr | 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). Note that channels in info['bads'] will be included if their names or indices are explicitly provided.

n_cyclesfloat | list of float | None

Number of cycles to use when constructing Morlet wavelets. Fixed number or one per frequency. Defaults to 7.

use_fftbool

Whether to use FFT-based convolution to compute the wavelet transform. Defaults to True.

decimint | slice

To reduce memory usage, decimation factor during time-frequency decomposition. Defaults to 1 (no decimation).

If int, uses tfr[…, ::decim]. If slice, uses tfr[…, decim].

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 be copied.

n_jobsint

The number of jobs to run in parallel (default 1). Requires the joblib package.

verbosebool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). If used, it should be passed as a keyword-argument only.

Returns
csdinstance of CrossSpectralDensity

The computed cross-spectral density.

Examples using mne.time_frequency.csd_morlet