Rereference¶

Bases: BaseClass

Class for rereferencing EEG data.

Applies MNE's set_eeg_reference() function to the input data.

Parameters:

Name	Type	Description	Default
`raw`	`Raw \| Epochs`	Input data.	required
`ref_channels`	`list of str`	Reference channel names to subtract from the EEG channels.	`['EXG1', 'EXG2']`
`copy`	`bool`	If True, returns a copy of the data; otherwise modifies in place.	`False`
`**kwargs`		Additional keyword arguments passed to MNE's `set_eeg_reference()` function.	`{}`

Attributes:

Name	Type	Description
`processed`	`Raw \| Epochs`	Output data after rereferencing.

Example settings for config file¶

Example settings in correct format for the config file.

Rereference:
  _biopap_module: <class 'biopap.modules.rereference.Rereference'>
  ref_channels:
  - EXG1
  - EXG2
  ch_type: auto
  copy: false