EOGChannels¶

Bases: BaseClass

Class for adding vertical and horizontal EOG channels.

Creates new bipolar channels from specified reference, anode, and cathode channels using MNE's set_bipolar_reference() function.

MNE-function used: mne.set_bipolar_reference

Parameters:

Name	Type	Description	Default
`raw`	`Raw \| Epochs`	Input data.	required
`ref_channels`	`list of str`	Reference channels used for the bipolar derivation.	`['hEOG', 'vEOG']`
`anode_channels`	`list of str`	Channels to use as the anode in the bipolar derivation.	`['EXG3', 'EXG5']`
`cathode_channels`	`list of str`	Channels to use as the cathode in the bipolar derivation.	`['EXG4', 'EXG6']`
`copy`	`bool`	If True, returns a copy of the data; otherwise, modifies in place.	`False`
`drop_refs`	`bool`	If True, drop the original reference channels after creating the bipolar channels.	`False`
`**kwargs`		Additional keyword arguments passed to MNE's `set_bipolar_reference()` function. Example: {'on_bad': 'ignore'}	`{}`

Attributes:

Name	Type	Description
`processed`	`Raw \| Epochs`	Output data with EOG channels.

Example settings for config file¶

Example settings in correct format for the config file.

EOGChannels:
  _biopap_module: <class 'biopap.modules.eog_channels.EOGChannels'>
  anode_channels:
  - EXG3
  - EXG5
  cathode_channels:
  - EXG4
  - EXG6
  ref_channels:
  - hEOG
  - vEOG
  drop_refs: false
  copy: false