proadv 2.0.2__tar.gz

proadv-2.0.2/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.1
+Name: proadv
+Version: 2.0.2
+Summary: Process Acoustic Doppler Velocimeter data with advanced despiking and analysis tools
+Home-page: https://github.com/farzadasgari/proadv
+Author: Farzad Asgari
+Author-email: std_farzad.asgari@alumni.khu.ac.ir
+Project-URL: Bug Tracker, https://github.com/farzadasgari/proadv/issues
+Project-URL: Documentation, https://github.com/farzadasgari/proadv/tree/main/docs
+Project-URL: Source Code, https://github.com/farzadasgari/proadv
+Keywords: ProADV,python,signal processing,data processing,acoustic Doppler velocimeter,ADV,Denoising,Despiking
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.8
+Description-Content-Type: text/markdown
+Requires-Dist: numpy>=1.0
+Requires-Dist: scipy>=1.0
+Requires-Dist: fastkde
+
+# ProADV - Process Acoustic Doppler Velocimeter
+
+[![GitHub stars](https://img.shields.io/github/stars/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/network)
+[![GitHub issues](https://img.shields.io/github/issues/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/issues)
+[![GitHub license](https://img.shields.io/github/license/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/blob/main/LICENSE)
+[![PyPI version](https://badge.fury.io/py/proadv.svg)](https://badge.fury.io/py/proadv)
+[![conda](https://img.shields.io/conda/vn/conda-forge/proadv.svg)](https://anaconda.org/conda-forge/proadv)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/proadv)](https://pypi.org/project/proadv/)
+[![GitHub contributors](https://img.shields.io/github/contributors/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/graphs/contributors)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/pulls)
+[![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/pulls?q=is%3Apr+is%3Aclosed)
+[![GitHub last commit](https://img.shields.io/github/last-commit/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/commits/main)
+
+
+## Streamline Your ADV Data Analysis
+
+**ProADV** is a comprehensive Python package designed to empower researchers and engineers working with acoustic Doppler velocimeter (ADV) data. It offers a comprehensive suite of tools for efficient cleaning, analysis, and visualization of ADV data, streamlining your workflow and extracting valuable insights from your measurements.
+
+### Key Features
+
+* **Despiking and Denoising:** ProADV tackles the challenge of spikes and noise in ADV data, providing a variety of robust algorithms for effective data cleaning. 
+    * **Spike Detection:** 
+        * **ACC (Acceleration Thresholding):** Identifies spikes based on exceeding a user-defined acceleration threshold.
+        * **PST (Phase-Space Thresholding):** Utilizes a combination of velocity and its temporal derivative to detect spikes.
+        * **mPST (Modified Phase-Space Thresholding):** An enhanced version of PST with improved sensitivity.
+        * **VC (Velocity Correlation):** Detects spikes based on deviations from the correlation between neighboring data points.
+        * **KDE (Kernel Density Estimation):** Employs a statistical approach to identify outliers based on the probability density function. 
+        * **3d-KDE (Three-dimensional Kernel Density Estimation):** Extends KDE to three dimensions for more robust spike detection in complex data.
+        * **m3d-KDE (Modified Three-dimensional Kernel Density Estimation):** Further refines 3d-KDE for enhanced performance.
+    * **Replacement Methods:** ProADV offers several options to replace detected spikes with more reliable values:
+        * **LVD (Last Valid Data):** Replaces spikes with the last valid data point before the spike.
+        *  **MV (Mean Value):** Replaces spikes with the mean value of velocity component. 
+        * **LI (Linear Interpolation):** Uses linear interpolation between surrounding points to estimate the missing value.
+        * **12PP (12 Points Cubic Polynomial):** Employs a 12-point cubic polynomial to fit a smoother curve and replace spikes.
+
+* **Statistical Analysis:** ProADV equips you with essential statistical tools to characterize your ADV data:
+    * **Minimum, Maximum:** Provides the range of measured velocities.
+    * **Mean, Median, Mode:** Calculates central tendency measures.
+    * **Skewness, Kurtosis:** Analyzes the distribution characteristics of your data.
+
+* **Advanced Analysis:** In addition to cleaning and basic statistics, ProADV offers advanced functionalities for deeper insights:
+    * **Moving Average:** Smooths out data fluctuations for better visualization and trend analysis. Provided in simple moving average, exponential moving average, and weighted moving average methods. 
+    * **SSA (Singular Spectrum Analysis):** Extracts underlying patterns and trends from time series data.
+    * **PR (Pollution Rate) Calculation:** Estimates the level of noise or pollution within the data.
+    * **Spectral Analysis:**
+        * **PSD (Power Spectral Density):** Analyzes the distribution of energy across different frequencies within the data.
+        * **PDF (Probability Density Function):** Provides the probability of encountering specific velocity values.
+    * **Normality Test:** Evaluates whether your data follows a normal distribution.
+    * **Normalization:** Scales data to a common range for further analysis or visualization.
+
+### Installation
+
+There are three convenient ways to install ProADV:
+
+1. **Using pip (recommended):**
+   ```bash
+   pip install proadv
+   ```
+
+2. **Using conda-forge:**
+   ```bash
+   conda install -c conda-forge proadv
+   ```
+
+3. **From source code:**
+
+   a. Clone the repository:
+      ```bash
+      git clone https://github.com/farzadasgari/proadv.git
+      ```
+   b. Navigate to the project directory:
+      ```bash
+      cd proadv
+      ```
+   c. Install using setup.py:
+      ```bash
+      python setup.py install
+      ```
+
+### Collaboration
+
+We encourage collaboration and contributions from the community to improve ProADV. Here's how to contribute:
+
+1. Fork the repository on GitHub.
+2. Clone your forked repository to your local machine.
+3. Create a new branch for your changes.
+4. Make your changes and commit them with descriptive messages.
+5. Push your changes to your forked repository.
+6. Submit a pull request for review and merging.
+
+### References
+
+For further information and in-depth understanding of the algorithms employed in ProADV, refer to the following resources:
+
+1. [Exploring the role of signal pollution rate on the performance of despiking velocity time-series algorithms](https://doi.org/10.1016/j.flowmeasinst.2023.102485)
+2. [Unleashing the power of three-dimensional kernel density estimation for Doppler Velocimeter data despiking](https://doi.org/10.1016/j.measurement.2023.114053)
+
+
+### Acknowledgment
+- This project was developed under the supervision of **[Dr. Seyed Hossein Mohaeri](https://khu.ac.ir/cv/1139/Seyed-Hossein-Mohajeri)** and **[Dr. Mojtaba Mehraein](https://khu.ac.ir/cv/279/Mojtaba-Mehraein)**.
+- Special thanks to [Parvaneh Yaghoubi](https://github.com/parvanehyaghoubi), [Hossein Abazari](https://github.com/HossA12), [Narges Yaghoubi](https://github.com/nargesyaghoubi), [Mojtaba Karimi](https://github.com/mojikarimi), and [Hiva Yarandi](https://github.com/Hivayrn) for their valuable contributions to this project.
+
+
+### Contact
+For any inquiries, please contact:
+- std_farzad.asgari@alumni.khu.ac.ir
+- khufarzadasgari@gmail.com
+
+### Links
+
+##### Farzad Asgari
+[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://farzadasgari.ir/)
+
+[![Google Scholar Badge](https://img.shields.io/badge/Google%20Scholar-4285F4?logo=googlescholar&logoColor=fff&style=for-the-badge)](https://scholar.google.com/citations?user=Rhue_kkAAAAJ&hl=en)
+
+[![ResearchGate Badge](https://img.shields.io/badge/ResearchGate-0CB?logo=researchgate&logoColor=fff&style=for-the-badge)](https://www.researchgate.net/profile/Farzad-Asgari)
+
+[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/farzad-asgari-5a90942b2/)
+
+
+##### Seyed Hossein Mohajeri
+[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://khu.ac.ir/cv/1139/Seyed-Hossein-Mohajeri)
+
+[![Google Scholar Badge](https://img.shields.io/badge/Google%20Scholar-4285F4?logo=googlescholar&logoColor=fff&style=for-the-badge)](https://scholar.google.com/citations?user=E8PFUBEAAAAJ&hl=en)
+
+[![ResearchGate Badge](https://img.shields.io/badge/ResearchGate-0CB?logo=researchgate&logoColor=fff&style=for-the-badge)](https://www.researchgate.net/profile/Seyed-Mohajeri-2)
+
+[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](
+https://ir.linkedin.com/in/hossein-mohajeri)
+
+
+##### Mojtaba Mehraein
+[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://khu.ac.ir/cv/279/Mojtaba-Mehraein)
+
+[![Google Scholar Badge](https://img.shields.io/badge/Google%20Scholar-4285F4?logo=googlescholar&logoColor=fff&style=for-the-badge)](https://scholar.google.com/citations?user=GwT49LIAAAAJ&hl=en)
+
+[![ResearchGate Badge](https://img.shields.io/badge/ResearchGate-0CB?logo=researchgate&logoColor=fff&style=for-the-badge)](https://ir.linkedin.com/in/mojtaba-mehraein-002a03238)
+
+[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](
+https://ir.linkedin.com/in/mojtaba-mehraein-002a03238)

proadv-2.0.2/README.md

@@ -0,0 +1,141 @@
+# ProADV - Process Acoustic Doppler Velocimeter
+
+[![GitHub stars](https://img.shields.io/github/stars/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/network)
+[![GitHub issues](https://img.shields.io/github/issues/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/issues)
+[![GitHub license](https://img.shields.io/github/license/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/blob/main/LICENSE)
+[![PyPI version](https://badge.fury.io/py/proadv.svg)](https://badge.fury.io/py/proadv)
+[![conda](https://img.shields.io/conda/vn/conda-forge/proadv.svg)](https://anaconda.org/conda-forge/proadv)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/proadv)](https://pypi.org/project/proadv/)
+[![GitHub contributors](https://img.shields.io/github/contributors/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/graphs/contributors)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/pulls)
+[![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/pulls?q=is%3Apr+is%3Aclosed)
+[![GitHub last commit](https://img.shields.io/github/last-commit/farzadasgari/proadv)](https://github.com/farzadasgari/proadv/commits/main)
+
+
+## Streamline Your ADV Data Analysis
+
+**ProADV** is a comprehensive Python package designed to empower researchers and engineers working with acoustic Doppler velocimeter (ADV) data. It offers a comprehensive suite of tools for efficient cleaning, analysis, and visualization of ADV data, streamlining your workflow and extracting valuable insights from your measurements.
+
+### Key Features
+
+* **Despiking and Denoising:** ProADV tackles the challenge of spikes and noise in ADV data, providing a variety of robust algorithms for effective data cleaning. 
+    * **Spike Detection:** 
+        * **ACC (Acceleration Thresholding):** Identifies spikes based on exceeding a user-defined acceleration threshold.
+        * **PST (Phase-Space Thresholding):** Utilizes a combination of velocity and its temporal derivative to detect spikes.
+        * **mPST (Modified Phase-Space Thresholding):** An enhanced version of PST with improved sensitivity.
+        * **VC (Velocity Correlation):** Detects spikes based on deviations from the correlation between neighboring data points.
+        * **KDE (Kernel Density Estimation):** Employs a statistical approach to identify outliers based on the probability density function. 
+        * **3d-KDE (Three-dimensional Kernel Density Estimation):** Extends KDE to three dimensions for more robust spike detection in complex data.
+        * **m3d-KDE (Modified Three-dimensional Kernel Density Estimation):** Further refines 3d-KDE for enhanced performance.
+    * **Replacement Methods:** ProADV offers several options to replace detected spikes with more reliable values:
+        * **LVD (Last Valid Data):** Replaces spikes with the last valid data point before the spike.
+        *  **MV (Mean Value):** Replaces spikes with the mean value of velocity component. 
+        * **LI (Linear Interpolation):** Uses linear interpolation between surrounding points to estimate the missing value.
+        * **12PP (12 Points Cubic Polynomial):** Employs a 12-point cubic polynomial to fit a smoother curve and replace spikes.
+
+* **Statistical Analysis:** ProADV equips you with essential statistical tools to characterize your ADV data:
+    * **Minimum, Maximum:** Provides the range of measured velocities.
+    * **Mean, Median, Mode:** Calculates central tendency measures.
+    * **Skewness, Kurtosis:** Analyzes the distribution characteristics of your data.
+
+* **Advanced Analysis:** In addition to cleaning and basic statistics, ProADV offers advanced functionalities for deeper insights:
+    * **Moving Average:** Smooths out data fluctuations for better visualization and trend analysis. Provided in simple moving average, exponential moving average, and weighted moving average methods. 
+    * **SSA (Singular Spectrum Analysis):** Extracts underlying patterns and trends from time series data.
+    * **PR (Pollution Rate) Calculation:** Estimates the level of noise or pollution within the data.
+    * **Spectral Analysis:**
+        * **PSD (Power Spectral Density):** Analyzes the distribution of energy across different frequencies within the data.
+        * **PDF (Probability Density Function):** Provides the probability of encountering specific velocity values.
+    * **Normality Test:** Evaluates whether your data follows a normal distribution.
+    * **Normalization:** Scales data to a common range for further analysis or visualization.
+
+### Installation
+
+There are three convenient ways to install ProADV:
+
+1. **Using pip (recommended):**
+   ```bash
+   pip install proadv
+   ```
+
+2. **Using conda-forge:**
+   ```bash
+   conda install -c conda-forge proadv
+   ```
+
+3. **From source code:**
+
+   a. Clone the repository:
+      ```bash
+      git clone https://github.com/farzadasgari/proadv.git
+      ```
+   b. Navigate to the project directory:
+      ```bash
+      cd proadv
+      ```
+   c. Install using setup.py:
+      ```bash
+      python setup.py install
+      ```
+
+### Collaboration
+
+We encourage collaboration and contributions from the community to improve ProADV. Here's how to contribute:
+
+1. Fork the repository on GitHub.
+2. Clone your forked repository to your local machine.
+3. Create a new branch for your changes.
+4. Make your changes and commit them with descriptive messages.
+5. Push your changes to your forked repository.
+6. Submit a pull request for review and merging.
+
+### References
+
+For further information and in-depth understanding of the algorithms employed in ProADV, refer to the following resources:
+
+1. [Exploring the role of signal pollution rate on the performance of despiking velocity time-series algorithms](https://doi.org/10.1016/j.flowmeasinst.2023.102485)
+2. [Unleashing the power of three-dimensional kernel density estimation for Doppler Velocimeter data despiking](https://doi.org/10.1016/j.measurement.2023.114053)
+
+
+### Acknowledgment
+- This project was developed under the supervision of **[Dr. Seyed Hossein Mohaeri](https://khu.ac.ir/cv/1139/Seyed-Hossein-Mohajeri)** and **[Dr. Mojtaba Mehraein](https://khu.ac.ir/cv/279/Mojtaba-Mehraein)**.
+- Special thanks to [Parvaneh Yaghoubi](https://github.com/parvanehyaghoubi), [Hossein Abazari](https://github.com/HossA12), [Narges Yaghoubi](https://github.com/nargesyaghoubi), [Mojtaba Karimi](https://github.com/mojikarimi), and [Hiva Yarandi](https://github.com/Hivayrn) for their valuable contributions to this project.
+
+
+### Contact
+For any inquiries, please contact:
+- std_farzad.asgari@alumni.khu.ac.ir
+- khufarzadasgari@gmail.com
+
+### Links
+
+##### Farzad Asgari
+[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://farzadasgari.ir/)
+
+[![Google Scholar Badge](https://img.shields.io/badge/Google%20Scholar-4285F4?logo=googlescholar&logoColor=fff&style=for-the-badge)](https://scholar.google.com/citations?user=Rhue_kkAAAAJ&hl=en)
+
+[![ResearchGate Badge](https://img.shields.io/badge/ResearchGate-0CB?logo=researchgate&logoColor=fff&style=for-the-badge)](https://www.researchgate.net/profile/Farzad-Asgari)
+
+[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/farzad-asgari-5a90942b2/)
+
+
+##### Seyed Hossein Mohajeri
+[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://khu.ac.ir/cv/1139/Seyed-Hossein-Mohajeri)
+
+[![Google Scholar Badge](https://img.shields.io/badge/Google%20Scholar-4285F4?logo=googlescholar&logoColor=fff&style=for-the-badge)](https://scholar.google.com/citations?user=E8PFUBEAAAAJ&hl=en)
+
+[![ResearchGate Badge](https://img.shields.io/badge/ResearchGate-0CB?logo=researchgate&logoColor=fff&style=for-the-badge)](https://www.researchgate.net/profile/Seyed-Mohajeri-2)
+
+[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](
+https://ir.linkedin.com/in/hossein-mohajeri)
+
+
+##### Mojtaba Mehraein
+[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://khu.ac.ir/cv/279/Mojtaba-Mehraein)
+
+[![Google Scholar Badge](https://img.shields.io/badge/Google%20Scholar-4285F4?logo=googlescholar&logoColor=fff&style=for-the-badge)](https://scholar.google.com/citations?user=GwT49LIAAAAJ&hl=en)
+
+[![ResearchGate Badge](https://img.shields.io/badge/ResearchGate-0CB?logo=researchgate&logoColor=fff&style=for-the-badge)](https://ir.linkedin.com/in/mojtaba-mehraein-002a03238)
+
+[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](
+https://ir.linkedin.com/in/mojtaba-mehraein-002a03238)

proadv-2.0.2/proadv/filtration/detection/acceleration.py

@@ -0,0 +1,65 @@
+import numpy as np
+from proadv.statistics.spread import std
+
+
+def acceleration_thresholding(velocities, frequency, tag, gravity=980, k_gravity=1.5, k_sigma=1):
+    """
+    Detects acceleration events based on velocity data.
+
+    This function calculates acceleration events based on velocity data, considering thresholds
+        for acceleration magnitude and velocity deviation from mean.
+
+    Parameters
+    ------
+        velocities (array_like): Array of velocity data.
+            An array-like object containing velocity values.
+        frequency (float): Sampling frequency.
+            The frequency at which the velocity data is sampled,
+            used to calculate acceleration from velocity differences.
+        tag (int): Tag for acceleration direction.
+            An integer indicating the direction of acceleration to detect:
+                - 1 for positive acceleration (increasing velocity)
+                - 2 for negative acceleration (decreasing velocity).
+        gravity (float): Value of gravity.
+            The acceleration due to gravity, used as a reference for acceleration thresholds.
+            Default is 980 (m/s^2).
+        k_gravity (float): Threshold multiplier for gravity.
+            A multiplier applied to the gravity value to determine the acceleration threshold.
+            Default is 1.5.
+        k_sigma (float, optional): Threshold multiplier for standard deviation.
+            A multiplier applied to the standard deviation of velocities to determine velocity deviation threshold.
+            Default is 1.
+
+    Returns
+    ------
+        accel_indices (array_like): Indices of acceleration events.
+            An array containing the indices of the detected acceleration events.
+
+    Raises
+    ------
+        ValueError: If invalid tag value is provided.
+            Raised when the tag value is not 1 or 2.
+
+    References
+    ------
+        Goring, Derek G., and Vladimir I. Nikora.
+            "Despiking acoustic Doppler velocimeter data."
+            Journal of hydraulic engineering 128.1 (2002): 117-126.
+    """
+    velocities = np.asarray(velocities)
+
+    # Calculate velocity differences and multiply by frequency to obtain acceleration
+    differences = np.concatenate((np.array([0]), np.diff(velocities) * frequency))
+
+    if tag == 1:
+        # Detect positive acceleration events
+        accel_indices = np.intersect1d(np.where(differences > k_gravity * gravity)[0],
+                                       np.where(velocities > np.mean(velocities) + k_sigma * std(velocities))[0])
+    elif tag == 2:
+        # Detect negative acceleration events
+        accel_indices = np.intersect1d(np.where(differences < -k_gravity * gravity)[0],
+                                       np.where(velocities < np.mean(velocities) - k_sigma * std(velocities))[0])
+    else:
+        raise ValueError("Invalid tag value. Expected 1 or 2.")
+
+    return accel_indices

proadv-2.0.2/proadv/filtration/detection/bivariatekernel.py

@@ -0,0 +1,53 @@
+import numpy as np
+
+
+def _cutoff(density_profile, velocity_profile, c1_threshold, c2_threshold, force_profile, peak_index, grid):
+    """
+    Find the lower and upper cutoff velocities based on specified criteria.
+
+    Parameters
+    ------
+    density_profile (array_like): Density profile of the system.
+    velocity_profile (array_like): Velocity profile of the system.
+    c1_threshold (float): Threshold ratio for force compared to peak force.
+    c2_threshold (float): Threshold for absolute change in force.
+    force_profile (array_like): Force profile of the system.
+    peak_index (int): Index of the peak force in the force profile.
+    grid (int): Grid spacing or resolution.
+
+    Returns
+    ------
+    lower_cutoff_velocity, upper_cutoff_velocity: A tuple containing the lower and upper cutoff velocities.
+
+    Note
+    ------
+    This function assumes that the input arrays (density_profile, velocity_profile, and force_profile) 
+        are of the same length.
+        length.
+    The density profile, velocity profile, and force profile should be consistent and correspond to 
+        each other at each index.
+    """
+
+    profile_length = force_profile.size
+    delta_force = np.append([0], np.diff(force_profile)) * grid / density_profile
+
+    # Find lower cutoff index
+    for i in range(peak_index - 1, 0, -1):
+        if force_profile[i] / force_profile[peak_index] <= c1_threshold and abs(delta_force[i]) <= c2_threshold:
+            lower_cutoff_index = i
+            break
+    else:
+        lower_cutoff_index = 1
+
+    # Find upper cutoff index
+    for i in range(peak_index + 1, profile_length - 1):
+        if force_profile[i] / force_profile[peak_index] <= c1_threshold and abs(delta_force[i]) <= c2_threshold:
+            upper_cutoff_index = i
+            break
+    else:
+        upper_cutoff_index = profile_length - 1
+
+    lower_cutoff_velocity = velocity_profile[lower_cutoff_index]
+    upper_cutoff_velocity = velocity_profile[upper_cutoff_index]
+
+    return lower_cutoff_velocity, upper_cutoff_velocity

proadv-2.0.2/proadv/filtration/detection/correlation.py

@@ -0,0 +1,78 @@
+import numpy as np
+from proadv.filtration.detection.poincare import calculate_ab, calculate_rho
+from proadv.statistics.spread import std
+
+
+def calculate_parameters(up, vp, wp):
+    """
+    Calculate parameters required for velocity correlation.
+
+    Parameters
+    ------
+        up (array_like): Array of the first velocity component.
+        vp (array_like): Array of the second velocity component.
+        wp (array_like): Array of the third velocity component.
+
+    Returns
+    ------
+        lambda_ (float): Lambda value used in velocity correlation detection.
+        std_u (float): Standard deviation of the longitudinal velocity component.
+        std_v (float): Standard deviation of the transverse velocity component.
+        std_w (float): Standard deviation of the vertical velocity component.
+    """
+    data_size = up.size
+    std_u = std(up)
+    std_v = std(vp)
+    std_w = std(wp)
+    lambda_ = np.sqrt(2 * np.log(data_size))
+    return lambda_, std_u, std_v, std_w
+
+
+def velocity_correlation(ui, vi, wi):
+    """
+    Detect spikes using velocity correlation filter, based on three velocity components.
+
+    Parameters
+    ------
+        ui (array_like): Array of the longitudinal velocity component.
+        vi (array_like): Array of the transverse velocity component.
+        wi (array_like): Array of the vertical velocity component.
+
+    Returns
+    ------
+        correl_indices (array_like): Indices of spikes detected by velocity correlation.
+
+    References
+    ------
+        Cea, L., J. Puertas, and L. Pena.
+            "Velocity measurements on highly turbulent free surface flow using ADV."
+            Experiments in fluids 42 (2007): 333-348.
+    """
+    from proadv.statistics.descriptive import mean
+    ui, vi, wi = ui - mean(ui), vi - mean(vi), wi - mean(wi)
+    lambda_, std_u, std_v, std_w = calculate_parameters(ui, vi, wi)
+
+    # Calculate angles between velocity components
+    theta1 = np.arctan(np.sum(ui * vi) / np.sum(ui ** 2))
+    theta2 = np.arctan(np.sum(ui * wi) / np.sum(ui ** 2))
+    theta3 = np.arctan(np.sum(vi * wi) / np.sum(vi ** 2))
+
+    # Calculate 'a' and 'b' coefficients for each angle
+    a1, b1 = calculate_ab(std_u, std_v, theta1, lambda_)
+    a2, b2 = calculate_ab(std_u, std_w, theta2, lambda_)
+    a3, b3 = calculate_ab(std_v, std_w, theta3, lambda_)
+
+    # Calculate rho values for each component pair
+    rho1 = calculate_rho(ui, vi, theta1, a1, b1)
+    rho2 = calculate_rho(ui, wi, theta2, a2, b2)
+    rho3 = calculate_rho(vi, wi, theta3, a3, b3)
+
+    # Find indices where rho values exceed 1 (indicating correlation)
+    x1 = np.nonzero(rho1 > 1)[0]
+    x2 = np.nonzero(rho2 > 1)[0]
+    x3 = np.nonzero(rho3 > 1)[0]
+
+    # Combine all detected indices and remove duplicates
+    correl_indices = np.sort(np.unique(np.concatenate((x1, x2, x3))))
+
+    return correl_indices