mne.pick_channels_forward#

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

Pick channels from forward operator.

Parameters:
origdict

A forward solution.

includelist of str

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

excludelist of str | ‘bads’

Channels to exclude (if empty, do not exclude any). Defaults to []. If ‘bads’, then exclude bad channels in orig.

orderedbool

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

New in version 0.20.0.

Changed in version 1.5: The default changed from False in 1.4 to True in 1.5.

copybool

If True (default), make a copy.

New in version 0.19.

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

Forward solution restricted to selected channels. If include and exclude are empty it returns orig without copy.