Welcome to vital_sqi’s documentation!

Note

Vital_SQI is a Python library designed for analyzing physiological signals (like ECG and PPG) and computing Signal Quality Indices (SQI).

The code of the project is 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
  • Using vital_sqi with VitalDSP
  • Conclusion
• 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
• Quickstart
  • Prerequisites
  • Getting Started
  • Using Preprocessing with VitalDSP
  • Example Use Case
  • Next Steps

Data Manipulation

• Import and load sample ECG & PPG
• Explain the signal object structure
  • The signal object contains the following attributes:
• Explore the ECG signal with different channels
  • We will manipulate the following features:

Pipeline

• Example analysis of a PPG/ECG waveform using the vital_sqi package
  • The pipeline can be briefly summarized as follows:
  • Global Imports

Documentation

• vital_sqi
  • vital_sqi package
• vital_sqi.pipeline package
  • Submodules
  • vital_sqi.pipeline.pipeline_functions module
  • vital_sqi.pipeline.pipeline_highlevel module
  • Module contents
• vital_sqi.sqi package
  • Submodules
  • vital_sqi.sqi.dtw_sqi module
  • vital_sqi.sqi.hrv_sqi module
  • vital_sqi.sqi.rpeaks_sqi module
  • vital_sqi.sqi.standard_sqi module
  • vital_sqi.sqi.waveform_sqi module
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page