Skip to main content

Python wrapper for CallibriECG library

Project description

Mathematical library for working with ECG data from the Callibri sensor.

The main functionality is the calculation of cardio-interval lengths, heart rate and Stress Index (SI).

During the first 6 seconds the algorithm is learning, if no 5 RR-intervals are found in the signal 5 RR-intervals are not found, the training is repeated. Further work with the library is iterative (adding new data, calculating indicators).

Initialization

Determine the basic parameters

  1. Raw signal sampling frequency. Integer type. The allowed values are 250 or 1000.
  2. Data processing window size. Integer type. Valid values of sampling_rate / 4 or sampling_rate / 2.
  3. Number of windows to calculate SI. Integer type. Allowable values [20...50].
  4. The averaging parameter of the IN calculation. Default value is 6.

Creating a library instance

Firstly you need to determine lybrary parameters and then put them to library. Tne next step is initialize the filters. In the current version the filters are built-in and clearly defined: Butterworth 2nd order BandPass 5_15 Hz.

You can initialize averaging for SI calculation. It is optional value.

# 1. Raw signal sampling frequency
samplingRate = 250
# 2. Data processing window size
dataWindow = samplingRate / 2
# 3. Number of windows to calculate SI
nwinsForPressureIndex = 30
callibri_math = CallibriMath(samplingRate, dataWindow, nwinsForPressureIndex)
callibri_math.init_filter()

# optional
# 4. The averaging parameter of the IN calculation. Default value is 6.
pressureIndexAverage = 6
callibri_math.set_pressure_average(pressureIndexAverage)

Initializing a data array for transfer to the library:

The size of the transmitted array has to be of a certain length:

  • 25 values for a signal frequency of 250 Hz
  • 100 values for a signal frequency of 1000 Hz
rawData = [float(x) for x in range(25)]
# or
rawData = [float(x) for x in range(100)]

Optional functions (not necessary for the library to work)

Check for initial signal corruption. This method should be used if you want to detect and notify of a distorted signal explicitly.

if callibri_math.initial_signal_corrupted():
    # Signal corrupted!!!

Work with the library

  1. Adding and process data:
callibri_math.push_data(samples)
callibri_math.process_data_arr()
  1. Getting the results:
if callibri_math.rr_detected():
    # check for a new peak in the signal
    # RR-interval length
    rr = math.get_rr()
    # HR     
    hr = math.get_hr()
    # SI
    pi = math.get_pressure_index()
    # Moda
    moda = math.get_moda()
    # Amplitude of mode
    amplModa = math.get_ampl_moda()
    # Variation range
    variationDist = math.get_variation_dist()
    callibri_math.set_rr_checked()

Finishing work with the library:

del callibri_math

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycallibri_ecg-1.0.2.tar.gz (358.4 kB view details)

Uploaded Source

File details

Details for the file pycallibri_ecg-1.0.2.tar.gz.

File metadata

  • Download URL: pycallibri_ecg-1.0.2.tar.gz
  • Upload date:
  • Size: 358.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pycallibri_ecg-1.0.2.tar.gz
Algorithm Hash digest
SHA256 22962f66452f933ec985fb92653b61dfafa33c110b428f073bbeea923eb5cc21
MD5 d8e8285ccfc75c7474a24374bdb35fdf
BLAKE2b-256 1f190f96c71ab43bb00c90074024aaafd9b4bc54bca0170f7220c2b4aa3b056c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page