Skip to main content

A toolbox for biosignal processing written in Python.

Project description


# BioSPPy - Biosignal Processing in Python

*A toolbox for biosignal processing written in Python.*

[![Image](https://github.com/PIA-Group/BioSPPy/raw/master/docs/logo/logo_400.png "I know you're listening! - xkcd.com/525")](http://biosppy.readthedocs.org/)

The toolbox bundles together various signal processing and pattern recognition
methods geared towards the analysis of biosignals.

Highlights:

- Support for various biosignals: BVP, ECG, EDA, EEG, EMG, Respiration
- Signal analysis primitives: filtering, frequency analysis
- Clustering
- Biometrics

Documentation can be found at: <http://biosppy.readthedocs.org/>

## Installation

Installation can be easily done with `pip`:

```bash
$ pip install biosppy
```

## Simple Example

The code below loads an ECG signal from the `examples` folder, filters it,
performs R-peak detection, and computes the instantaneous heart rate.

```python
from biosppy import storage
from biosppy.signals import ecg

# load raw ECG signal
signal, mdata = storage.load_txt('./examples/ecg.txt')

# process it and plot
out = ecg.ecg(signal=signal, sampling_rate=1000., show=True)
```

This should produce a plot similar to the one below.

[![Image](https://github.com/PIA-Group/BioSPPy/raw/master/docs/images/ECG_summary.png "ECG Summary Plot")]()

## Dependencies

- bidict
- h5py
- matplotlib
- numpy
- scikit-learn
- scipy
- shortuuid
- six

## Citing
Please use the following if you need to cite BioSPPy:

- Carreiras C, Alves AP, Lourenço A, Canento F, Silva H, Fred A, *et al.*
**BioSPPy - Biosignal Processing in Python**, 2015-,
https://github.com/PIA-Group/BioSPPy/ [Online; accessed ```<year>-<month>-<day>```].

```latex
@Misc{,
author = {Carlos Carreiras and Ana Priscila Alves and Andr\'{e} Louren\c{c}o and Filipe Canento and Hugo Silva and Ana Fred and others},
title = {{BioSPPy}: Biosignal Processing in {Python}},
year = {2015--},
url = "https://github.com/PIA-Group/BioSPPy/",
note = {[Online; accessed <today>]}
}
```

## License

BioSPPy is released under the BSD 3-clause license. See LICENSE for more details.

## Disclaimer

This program is distributed in the hope it will be useful and provided
to you "as is", but WITHOUT ANY WARRANTY, without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. This
program is NOT intended for medical diagnosis. We expressly disclaim any
liability whatsoever for any direct, indirect, consequential, incidental
or special damages, including, without limitation, lost revenues, lost
profits, losses resulting from business interruption or loss of data,
regardless of the form of action or legal theory under which the
liability may be asserted, even if advised of the possibility of such
damages.


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

biosppy-0.6.0.tar.gz (69.8 kB view details)

Uploaded Source

Built Distribution

biosppy-0.6.0-py2.py3-none-any.whl (79.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file biosppy-0.6.0.tar.gz.

File metadata

  • Download URL: biosppy-0.6.0.tar.gz
  • Upload date:
  • Size: 69.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.4

File hashes

Hashes for biosppy-0.6.0.tar.gz
Algorithm Hash digest
SHA256 ea3011c602d7a559179556c14c48c2aabf22251fb79e97bc44824e136d20dbe5
MD5 80d4a0fd7b7b7efa5dc0b0f4f98668d3
BLAKE2b-256 d4b97755775b0aefeb33ab0b60b393187ed2a05fefe0de566061fce7585b131f

See more details on using hashes here.

File details

Details for the file biosppy-0.6.0-py2.py3-none-any.whl.

File metadata

  • Download URL: biosppy-0.6.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 79.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.4

File hashes

Hashes for biosppy-0.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4df8849c35c42345381c4edf3a9ce6616b7658fc34be825ce9c9c0a7401dfd92
MD5 587920594ab0d9a214b29e9b76b3f9ec
BLAKE2b-256 204d14ca7082dea6ed51f15ce0836801b97b196d14f8a8816fd93082bf67028c

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