Welcome to vital_sqi’s documentation!

Note

vital_sqi is a Python library for analysing physiological signals (ECG, PPG) and computing Signal Quality Indices (SQI). It bundles classical SQIs from the literature, a calibrated rule engine, a robust multi-regime classifier, and a calibration toolkit for deriving thresholds from synthetic noise sweeps.

Source code lives on GitHub.

Getting Started

• Installation Guide
  • Prerequisites
  • Installation Steps
  • Verifying the Installation
  • Updating vital_sqi
  • Uninstallation
  • Issues and Support
• Introduction
  • Background
  • SQI Indexes
  • Detailed SQI Descriptions
  • Peak Detection
  • Classification modes
  • Using vital_sqi with VitalDSP
  • Conclusion
• Quickstart
  • Prerequisites
  • Getting Started
  • Using Preprocessing with VitalDSP
  • Example Use Case
  • End-to-end pipeline with auto-tuned classifier
  • Next Steps

User Guide

• SQI Pipeline and Calibration
  • Part 1 — SQI Extraction Pipeline
  • Part 2 — SQI Catalogue
  • Part 3 — Rule-Based Classification
  • Part 4 — Peak Detection Algorithms
  • Part 5 — Calibration System
  • Part 6 — Complete End-to-End Example
  • Performance Notes
  • Numerical Edge Cases
  • See Also
• The vital_sqi web app
  • Launching the app
  • Sidebar overview
  • The Compute view
  • The Inspect view
  • The Calibrate view (Phase 3)
  • The Export view
  • How state flows between views
  • Troubleshooting
  • What’s coming
  • See also
• Contributions
  • Creating a Virtual Environment
  • Forking the Repository
  • Setting Up Your Fork Locally
  • Understanding the Repository Structure
  • Installing the Package in Editable Mode
  • Generating Documentation
  • Running Tests
  • Submitting Contributions
  • Helpful Tips
• Development Guide
  • Setting Up a Development Environment
  • Development Workflow
  • Code Style and Guidelines
  • Testing
  • Documentation Updates
  • Contributing
  • Support

Tutorials

• Import and load sample ECG & PPG
• Explain the signal object structure
• Explore the ECG signal with different channels
• Example analysis of a PPG/ECG waveform using the vital_sqi package

API Reference

• Signal Quality Indices (vital_sqi.sqi)
  • Standard statistical SQIs
  • Waveform / spectral SQIs
  • R-peak based SQIs
  • Heart-rate-variability SQIs
  • Dynamic time warping SQI
• Pipeline (vital_sqi.pipeline)
  • High-level entry points
  • Core pipeline functions
• Calibration (vital_sqi.calibration)
  • Top-level runner
  • Synthetic signal generation
  • Noise injection
  • Batch SQI computation
  • Threshold estimator
  • Exporter
• Rule engine (vital_sqi.rule)
  • Auto-threshold strategies
  • Single-SQI rule
  • Composite rule set
  • Robust auto-classifier
• Preprocess (vital_sqi.preprocess)
  • Tapering & smoothing
  • Removal utilities
  • Segment splitter
• Common utilities (vital_sqi.common)
  • Band-pass filter
  • R-peak detection
  • Template generation
  • Power spectrum
  • Utilities
• Data I/O (vital_sqi.data)
  • Signal I/O
  • SignalSQI container
• Bundled datasets (vital_sqi.dataset)
  • load_ecg()
  • load_ppg()

Indices and tables

• Index

• Module Index

• Search Page