https://github.com/halleysfifthinc/peaks.jl

Find peaks (local extrema) of signals
https://github.com/halleysfifthinc/peaks.jl

extrema find-peaks findpeaks julia maxima minima

Last synced: 25 days ago
JSON representation

Find peaks (local extrema) of signals

• Host: GitHub
• URL: https://github.com/halleysfifthinc/peaks.jl
• Owner: halleysfifthinc
• License: mit
• Created: 2018-03-26T01:04:12.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2025-02-01T22:09:53.000Z (3 months ago)
• Last Synced: 2025-03-29T00:05:41.655Z (about 1 month ago)
• Topics: extrema, find-peaks, findpeaks, julia, maxima, minima
• Language: Julia
• Homepage: https://halleysfifthinc.github.io/Peaks.jl/
• Size: 1.54 MB
• Stars: 75
• Watchers: 4
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Peaks.jl

[![version](https://juliahub.com/docs/General/Peaks/stable/version.svg)](https://juliahub.com/ui/Packages/General/Peaks)

[![pkgeval](https://juliahub.com/docs/General/Peaks/stable/pkgeval.svg)](https://juliahub.com/ui/Packages/General/Peaks)

[![stable-docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://halleysfifthinc.github.io/Peaks.jl/stable)

[![dev-docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://halleysfifthinc.github.io/Peaks.jl/dev)

[![CI](https://github.com/halleysfifthinc/Peaks.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/halleysfifthinc/Peaks.jl/actions/workflows/CI.yml)

[![codecov](https://codecov.io/gh/halleysfifthinc/Peaks.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/halleysfifthinc/Peaks.jl)

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

Peaks.jl contains peak (local extrema) finding functions for vector data. Visit the documentation for a complete introduction, how-to guide, and reference. Contributions welcome.

[![signal-with-peaks-prominences-and-widths](docs/src/assets/images/maxima_prom_width.png)](#)

## Features

- Find peak (maxima or minima) locations, height, prominence, and width

    - Filter peaks by peak spacing (window size), height, prominence, and width (including "Full Width Half Maximum (FWHM)")

- Fully supports `NaN`/`missing` with optional tolerance using keyword arg `strict`:

    - Conventional handling/propagation of `NaN`/`missing` when `strict = true` (the default)

    - Reasonable alternatives when `strict = false`

## Related

- [**Images.jl**](https://github.com/JuliaImages/Images.jl)

  - [`findlocalmaxima`](https://juliaimages.org/stable/function_reference/#Images.findlocalmaxima)/[`findlocalminima`](https://juliaimages.org/stable/function_reference/#Images.findlocalminima)

    - Supports more than 1 dimension

    - Doesn't support `missing`, different window sizes