detecta

Python module to detect events in data

The following functions are implemented in detecta:

• detect_peaks.py: detects peaks in data based on their amplitude and other features.
• detect_onset.py: detects onset in data based on amplitude threshold.
• detect_cusum.py: detects abrupt changes in data using cumulative sum algorithm (CUSUM).
• detect_seq.py: detects initial and final indices of sequential data identical to a parameter.

Installation

pip install detecta

The plots (parameter show=True) require matplotlib, which can be installed together with:

pip install "detecta[plot]"

Or

conda install -c duartexyz detecta

Examples

The examples are marimo notebooks in the docs directory. Run them in your browser, no installation needed:

Notebook	molab	marimo.app
detect_peaks
detect_onset
detect_cusum
detect_seq

The notebook name links to a static preview with the outputs; the badges run the notebook in your browser with WebAssembly.

Or run them locally:

uvx marimo edit --sandbox docs/detect_peaks.py

Other similar modules

• Overview of algorithms for peak detection in Python

How to cite this work

Here is a suggestion to cite this GitHub repository:

Marcos Duarte. (2021). detecta: A Python module to detect events in data (Version v0.0.5). Zenodo. http://doi.org/10.5281/zenodo.4598962

And a possible BibTeX entry:

@software{marcos_duarte_2021_4598962,
  author       = {Marcos Duarte},
  title        = {detecta: A Python module to detect events in data},
  month        = mar,
  year         = 2021,
  publisher    = {Zenodo},
  version      = {v0.0.5},
  doi          = {10.5281/zenodo.4598962},
  url          = {https://doi.org/10.5281/zenodo.4598962}
}

License

The non-software content of this project is licensed under a Creative Commons Attribution 4.0 International License, and the software code is licensed under the MIT license.