pyActigraphy.light.LightMetricsMixin.filter_butterworth

LightMetricsMixin.filter_butterworth(fc_low, fc_high, N, channels=None)[source]

Butterworth filtering

Forward-backward digital filtering using a Nth order Butterworth filter

Parameters:

  • fc_low (float) – Critical frequency (lower).

  • fc_high (float) – Critical fequency (higher).

  • N (int) – Order of the filter

  • channels (list of str, optional.) – Channel list. If set to None, use all available channels. Default is None.

Returns:

filt – Filtered signal, per channel.

Return type:

pd.DataFrame

Notes

This function is essentially a wrapper to the scipy.signal.butter function. For more information, see [1].

References