mne.pick_channels_cov#

mne.pick_channels_cov(orig, include=[], exclude='bads', ordered=None, copy=True, *, verbose=None)[source]#

Pick channels from covariance matrix.

Parameters:
origCovariance

A covariance.

includelist of str, (optional)

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

excludelist of str, (optional) | ‘bads’

Channels to exclude (if empty, do not exclude any). Defaults to ‘bads’.

orderedbool

If True (default False), 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.5: The default changed from False in 1.4 to True in 1.5.

copybool

If True (the default), return a copy of the covariance 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:
resdict

Covariance solution restricted to selected channels.