Skip to content

API Reference

Complete reference documentation for all functions in the biosigmat toolbox.

Modules

ECG Processing

Functions for electrocardiography signal analysis and QRS detection.

Function Description Examples Status
baselineremove Removes baseline wander from biosignals using cubic spline interpolation. View code Beta
pantompkins Algorithm for R-wave detection in ECG signals. View code ✅ Stable
sloperange Compute ECG-derived respiration (EDR) using slope range method. View code Beta

HRV Analysis

Functions for heart rate variability analysis and metrics calculation.

Function Description Examples Status
fillgaps Fill gaps in HRV event series using iterative interpolation. View code Alpha
removefp Remove false positive detections from HRV event series. View code Alpha
tdmetrics Compute standard time-domain indices for heart rate variability analysis. View code ✅ Stable

PPG Processing

Functions for photoplethysmography signal analysis and pulse detection.

Function Description Examples Status
hjorthArtifacts Detects artifacts in physiological signals using Hjorth parameters. View code Alpha
pulsedelineation Performs pulse delineation in PPG signals using adaptive thresholding. View code Beta
pulsedetection Pulse detection in LPD-filtered PPG signals using configurable algorithms. View code Beta

RESP

Functions for resp processing.

Function Description Examples Status
tidalvolume Extracts upper and lower peak envelopes from a signal. View code ✅ Stable

General Tools

Utility functions for signal processing and data manipulation.

Function Description Status
findsequences Find sequences of repeated (adjacent/consecutive) numeric values. ✅ Stable
hjorth Computes Hjorth parameters (activity, mobility, and complexity) from a signal. ✅ Stable
interpgap Interpolate small NaN gaps in a signal. ✅ Stable
ispeaky Determines if spectra are considered peaky based on peakedness thresholds. ✅ Stable
localmax Finds local maxima in matrix rows or columns. Beta
lpdfilter Low-pass derivative filter. ✅ Stable
medfiltThreshold Compute median-filtered adaptive threshold. ✅ Stable
nanfilter Implements filter function with support for NaN values. ✅ Stable
nanfiltfilt Implements filtfilt function with support for NaN values. ✅ Stable
nanpwelch Compute Welch periodogram when signal has NaN segments. ✅ Stable
peakedness Computes the peakedness of power spectral density estimates. ✅ Stable
slicesignal Divide signal into overlapping segments. ✅ Stable
slider Creates and adds a scroll slider to a figure with time-based plots. ✅ Stable
snaptopeak Refine QRS detections by snapping to local maxima. ✅ Stable
trimnans Trim NaN values from the beginning and end of a signal. ✅ Stable

Function Index

Alphabetical Index

All functions sorted alphabetically:

Development Status Legend

  • ✅ Stable: Well-tested, production ready
  • Beta: Feature complete, undergoing testing
  • Alpha: Under development, API may change
  • Deprecated: No longer recommended for use

Last updated: 2025-09-04 | Total functions: 25