Skip to content

NotchFilter

Bases: BaseClass

Class for applying for notch filtering.

Filters the input data using a notch filter with MNE's notch_filter() method.

MNE-function used: mne.io.Raw.notch_filter

Parameters:

Name Type Description Default
raw Raw | Epochs

Input data.

 required
freqs

Frequencies to notch filter in Hz.

 required
method
'iir'
**kwargs

Additional keyword arguments passed to MNE's notch_filter() method. Example: {'trans_bandwidth': 2, 'fir_window': 'blackman'}

 {}

Attributes:

Name Type Description
processed Raw | Epochs

Filtered output data.

Implements mne.io.Raw.notch_filter

Example settings for config file

Example settings in correct format for the config file.

NotchFilter:
  _biopap_module: <class 'biopap.modules.notch_filter.NotchFilter'>
  freqs: [60, 120, 180]
  method: 'fir'