Metadata-Version: 2.1
Name: ampdLib
Version: 1.1.3
Summary: Implementation of AMPD algorithm for peak detection in quasi-periodic signals
Project-URL: homepage, https://github.com/LucaCerina/ampdLib
Keywords: peak detection,signal processing,quasi-periodic signals
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: tests
License-File: LICENSE

README.md rev. 10 Feb 2023 by Luca Cerina.
Copyright (c) 2023 Luca Cerina.
Distributed under the Apache 2.0 License in the accompanying file LICENSE.

# Automatic Multiscale-based Peak Detection (AMPD)

ampdLib implements automatic multiscale-based peak detection (AMPD) algorithm
as in An Efficient Algorithm for Automatic Peak Detection in Noisy Periodic and
Quasi-Periodic Signals, by Felix Scholkmann, Jens Boss and Martin Wolf,
Algorithms 2012, 5, 588-603.

### Python required dependencies
- Python > 3
- Numpy
- Scipy for tests

### Installation
The library can be easily installed with setuptools support using `pip install .` or via PyPI with `pip install ampdlib`

### Tests
The tests folder contains an ECG signal with annotated peaks in matlab format.

#### Contribution
If you feel generous and want to show some extra appreciation:

[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]

[buymeacoffee]: https://www.buymeacoffee.com/u2Vb3kO
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
