Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
b8cb797
DOC: Clarify add_reference_channels usage with average reference
Dpereaptkhamur-13 Apr 8, 2026
e270d35
DOC: take over #13664 to clarify avg behavior and add towncrier
Dpereaptkhamur-13 Apr 16, 2026
5ecd0c0
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 16, 2026
f261a66
Merge branch 'main' into doc-ref-channel-clarification
Dpereaptkhamur-13 Apr 16, 2026
2231721
Merge branch 'main' into doc-ref-channel-clarification
Dpereaptkhamur-13 Apr 19, 2026
e110c7c
DOC: move and reformat avg ref note
Dpereaptkhamur-13 Apr 22, 2026
922c26f
Merge branch 'doc-ref-channel-clarification' of https://github.com/Dp…
Dpereaptkhamur-13 Apr 22, 2026
d39b245
Merge branch 'main' into doc-ref-channel-clarification
Dpereaptkhamur-13 Apr 22, 2026
c3ecfd2
DOC: address review - add sensor-space detail and citation
Dpereaptkhamur-13 Apr 23, 2026
2bef1d5
Merge branch 'doc-ref-channel-clarification' of https://github.com/Dp…
Dpereaptkhamur-13 Apr 23, 2026
dbee994
DOC: expand tutorial note to match sensor-space detail
Dpereaptkhamur-13 Apr 23, 2026
f26d305
DOC: remove irrelevant note from add_reference_channels
Dpereaptkhamur-13 Apr 23, 2026
effcec1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 23, 2026
7319a6d
Merge branch 'main' into doc-ref-channel-clarification
Dpereaptkhamur-13 May 1, 2026
a2eb16c
Update mne/utils/docs.py
Dpereaptkhamur-13 May 1, 2026
d6839bb
Update mne/utils/docs.py
Dpereaptkhamur-13 May 1, 2026
cbb0596
DOC: remove blank lines
Dpereaptkhamur-13 May 1, 2026
0d98056
DOC: fix citation details and alphabetize bibliography
Dpereaptkhamur-13 May 1, 2026
87cd94f
MAINT: update changelog name and text
Dpereaptkhamur-13 May 1, 2026
2b24fca
DOC: fix bibliography location, authors, and duplicate DOI
Dpereaptkhamur-13 May 3, 2026
2f33978
DOC: fix indentation in tutorial note
Dpereaptkhamur-13 May 3, 2026
6e49874
Update doc/changes/dev/13846.other.rst
Dpereaptkhamur-13 May 3, 2026
2549205
Merge branch 'main' into doc-ref-channel-clarification
Dpereaptkhamur-13 May 3, 2026
ec318e6
MAINT: add Deep Kaur to names.inc
Dpereaptkhamur-13 May 3, 2026
03a3501
Merge branch 'doc-ref-channel-clarification' of https://github.com/Dp…
Dpereaptkhamur-13 May 3, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changes/dev/13846.other.rst
Original file line number Diff line number Diff line change
@@ -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`.
1 change: 1 addition & 0 deletions doc/changes/names.inc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions doc/references.bib
Original file line number Diff line number Diff line change
Expand Up @@ -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},
Expand Down
7 changes: 7 additions & 0 deletions mne/utils/docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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']``.
Expand Down
7 changes: 7 additions & 0 deletions tutorials/preprocessing/55_setting_eeg_reference.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down