update readme file

Author: erdogant

README.md

@@ -14,43 +14,98 @@
 [![Colab](https://colab.research.google.com/assets/colab-badge.svg?logo=github%20sponsors)](https://erdogant.github.io/findpeaks/pages/html/Documentation.html#colab-notebook)
 [![Medium](https://img.shields.io/badge/Medium-Blog-green)](https://erdogant.github.io/findpeaks/pages/html/Documentation.html#medium-blog)
 [![Donate](https://img.shields.io/badge/Support%20this%20project-grey.svg?logo=github%20sponsors)](https://erdogant.github.io/findpeaks/pages/html/Documentation.html#)
-<!---[![BuyMeCoffee](https://img.shields.io/badge/buymea-coffee-yellow.svg)](https://www.buymeacoffee.com/erdogant)-->
-<!---[![Coffee](https://img.shields.io/badge/coffee-black-grey.svg)](https://erdogant.github.io/donate/?currency=USD&amount=5)-->
 
+<div>
+<a href="https://erdogant.github.io/findpeaks/"><img src="https://github.com/erdogant/findpeaks/blob/master/docs/figs/logo.png" width="350" align="left" /></a>
+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⭐️
+</div>
 
-The library ``findpeaks`` aims to detect peaks in a 1-dimensional vector and 2-dimensional arrays (images) without making any assumption on the peak shape or baseline noise. To make sure that peaks can be detected across global and local heights, and in noisy data, multiple pre-processing and denoising methods are implemented.
+---
 
+### Key Features
 
-# 
-**⭐️ Star this repo if you like it ⭐️**
-#
+| Feature | Description |
+|--------|-------------|
+| [**Topology Detection**](https://erdogant.github.io/findpeaks/pages/html/Topology.html) | Mathematically grounded peak detection using persistent homology. |
+| [**Peakdetect Method**](https://erdogant.github.io/findpeaks/pages/html/Peakdetect.html) | Traditional peak detection algorithm for noisy signals. |
+| [**Mask Detection**](https://erdogant.github.io/findpeaks/pages/html/Mask.html) | Local maximum filtering for 2D image analysis. |
+| [**Caerus Method**](https://erdogant.github.io/findpeaks/pages/html/Caerus.html) | Specialized algorithm for financial time series analysis. |
+| [**Preprocessing**](https://erdogant.github.io/findpeaks/pages/html/Pre-processing.html) | Denoising, scaling, interpolation, and image preprocessing. |
+| [**Visualization**](https://erdogant.github.io/findpeaks/pages/html/Plots.html) | Rich plotting capabilities including persistence diagrams and 3D mesh plots. |
 
-#### Install findpeaks from PyPI
+---
 
+### Resources and Links
+- **Example Notebooks:** [Examples](https://erdogant.github.io/findpeaks/pages/html/Examples.html)
+- **Blog Posts:** [Medium](https://erdogant.medium.com)
+- **Documentation:** [Website](https://erdogant.github.io/findpeaks)
+- **Bug Reports and Feature Requests:** [GitHub Issues](https://github.com/erdogant/findpeaks/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
 ```
 
-#### Import findpeaks package
+##### 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
 ```
-# 
 
-### [Blog findpeaks](https://towardsdatascience.com/a-step-by-step-guide-to-accurately-detect-peaks-and-valleys-9abc49a2eac3)
-# 
+---
+
+### Quick Start
 
-### [Documentation pages](https://erdogant.github.io/findpeaks/)
+```python
+# Import library
+from findpeaks import findpeaks
 
-On the [documentation pages](https://erdogant.github.io/findpeaks/) you can find detailed information about the working of the ``findpeaks`` with many examples. 
+# 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
 
-* [Example: Find peaks in 1D-vector with low number of samples](https://erdogant.github.io/findpeaks/pages/html/Examples.html#find-peaks-in-low-sampled-dataset)
+#### 1D Signal Analysis
+* [Find peaks in low sampled dataset](https://erdogant.github.io/findpeaks/pages/html/Examples.html#find-peaks-in-low-sampled-dataset)
 
 <p align="left">
   <a href="https://erdogant.github.io/findpeaks/pages/html/Examples.html#find-peaks-in-low-sampled-dataset">
@@ -59,10 +114,7 @@ On the [documentation pages](https://erdogant.github.io/findpeaks/) you can find
   </a>
 </p>
 
-
-#
-
-* [Example: Comparison peak detection methods](https://erdogant.github.io/findpeaks/pages/html/Examples.html#comparison-methods-1)
+* [Comparison of peak detection methods](https://erdogant.github.io/findpeaks/pages/html/Examples.html#comparison-methods-1)
 
 <p align="left">
   <a href="https://erdogant.github.io/findpeaks/pages/html/Examples.html#comparison-methods-1">
@@ -71,9 +123,7 @@ On the [documentation pages](https://erdogant.github.io/findpeaks/) you can find
   </a>
 </p>
 
-#
-
-* [Example: Find peaks in 1D-vector with high number of samples](https://erdogant.github.io/findpeaks/pages/html/Examples.html#find-peaks-in-high-sampled-dataset)
+* [Find peaks in high sampled dataset](https://erdogant.github.io/findpeaks/pages/html/Examples.html#find-peaks-in-high-sampled-dataset)
 
 <p align="left">
   <a href="https://erdogant.github.io/findpeaks/pages/html/Examples.html#find-peaks-in-high-sampled-dataset">
@@ -87,9 +137,8 @@ On the [documentation pages](https://erdogant.github.io/findpeaks/) you can find
   </a>
 </p>
 
-#
-
-* [Example: Find peaks in an image (2D-array)](https://erdogant.github.io/findpeaks/pages/html/Examples.html#d-array-image)
+#### 2D Image Analysis
+* [Find peaks in an image (2D-array)](https://erdogant.github.io/findpeaks/pages/html/Examples.html#d-array-image)
 
 <p align="left">
   <a href="https://erdogant.github.io/findpeaks/pages/html/Examples.html#d-array-image">
@@ -98,7 +147,7 @@ On the [documentation pages](https://erdogant.github.io/findpeaks/) you can find
   </a>
 </p>
 
-* [Example: Conversion from 2d to 3d mesh plot)](https://erdogant.github.io/findpeaks/pages/html/Plots.html#d-mesh)
+* [3D mesh visualization](https://erdogant.github.io/findpeaks/pages/html/Plots.html#d-mesh)
 
 <p align="left">
   <a href="https://erdogant.github.io/findpeaks/pages/html/Plots.html#d-mesh">
@@ -107,29 +156,25 @@ On the [documentation pages](https://erdogant.github.io/findpeaks/) you can find
   </a>
 </p>
 
-
-#
-
-* [Example: Find peaks and valleys in stockmarkets (Bitcoin)](https://erdogant.github.io/findpeaks/pages/html/Use-cases.html#bitcoin)
-* [Example: Find peaks and valleys in stockmarkets (Facebook)](https://erdogant.github.io/findpeaks/pages/html/Use-cases.html#facebook-stocks)
+#### Financial Time Series
+* [Bitcoin price analysis](https://erdogant.github.io/findpeaks/pages/html/Use-cases.html#bitcoin)
+* [Facebook stock analysis](https://erdogant.github.io/findpeaks/pages/html/Use-cases.html#facebook-stocks)
 
 <p align="left">
   <a href="https://erdogant.github.io/findpeaks/pages/html/Use-cases.html#facebook-stocks">
   <img src="https://github.com/erdogant/findpeaks/blob/master/docs/figs/fig_facebook_minperc5.png" width="600" />
   </a>
 </p>
 
-#
-
-* [Example: Find peaks in SAR/SONAR images)](https://erdogant.github.io/findpeaks/pages/html/Use-cases.html#sonar)
+#### SAR/SONAR Image Processing
+* [Peak detection in SAR/SONAR images](https://erdogant.github.io/findpeaks/pages/html/Use-cases.html#sonar)
 
 <p align="left">
   <a href="https://erdogant.github.io/findpeaks/pages/html/Use-cases.html#sonar">
   <img src="https://github.com/erdogant/findpeaks/blob/master/docs/figs/sonar_plot.png" width="600" />
   </a>
 </p>
 
-
 <p align="left">
   <a href="https://erdogant.github.io/findpeaks/pages/html/Use-cases.html#sonar">
   <img src="https://github.com/erdogant/findpeaks/blob/master/docs/figs/sonar_mesh1.png" width="300" />
@@ -144,27 +189,22 @@ On the [documentation pages](https://erdogant.github.io/findpeaks/) you can find
   </a>
 </p>
 
-
-#
-
-* [Example: Denoising images using Lee, Kuan, Fastnl, Bilateral, Frost, Mean, median)](https://erdogant.github.io/findpeaks/pages/html/Denoise.html#)
+#### Image Denoising
+* [Denoising with Lee, Kuan, Fastnl, Bilateral, Frost, Mean, Median filters](https://erdogant.github.io/findpeaks/pages/html/Denoise.html#)
 
 <p align="left">
   <a href="https://erdogant.github.io/findpeaks/pages/html/Denoise.html#">
   <img src="https://github.com/erdogant/findpeaks/blob/master/docs/figs/noise_distr_examples.png" width="600" />
   </a>
 </p>
 
-
-<hr> 
-
+<hr>
 
 ### 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!