mne.preprocessing.cortical_signal_suppression#
- mne.preprocessing.cortical_signal_suppression(evoked, picks=None, mag_picks=None, grad_picks=None, n_proj=6, *, verbose=None)[source]#
Apply cortical signal suppression (CSS) to evoked data.
- Parameters:
- evokedinstance of
Evoked The evoked object to use for CSS. Must contain magnetometer, gradiometer, and EEG channels.
- picks
str| array_like |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. Note that channels ininfo['bads']will be included if their names or indices are explicitly provided.- mag_picksarray_like of
int Array of the first set of channel indices that will be used to find the common temporal subspace. If None (default), all magnetometers will be used.
- grad_picksarray_like of
int Array of the second set of channel indices that will be used to find the common temporal subspace. If None (default), all gradiometers will be used.
- n_proj
int The number of projection vectors.
- verbosebool |
str|int|None Control verbosity of the logging output. If
None, use the default verbosity level. See the logging documentation andmne.verbose()for details. Should only be passed as a keyword argument.
- evokedinstance of
- Returns:
- evoked_subcorticalinstance of
Evoked The evoked object with contributions from the
mag_picksandgrad_pickschannels removed from thepickschannels.
- evoked_subcorticalinstance of
Notes
This method removes the common signal subspace between two sets of channels (
mag_picksandgrad_picks) from a set of channels (picks) via a temporal projection usingn_projnumber of projection vectors. In the reference publication [1], the joint subspace between magnetometers and gradiometers is used to suppress the cortical signal in the EEG data. In principle, other combinations of sensor types (or channels) could be used to suppress signals from other sources.References
Examples using mne.preprocessing.cortical_signal_suppression#
Cortical Signal Suppression (CSS) for removal of cortical signals