findpeaks
The detection of peaks and valleys in a 1d-vector or 2d-array (image)
Science Score: 64.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 8 committers (12.5%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.5%) to scientific vocabulary
Keywords
Repository
The detection of peaks and valleys in a 1d-vector or 2d-array (image)
Basic Info
- Host: GitHub
- Owner: erdogant
- License: other
- Language: Jupyter Notebook
- Default Branch: master
- Homepage: https://erdogant.github.io/findpeaks
- Size: 62.3 MB
Statistics
- Stars: 264
- Watchers: 9
- Forks: 37
- Open Issues: 0
- Releases: 45
Topics
Metadata Files
README.md
findpeaks
findpeaks is a comprehensive Python library for robust detection and analysis of peaks and valleys in both 1D vectors and 2D arrays (images). The library provides multiple detection algorithms including topology-based persistent homology (most robust), mask-based local maximum filtering, and traditional peakdetect approaches. It can be used for time series analysis, signal processing, image analysis, and spatial data. ⭐️Star it if you like it⭐️
Star History
Key Features
| Feature | Description | Medium | Gumroad & Podcast | |--------|-------------| - | - | | Topology Detection | Mathematically grounded peak detection using persistent homology. | - | - | | Peakdetect Method | Peak detection algorithm for noisy signals. | link | link | | Mask Detection | Local maximum filtering for 2D image analysis. | - | - | | Caerus Method | Specialized algorithm for financial time series analysis. | - | - | | Preprocessing | Denoising, scaling, interpolation, and image preprocessing. | - | - | | Visualization | Rich plotting capabilities including persistence diagrams and 3D mesh plots. | - | - |
Resources and Links
- Example Notebooks: Examples
- Blog Posts: Medium
- Documentation: Website
- Bug Reports and Feature Requests: GitHub Issues
Background
Topology Method: The most robust detection method based on persistent homology from topological data analysis. It quantifies peak significance through persistence scores and provides mathematically stable results even in noisy data.
Peakdetect Method: Traditional algorithm that excels at finding local maxima and minima in noisy signals without requiring extensive preprocessing. Uses a lookahead approach to distinguish between true peaks and noise-induced fluctuations.
Mask Method: Local maximum filtering approach specifically designed for 2D data (images). Employs 8-connected neighborhood analysis and background removal for spatial peak detection.
Preprocessing Pipeline: Comprehensive preprocessing capabilities including interpolation, denoising (Lee, Frost, Kuan filters), scaling, and image resizing to improve detection accuracy.
Installation
Install findpeaks from PyPI
bash
pip install findpeaks
Install from Github source
bash
pip install git+https://github.com/erdogant/findpeaks
Import Library
```python import findpeaks print(findpeaks.version)
Import library
from findpeaks import findpeaks ```
Quick Start
```python
Import library
from findpeaks import findpeaks
Initialize with topology method (most robust)
fp = findpeaks(method='topology')
Example data
X = fp.import_example('1dpeaks')
Peak detection
results = fp.fit(X)
Plot results
fp.plot()
Plot persistence diagram
fp.plot_persistence() ```
Examples
1D Signal Analysis
2D Image Analysis
Financial Time Series
SAR/SONAR Image Processing
Image Denoising
References
- https://github.com/erdogant/findpeaks
- https://github.com/Anaxilaus/peakdetect
- https://www.sthu.org/blog/13-perstopology-peakdetection/index.html
Contributors
Special thanks to the contributors!
Maintainer
- Erdogan Taskesen, github: erdogant
- Contributions are welcome.
- Yes! This library is entirely free but it runs on coffee! :) Feel free to support with a Coffee.
Owner
- Name: Erdogan
- Login: erdogant
- Kind: user
- Location: Den Haag
- Website: https://erdogant.github.io/
- Repositories: 51
- Profile: https://github.com/erdogant
Machine Learning | Statistics | Bayesian | D3js | Visualizations
Citation (CITATION.cff)
# YAML 1.2
---
authors:
-
family-names: Taskesen
given-names: Erdogan
orcid: "https://orcid.org/0000-0002-3430-9618"
cff-version: "1.1.0"
date-released: 2020-10-07
keywords:
- "python"
- "peak-detection"
- "peak-analysis"
- "topology"
- "mesh"
- "speckle-noise"
- "sonar"
- "sar"
- "mask"
license: "MIT"
message: "If you use this software, please cite it using these metadata."
repository-code: "https://erdogant.github.io/findpeaks"
title: "Findpeaks: The detection of peaks and valleys in a 1D vector and 2D arrays."
version: "2.3.1"
...
GitHub Events
Total
- Create event: 3
- Release event: 5
- Issues event: 3
- Watch event: 27
- Issue comment event: 8
- Push event: 33
- Pull request review event: 1
- Pull request event: 4
- Fork event: 7
Last Year
- Create event: 3
- Release event: 5
- Issues event: 3
- Watch event: 27
- Issue comment event: 8
- Push event: 33
- Pull request review event: 1
- Pull request event: 4
- Fork event: 7
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| erdogant | e****t@g****m | 361 |
| Caroline Sophie Goehner | c****r@e****u | 4 |
| carolinegoehner | c****r@w****e | 3 |
| Timothy Kohler | 7****t | 1 |
| Kristian Radoš | 4****l | 1 |
| Doug Strain | d****n@g****m | 1 |
| Blair Bonnett | b****t@g****m | 1 |
| Arvin Nick | a****0@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 28
- Total pull requests: 14
- Average time to close issues: 3 months
- Average time to close pull requests: 11 days
- Total issue authors: 23
- Total pull request authors: 8
- Average comments per issue: 2.61
- Average comments per pull request: 1.71
- Merged pull requests: 12
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 5
- Average time to close issues: N/A
- Average time to close pull requests: 7 days
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.6
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- mmarras (3)
- Fraetor (2)
- allran (2)
- ollielo (2)
- martijnende (1)
- SubhranshuSharma (1)
- masawdah (1)
- pintergreg (1)
- rose-jinyang (1)
- matthewkuner (1)
- gothery (1)
- Tom89757 (1)
- ftmtas212 (1)
- Kenneth-new-user (1)
- subhacom (1)
Pull Request Authors
- carolinegoehner (4)
- martinuray (3)
- arvinnick (2)
- kohlert (2)
- dstrain115 (2)
- BunningsWarehouseOfficial (2)
- bcbnz (1)
- Fraetor (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 1,978 last-month
- Total docker downloads: 7,835
- Total dependent packages: 5
- Total dependent repositories: 5
- Total versions: 43
- Total maintainers: 1
pypi.org: findpeaks
findpeaks is for the detection of peaks and valleys in a 1D vector and 2D array (image).
- Homepage: https://erdogant.github.io/findpeaks
- Documentation: https://findpeaks.readthedocs.io/
- License: MIT License Copyright (c) 2020 Erdogan Taskesen findpeaks - Python package Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
Latest release: 2.7.4
published 7 months ago
Rankings
Maintainers (1)
Dependencies
- pipinstallsphinx_rtd_theme *
- irelease * development
- nbconvert * development
- numpy * development
- pytest * development
- rst2pdf * development
- sphinx * development
- sphinx_rtd_theme * development
- sphinxcontrib-fulltoc * development
- spyder-kernels ==2.3. development
- caerus *
- matplotlib *
- numpy *
- opencv-python *
- pandas *
- peakdetect ==1.1
- requests *
- scipy *
- tqdm *
- caerus *
- matplotlib *
- numpy *
- pandas *
- peakdetect ==1.1
- requests *
- scipy *
- tqdm *