BirdSongToolbox.preprocess.bandpass_filter

BirdSongToolbox.preprocess.bandpass_filter(neural_data, fs, l_freq, h_freq, remove_edges=False, verbose=False, \*\*kwargs)

Bandpass Filter Neural Data

Parameters

neural_data2d array, shape (channels, samples)

The Epoched Neural Data to be Bandpass Filtered

fsfloat

The sample frequency in Hz.

l_freqfloat | None

For FIR filters, the lower pass-band edge; for IIR filters, the upper cutoff frequency. If None the data are only low-passed.

h_freqfloat | None

For FIR filters, the upper pass-band edge; for IIR filters, the upper cutoff frequency. If None the data are only low-passed.

remove_edgesbool, optional, default: False

If True, replace samples within half the kernel length to be np.nan. Only used for FIR filters when using neurodsp.

vebosebool, optional, default: False

If True it will print out information about the filter used, (mne only)

Returns

filt_epochslist, shape (channels, samples)

The Neural Data Bandpass Filtered