mne.time_frequency.pick_channels_csd#

mne.time_frequency.pick_channels_csd(csd, include=(), exclude=(), ordered=True, copy=True, *, verbose=None)[source]#

Pick channels from cross-spectral density matrix.

Parameters:
csdinstance of CrossSpectralDensity

The CSD object to select the channels from.

includelist of str

List of channels to include (if empty, include all available).

excludelist of str

Channels to exclude (if empty, do not exclude any).

orderedbool

If True (default), ensure that the order of the channels in the modified instance matches the order of ch_names.

New in v0.20.0.

Changed in version 1.7: The default changed from False in 1.6 to True in 1.7.

copybool

If True (the default), return a copy of the CSD matrix with the modified channels. If False, channels are modified in-place.

New in v0.20.0.

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:
resinstance of CrossSpectralDensity

Cross-spectral density restricted to selected channels.