mne.set_eeg_reference¶
-
mne.
set_eeg_reference
(inst, ref_channels='average', copy=True, projection=False, ch_type='auto', verbose=None)[source]¶ Specify which reference to use for EEG data.
By default, MNE-Python will automatically re-reference the EEG signal to use an average reference (see below). Use this function to explicitly specify the desired reference for EEG. This can be either an existing electrode or a new virtual channel. This function will re-reference the data according to the desired reference and prevent MNE-Python from automatically adding an average reference projection.
Some common referencing schemes and the corresponding value for the
ref_channels
parameter:- No re-referencing:
If the EEG data is already using the proper reference, set
ref_channels=[]
. This will prevent MNE-Python from automatically adding an average reference projection.- Average reference:
A new virtual reference electrode is created by averaging the current EEG signal by setting
ref_channels='average'
. Bad EEG channels are automatically excluded if they are properly set ininfo['bads']
.- A single electrode:
Set
ref_channels
to a list containing the name of the channel that will act as the new reference, for exampleref_channels=['Cz']
.- The mean of multiple electrodes:
A new virtual reference electrode is created by computing the average of the current EEG signal recorded from two or more selected channels. Set
ref_channels
to a list of channel names, indicating which channels to use. For example, to apply an average mastoid reference, when using the 10-20 naming scheme, setref_channels=['M1', 'M2']
.
- Parameters
- instinstance of
Raw
|Epochs
|Evoked
Instance of Raw or Epochs with EEG channels and reference channel(s).
- ref_channels
list
ofstr
|str
The name(s) of the channel(s) used to construct the reference. To apply an average reference, specify
'average'
here (default). If an empty list is specified, the data is assumed to already have a proper reference and MNE will not attempt any re-referencing of the data. Defaults to an average reference.- copybool
Specifies whether the data will be copied (True) or modified in-place (False). Defaults to True.
- projectionbool
If
ref_channels='average'
this argument specifies if the average reference should be computed as a projection (True) or not (False; default). Ifprojection=True
, the average reference is added as a projection and is not applied to the data (it can be applied afterwards with theapply_proj
method). Ifprojection=False
, the average reference is directly applied to the data. Ifref_channels
is not'average'
,projection
must be set toFalse
(the default in this case).- ch_type‘auto’ | ‘eeg’ | ‘ecog’ | ‘seeg’
The name of the channel type to apply the reference to. If ‘auto’, the first channel type of eeg, ecog or seeg that is found (in that order) will be selected.
New in version 0.19.
- verbosebool,
str
,int
, orNone
If not None, override default verbose level (see
mne.verbose()
and Logging documentation for more).
- instinstance of
- Returns
- instinstance of
Raw
|Epochs
|Evoked
Data with EEG channels re-referenced. If
ref_channels='average'
andprojection=True
a projection will be added instead of directly re-referencing the data.- ref_data
array
Array of reference data subtracted from EEG channels. This will be
None
ifref_channels='average'
andprojection=True
.
- instinstance of
See also
set_bipolar_reference
Convenience function for creating bipolar references.
Notes
If a reference is requested that is not the average reference, this function removes any pre-existing average reference projections.
During source localization, the EEG signal should have an average reference.
In order to apply a reference, the data must be preloaded. This is not necessary if
ref_channels='average'
andprojection=True
.For an average reference, bad EEG channels are automatically excluded if they are properly set in
info['bads']
.
New in version 0.9.0.