diff --git a/doc/changes/dev/13846.other.rst b/doc/changes/dev/13846.other.rst new file mode 100644 index 00000000000..ac0f5f9295f --- /dev/null +++ b/doc/changes/dev/13846.other.rst @@ -0,0 +1 @@ +Add notes to :func:`~mne.set_eeg_reference` and :ref:`_tut-set-eeg-ref` about the correct procedure to create an average reference, by :newcontrib:`Deep Kaur`. \ No newline at end of file diff --git a/doc/changes/names.inc b/doc/changes/names.inc index e20fad63acb..747ad10fe4b 100644 --- a/doc/changes/names.inc +++ b/doc/changes/names.inc @@ -71,6 +71,7 @@ .. _David Haslacher: https://github.com/davidhaslacher .. _David Julien: https://github.com/Swy7ch .. _David Sabbagh: https://github.com/DavidSabbagh +.. _Deep Kaur: https://github.com/Dpereaptkhamur-13 .. _Demetres Kostas: https://github.com/kostasde .. _Denis Engemann: https://denis-engemann.de .. _Dev Parikh: https://github.com/devparikh0506 diff --git a/doc/references.bib b/doc/references.bib index c7eefd9e808..ac1b2e39783 100644 --- a/doc/references.bib +++ b/doc/references.bib @@ -25,6 +25,15 @@ @article{GramfortEtAl2013a number = {267} } % everything else +@article{AppelhoffSanderson2023, + author = {Appelhoff, Stefan and Sanderson, Nathan J.}, + title = {The importance of adding a zero-filled channel for the reference electrode when re-referencing {EEG} data}, + journal = {Frontiers in Signal Processing}, + year = {2023}, + volume = {3}, + pages = {1064138}, + doi = {10.3389/frsip.2023.1064138}, +} @article{NolanEtAl2010, author = {Nolan, H. and Whelan, R. and Reilly, R. B.}, title = {{FASTER}: Fully Automated Statistical Thresholding for {EEG} artifact Rejection}, diff --git a/mne/utils/docs.py b/mne/utils/docs.py index 0cfcb788d0d..117b0ff67b1 100644 --- a/mne/utils/docs.py +++ b/mne/utils/docs.py @@ -4106,6 +4106,13 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75): EEG signal by setting ``ref_channels='average'``. Bad EEG channels are automatically excluded if they are properly set in ``info['bads']``. +.. note:: + When performing average referencing in sensor-space analyses and the original + reference electrode is not present as a zero-filled channel, this must first be + added using :func:`~mne.add_reference_channels`, before calling + :func:`~mne.set_eeg_reference`. This is necessary to avoid biasing the reference + :footcite:`AppelhoffSanderson2023`. + - A single electrode: Set ``ref_channels`` to a list containing the name of the channel that will act as the new reference, for example ``ref_channels=['Cz']``. diff --git a/tutorials/preprocessing/55_setting_eeg_reference.py b/tutorials/preprocessing/55_setting_eeg_reference.py index 770af624de7..6a7bef71902 100644 --- a/tutorials/preprocessing/55_setting_eeg_reference.py +++ b/tutorials/preprocessing/55_setting_eeg_reference.py @@ -146,6 +146,13 @@ # # Creating the average reference as a projector # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +# .. note:: +# When performing average referencing in sensor-space analyses and the original +# reference electrode is not present as a zero-filled channel, this must first be +# added using :func:`~mne.add_reference_channels` before calling +# :func:`~mne.set_eeg_reference`. This is necessary to avoid biasing the reference +# :footcite:`AppelhoffSanderson2023`. # # If using an average reference, it is possible to create the reference as a # :term:`projector` rather than subtracting the reference from the data