Skip to content
physioKIT
API Reference
HELIA

peaks

Machine-readable model

function

Find R peaks in ECG signal using QRS gradient method.

physiokit/ecg/peaks.py:7

find_peaks(
data: npt.NDArray,
sample_rate: float = 1000,
qrs_window: float = 0.1,
avg_window: float = 1.0,
qrs_prom_weight: float = 1.5,
qrs_min_len_weight: float = 0.4,
qrs_min_delay: float = 0.3,
) -> npt.NDArray

Find R peaks in ECG signal using QRS gradient method.

Parameters of find_peaks
NameTypeDefaultDescription
dataarrayRequiredECG signal.
sample_ratefloat1000Sampling rate in Hz. Defaults to 1000 Hz.
qrs_windowfloat0.1Window size in seconds to compute QRS gradient. Defaults to 0.1 s.
avg_windowfloat1.0Window size in seconds to compute average gradient. Defaults to 1.0 s.
qrs_prom_weightfloat1.5Weight to compute minimum QRS height. Defaults to 1.5.
qrs_min_len_weightfloat0.4Weight to compute minimum QRS length. Defaults to 0.4.
qrs_min_delayfloat0.3Minimum delay between QRS complexes. Defaults to 0.3 s.
Returns of find_peaks
TypeDescription
npt.NDArraynpt.NDArray: R peaks.
function

Filter out peaks with RR intervals outside of normal range.

physiokit/ecg/peaks.py:84

filter_peaks(
peaks: npt.NDArray,
sample_rate: float = 1000,
min_rr: float = 0.3,
max_rr: float = 2.0,
min_delta: float | None = 0.3,
) -> npt.NDArray

Filter out peaks with RR intervals outside of normal range.

Parameters of filter_peaks
NameTypeDefaultDescription
peaksarrayRequiredR peaks.
sample_ratefloat1000Sampling rate in Hz. Defaults to 1000 Hz.
min_rrfloat0.3Minimum RR interval in seconds. Defaults to 0.3 s.
max_rrfloat2.0Maximum RR interval in seconds. Defaults to 2.0 s.
min_deltafloat0.3Minimum RR interval delta. Defaults to 0.3.
Returns of filter_peaks
TypeDescription
npt.NDArraynpt.NDArray: Filtered peaks.
function

Compute RR intervals from R peaks.

physiokit/ecg/peaks.py:118

compute_rr_intervals(peaks: npt.NDArray) -> npt.NDArray

Compute RR intervals from R peaks.

Parameters of compute_rr_intervals
NameTypeDefaultDescription
peaksarrayRequiredR peaks.
Returns of compute_rr_intervals
TypeDescription
npt.NDArraynpt.NDArray: RR intervals.
function

Filter out peaks with RR intervals outside of normal range.

physiokit/ecg/peaks.py:137

filter_rr_intervals(
rr_ints: npt.NDArray,
sample_rate: float = 1000,
min_rr: float = 0.3,
max_rr: float = 2.0,
min_delta: float | None = 0.3,
) -> npt.NDArray

Filter out peaks with RR intervals outside of normal range.

Parameters of filter_rr_intervals
NameTypeDefaultDescription
rr_intsarrayRequiredRR intervals.
sample_ratefloat1000Sampling rate in Hz. Defaults to 1000 Hz.
min_rrfloat0.3Minimum RR interval in seconds. Defaults to 0.3 s.
max_rrfloat2.0Maximum RR interval in seconds. Defaults to 2.0 s.
min_deltafloat0.3Minimum RR interval delta. Defaults to 0.3.
Returns of filter_rr_intervals
TypeDescription
npt.NDArraynpt.NDArray: RR interval mask.