Preprocessor.bandpass_filter#

Preprocessor.bandpass_filter(template, lowpass, highpass, sampling_rate=None, gaussian_sigma=0.0)[source]#

Apply a band-pass filter on the provided template, using a Butterworth approximation.

Parameters:
templateNDArray

The input numpy array on which the band-pass filter should be applied.

lowpassfloat

The lower boundary of the frequency range to be preserved. Lower values will retain broader, more global features.

highpassfloat

The upper boundary of the frequency range to be preserved. Higher values will emphasize finer details and potentially noise.

sampling_rateNDarray, optional

The sampling rate along each dimension.

gaussian_sigmafloat, optional

Sigma value for the gaussian smoothing to be applied to the filter.

Returns:
NDArray

Bandpass filtered numpy array.