eegprep.pop_reref#

eegprep.pop_reref(EEG=<object object>, ref=<object object>, *args, gui=None, renderer=None, return_com=False, **kwargs)#

Convert an EEG dataset to average or common-reference data.

Numeric channel indices are 0-based to match existing EEGPrep channel selection APIs. String channel labels are resolved case-insensitively against EEG["chanlocs"]. Calling pop_reref(EEG) launches the GUI; pass ref=[] or ref=None for command-line average reference.

Parameters:

  • EEG (dict | list[dict] | object) – EEG dictionary, or a list of EEG dictionaries.

  • ref (Any) – None/[] for average reference, or reference channel label or 0-based index/index sequence for common reference.

  • *args (Any) – EEGLAB-style key/value options.

  • gui (bool | None) – Force or suppress the GUI entrypoint.

  • renderer (Any | None) – Optional GUI renderer for tests.

  • return_com (bool) – Return (EEG, command) when true.

  • **kwargs (Any) – Options such as exclude, keepref, refloc, refica, and huber.

Returns:

Re-referenced EEG, and optionally the EEGLAB-style command string.

Return type:

dict or tuple

On this page