clean

ECG cleaning methods.

Machine-readable model

• cleanfunctionClean ECG signal by applying biquad filter.
• square_filter_maskfunctionMask out RR intervals that fall outside bounds.

function

clean

Python

Clean ECG signal by applying biquad filter.

physiokit/ecg/clean.py:9

clean(
    data: npt.NDArray,
    lowcut: float = 0.5,
    highcut: float = 30,
    sample_rate: float = 1000,
    order: int = 3,
    axis: int = -1,
    forward_backward: bool = True,
) -> npt.NDArray

Clean ECG signal by applying biquad filter.

By default, a 3rd order Butterworth bandpass filter from 0.5 to 30 Hz is applied.

Parameters

Parameters of clean

Name	Type	Default	Description
data	npt.NDArray	Required	ECG signal.
lowcut	float	0.5	Lower cutoff in Hz. Defaults to 0.5 Hz.
highcut	float	30	Upper cutoff in Hz. Defaults to 30 Hz.
sample_rate	float	1000	Sampling rate in Hz. Defaults to 1000 Hz.
order	int	3	Filter order. Defaults to 3 (3rd order Butterworth filter).
axis	int	-1	Axis to apply against. Defaults to -1.
forward_backward	bool	True	Apply filter forward and backward. Defaults to True.

Returns

Returns of clean

Type	Description
npt.NDArray	npt.NDArray: Cleaned ECG signal.

function

square_filter_mask

Python

Mask out RR intervals that fall outside bounds.

physiokit/ecg/clean.py:49

square_filter_mask(rr_ints: npt.NDArray, lowcut: float = 300, highcut: float = 900) -> npt.NDArray

Mask out RR intervals that fall outside bounds.

Parameters

Parameters of square_filter_mask

Name	Type	Default	Description
rr_ints	npt.NDArray	Required	RR-interval list in ms.
lowcut	float	300	Lower cutoff limit. Defaults to 300 ms.
highcut	float	900	Upper cutoff limit. Defaults to 900 ms.

Returns

Returns of square_filter_mask

Type	Description
npt.NDArray	npt.NDArray: RR rejection mask 0=accept, 1=reject.