Functions

Detection

oxi_peaks(x[, sfreq, win, new_sfreq, …])

A simple peak finder for PPG signal.

hrv_subspaces(x[, alpha, window])

Plot hrv subspace as described by Lipponen & Tarvainen (2019).

interpolate_clipping(signal[, threshold])

Interoplate clipping segment.

Heart Rate Variability

nnX(x[, t])

Number of difference in successive R-R interval > t ms.

pnnX(x[, t])

Number of successive differences larger than a value (def = 50ms).

rmssd(x)

Root Mean Square of Successive Differences.

time_domain(x)

Extract all time domain parameters from R-R intervals.

frequency_domain(x[, sfreq, method, fbands])

Extract the frequency domain features of heart rate variability.

nonlinear(x)

Extract the frequency domain features of heart rate variability.

Plotting

plot_hr(x[, sfreq, outliers, unit, kind, ax])

Plot the instantaneous heart rate time course.

plot_events(oximeter[, ax])

Plot events occurence across recording.

plot_oximeter(x[, sfreq, ax])

Plot PPG signal.

plot_subspaces(x[, subspace2, subspace3, …])

Plot hrv subspace as described by Lipponen & Tarvainen (2019).

circular(data[, bins, density, offset, …])

Plot polar histogram.

plot_circular(data[, y, hue])

Plot polar histogram.

Recording

recording.Oximeter(serial[, sfreq, add_channels])

Recording PPG signal with Nonin pulse oximeter.

Utils

norm_triggers(x[, threshold, n, direction])

Turns noisy triggers into unique boolean.

time_shift(x, events[, order])

Return the delay between x and events.

heart_rate(x[, sfreq, unit, kind])

Transform peaks data into heart rate time series.

to_angles(x, events)

Angular values of events according to x cycle peaks.

to_epochs(x, events[, sfreq, tmin, tmax, …])

Epoch signal based on events indices.