IIRFilter¶

Bases: BaseClass

Class for applying IIR or FIR filtering.

Filters the input data using an FIR/IIR filter with MNE's filter() method.

Parameters:

Name	Type	Description	Default
`raw`	`Raw \| Epochs`	Input data.	required
`l_freq`	`float`	Low cutoff frequency in Hz.	required
`h_freq`	`float`	High cutoff frequency in Hz.	required
`order`	`int`	Order of the IIR filter.	`4`
`ftype`	`(butter, cheby1, cheby2, ellip, bessel)`	Type of IIR filter to design: `'butter'` (Butterworth) `'cheby1'` (Chebyshev I) `'cheby2'` (Chebyshev II) `'ellip'` (Cauer/elliptic) `'bessel'` (Bessel/Thomson)	`'butter'`
`method`			`'iir'`
`**kwargs`		Additional keyword arguments passed to MNE's `filter()` method. Example: {'fir_window': 'hann'}	`{}`

Attributes:

Name	Type	Description
`processed`	`Raw \| Epochs`	Filtered output data.

Example settings for config file¶

Example settings in correct format for the config file.

IIRFilter:
  _biopap_module: <class 'biopap.modules.iir_filter.IIRFilter'>
  l_freq: 0.1
  h_freq: 35
  order: 4
  ftype: 'butter'
  method: 'fir'

Please note that by setting method to either 'iir' or 'fir, this module can apply either an IIR-filter, or an FIR-filter.