mne_denoise.dss.PeakFilterBias

class mne_denoise.dss.PeakFilterBias(freq: float, sfreq: float, *, q_factor: float = 30.0, order: int = 2)

Second-order IIR peak-filter bias for DSS.

Parameters:

freqfloat

Target frequency in Hz.

sfreqfloat

Sampling frequency in Hz.

q_factorfloat, default=30.0

Quality factor passed to scipy.signal.iirpeak(); approximately, bandwidth = freq / q_factor.

orderint, default=2

Accepted and stored for API compatibility. The current implementation always designs the filter with scipy.signal.iirpeak() and this parameter does not change it.

apply(data: ndarray) → ndarray

Apply the peak-filter bias.

Parameters:

datandarray, shape (n_channels, n_times) or (n_channels, n_times, n_epochs)

Channel-first data.

Returns:

ndarray

Peak-filtered data with the input shape.