From 693d336fd81d39b72fd74144ffe16fd89d74cc50 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Fri, 27 Oct 2023 14:14:37 +0200 Subject: [PATCH] DOC: clarify ref_chs vs reref_chs --- pyprep/prep_pipeline.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/pyprep/prep_pipeline.py b/pyprep/prep_pipeline.py index a35922df..f54a66af 100644 --- a/pyprep/prep_pipeline.py +++ b/pyprep/prep_pipeline.py @@ -24,10 +24,13 @@ class PrepPipeline: - ref_chs : {list, 'eeg'} - A list of channel names to be used for rereferencing. + These channels will be used to construct the reference + signal. Can be a str 'eeg' to use all EEG channels. - reref_chs : {list, 'eeg'} - - A list of channel names to be used for line-noise removed, - and referenced. Can be a str 'eeg' to use all EEG channels. + - A list of channel names to define from which channels the + reference signal will be subtracted. + Can be a str 'eeg' to use all EEG channels. - line_freqs : {np.ndarray, list} - list of floats indicating frequencies to be removed. For example, for 60Hz you may specify