Downsample¶

Bases: BaseClass

Class for downsampling EEG data to a lower sampling rate.

Applies MNE's built-in resample function to the input data.

Parameters:

Name	Type	Description	Default
`raw`	`Raw \| Epochs`	Input data.	required
`sfreq`	`int`	Target sampling rate in Hz.	required
`resample_events`	`bool`	Whether to resample event onsets along with the data.	`True`
`**kwargs`		Additional keyword arguments passed to MNE's `resample` method. Example:	`{}`

Attributes:

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

Example settings for config file¶

Example settings in correct format for the config file.

Downsample:
  _biopap_module: <class 'biopap.modules.downsample.Downsample'>
  sfreq: 500
  resample_events: True