braindecode.preprocessing.PickTypes#

class braindecode.preprocessing.PickTypes(meg=False, eeg=False, stim=False, eog=False, ecg=False, emg=False, ref_meg='auto', *, misc=False, resp=False, chpi=False, exci=False, ias=False, syst=False, seeg=False, dipole=False, gof=False, bio=False, ecog=False, fnirs=False, csd=False, dbs=False, temperature=False, gsr=False, eyetrack=False, include=(), exclude='bads', selection=None, verbose=None)[source]#

Braindecode preprocessor wrapper for pick_types().

Warning

LEGACY: New code should use inst.pick(…).

Pick some channels by type and names.

Parameters:
  • meg (bool | str) – If True include MEG channels. If string it can be ‘mag’, ‘grad’, ‘planar1’ or ‘planar2’ to select only magnetometers, all gradiometers, or a specific type of gradiometer.

  • eeg (bool) – If True include EEG channels.

  • stim (bool) – If True include stimulus channels.

  • eog (bool) – If True include EOG channels.

  • ecg (bool) – If True include ECG channels.

  • emg (bool) – If True include EMG channels.

  • ref_meg (bool | str) – If True include CTF / 4D reference channels. If ‘auto’, reference channels are included if compensations are present and meg is not False. Can also be the string options for the meg parameter.

  • misc (bool) – If True include miscellaneous analog channels.

  • resp (bool) – If True include respiratory channels.

  • chpi (bool) – If True include continuous HPI coil channels.

  • exci (bool) – Flux excitation channel used to be a stimulus channel.

  • ias (bool) – Internal Active Shielding data (maybe on Triux only).

  • syst (bool) – System status channel information (on Triux systems only).

  • seeg (bool) – Stereotactic EEG channels.

  • dipole (bool) – Dipole time course channels.

  • gof (bool) – Dipole goodness of fit channels.

  • bio (bool) – Bio channels.

  • ecog (bool) – Electrocorticography channels.

  • fnirs (bool | str) – Functional near-infrared spectroscopy channels. If True include all fNIRS channels. If False (default) include none. If string it can be ‘hbo’ (to include channels measuring oxyhemoglobin) or ‘hbr’ (to include channels measuring deoxyhemoglobin).

  • csd (bool) – EEG-CSD channels.

  • dbs (bool) – Deep brain stimulation channels.

  • temperature (bool) – Temperature channels.

  • gsr (bool) – Galvanic skin response channels.

  • eyetrack (bool | str) – Eyetracking channels. If True include all eyetracking channels. If False (default) include none. If string it can be ‘eyegaze’ (to include eye position channels) or ‘pupil’ (to include pupil-size channels).

  • include (list of str) – List of additional channels to include. If empty do not include any.

  • exclude (list of str | str) – List of channels to exclude. If ‘bads’ (default), exclude channels in info['bads'].

  • selection (list of str) – Restrict sensor channels (MEG, EEG, etc.) to this list of channel names.

  • verbose (bool | 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:

inst (same type as the input data) – The modified instance.

See also

pick_channels

Notes

Added in version 0.9.0.