PySDKit 0.4.7__tar.gz → 0.4.10__tar.gz

pysdkit-0.4.10/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.2
+Name: PySDKit
+Version: 0.4.10
+Summary: A Python library for signal decomposition algorithms with a unified interface.
+Home-page: https://github.com/wwhenxuan/PySDKit
+Author: whenxuan
+Author-email: wwhenxuan@gmail.com
+Keywords: signal decomposition,signal processing,machine learning
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: numpy<=1.26.4,>=1.24.3
+Requires-Dist: scipy<=1.13.1,>=1.11.1
+Requires-Dist: matplotlib<=3.8.4,>=3.7.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# PySDKit: signal decomposition in Python 
+
+<div align="center">
+
+[![PyPI version](https://badge.fury.io/py/PySDKit.svg)](https://pypi.org/project/PySDKit/) 
+![License](https://img.shields.io/github/license/wwhenxuan/PySDKit)
+[![codecov](https://codecov.io/gh/wwhenxuan/PySDKit/branch/main/graph/badge.svg?token=YOUR_TOKEN)](https://codecov.io/gh/wwhenxuan/PySDKit)
+[![arXiv](https://img.shields.io/badge/arXiv-1234.56789-brightgreen.svg)](https://arxiv.org/abs/1234.56789) 
+[![Downloads](https://pepy.tech/badge/pysdkit)](https://pepy.tech/project/pysdkit)
+![Visits Badge](https://badges.pufler.dev/visits/ForestsKing/D3R)
+
+A Python library for signal decomposition algorithms 🥳
+
+<img src="https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/Logo_sd.png" alt="Logo_sd" width="500"/>
+
+</div>
+
+## Installation 🚀
+
+You can install `PySDKit` through pip:
+
+~~~
+pip install pysdkit
+~~~
+
+We only used [`NumPy`](https://numpy.org/), [`Scipy`](https://scipy.org/) and [`matplotlib`](https://matplotlib.org/) when developing the project.
+
+## Example script ✨
+
+This project integrates simple signal processing methods, signal decomposition and visualization, and builds a general interface similar to [`Scikit-learn`](https://scikit-learn.org/stable/). It is mainly divided into three steps:
+1. Import the signal decomposition method;
+2. Create an instance for signal decomposition;
+3. Use the `fit_transform` method to implement signal decomposition;
+4. Visualize and analyze the original signal and the intrinsic mode functions IMFs obtained by decomposition.
+
+~~~python
+from pysdkit import EMD
+from pysdkit.data import test_emd
+from pysdkit.plot import plot_IMFs
+
+t, signal = test_emd()
+
+# create an instance for signal decomposition
+emd = EMD()
+# implement signal decomposition
+IMFs = emd.fit_transform(signal, max_imf=2)
+plot_IMFs(signal, IMFs)
+~~~
+
+![example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/example.jpg)
+
+The EMD in the above example is the most classic [`empirical mode decomposition`](https://www.mathworks.com/help/signal/ref/emd.html) algorithm in signal decomposition. For more complex signals, you can try other algorithms such as variational mode decomposition ([`VMD`](https://ieeexplore.ieee.org/abstract/document/6655981)).
+
+~~~python
+import numpy as np
+from pysdkit import VMD
+
+# load new signal
+signal = np.load("./example/example.npy")
+
+# use variational mode decomposition
+vmd = VMD(alpha=500, K=3, tau=0.0, tol=1e-9)
+IMFs = vmd.fit_transform(signal=signal)
+print(IMFs.shape)
+
+vmd.plot_IMFs(save_figure=True)
+~~~
+
+![vmd_example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/vmd_example.jpg)
+
+Better observe the characteristics of the decomposed intrinsic mode function in the frequency domain.
+
+~~~python
+from pysdkit.plot import plot_IMFs_amplitude_spectra
+
+# frequency domain visualization
+plot_IMFs_amplitude_spectra(IMFs, smooth="exp")   # use exp smooth
+~~~
+
+![frequency_example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/frequency_example.jpg)
+
+## Target 🎯
+
+|                          Algorithm                           |                            Paper                             |                             Code                             | State |
+| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :---: |
+|              EMD (Empirical Mode Decomposition)              |                         [[paper]]()                          | [[code]](https://www.mathworks.com/help/signal/ref/emd.html) |   ✔️   |
+|       MEMD (Multivariate Empirical Mode Decomposition)       | [[paper]](https://royalsocietypublishing.org/doi/full/10.1098/rspa.2009.0502) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|      BEMD (Bidimensional Empirical Mode Decomposition)       | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0262885603000945) | [[code]](https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/BEMD.py) |   ✖️   |
+|         CEMD (Complex Empirical Mode Decomposition)          | [[paper]](https://ieeexplore.ieee.org/abstract/document/4063369) |                          [[code]]()                          |   ✖️   |
+|         EEMD (Ensemble Empirical Mode Decomposition)         | [[paper]](https://www.sciencedirect.com/topics/physics-and-astronomy/ensemble-empirical-mode-decomposition) | [[code]](https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/EEMD.py) |   ✖️   |
+|          REMD (Robust Empirical Mode Decomposition)          | [[paper]](https://www.sciencedirect.com/science/article/pii/S0019057821003785) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/70032-robust-empirical-mode-decomposition-remd) |   ✖️   |
+| BMEMD (Bidimensional Multivariate Empirical Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/8805082)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/72343-bidimensional-multivariate-empirical-mode-decomposition?s_tid=FX_rc1_behav) |   ✖️   |
+|     CEEMDAN (Complete Ensemble EMD with Adaptive Noise)      |   [[paper]](https://ieeexplore.ieee.org/document/5947265)    | [[code]](https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/EEMD.py) |   ✖️   |
+|           TVF_EMD (Time Varying Filter Based EMD)            | [[paper]](https://www.sciencedirect.com/science/article/pii/S0165168417301135) |   [[code]](https://github.com/stfbnc/pytvfemd/tree/master)   |   ✔️   |
+|                FAEMD (Fast and Adaptive EMD)                 |   [[paper]](https://ieeexplore.ieee.org/document/8447300)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|        MV_FAEMD (Multivariate Fast and Adaptive EMD)         |   [[paper]](https://ieeexplore.ieee.org/document/8447300)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|      MD_FAEMD (Multidimensional Fast and Adaptive EMD)       |   [[paper]](https://ieeexplore.ieee.org/document/8447300)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|                LMD (Local Mean Decomposition)                | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S1051200418308133?via%3Dihub) | [[code]](https://github.com/shownlin/PyLMD/blob/master/PyLMD/LMD.py) |   ✔️   |
+|            RLMD (Robust Local Mean Decomposition)            | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0888327017301619) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/66935-robust-local-mean-decomposition-rlmd) |   ✖️   |
+|               FMD (Feature Mode Decomposition)               |   [[paper]](https://ieeexplore.ieee.org/document/9732251)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/108099-feature-mode-decomposition-fmd) |   ✖️   |
+|              EWT (Empirical Wavelet Transform)               |   [[paper]](https://ieeexplore.ieee.org/document/6522142)    | [[code]](https://www.mathworks.com/help/wavelet/ug/empirical-wavelet-transform.html) |   ✔️   |
+|            EWT2D (2D Empirical Wavelet Transform)            |         [[paper]](https://arxiv.org/abs/2405.06188)          |        [[code]](https://github.com/bhurat/EWT-Python)        |   ✖️   |
+|             VMD (Variational Mode Decomposition)             |   [[paper]](https://ieeexplore.ieee.org/document/6655981)    |          [[code]](https://github.com/vrcarva/vmdpy)          |   ✔️   |
+|      MVMD (Multivariate Variational Mode Decomposition)      |   [[paper]](https://ieeexplore.ieee.org/document/8890883)    |          [[code]](https://github.com/yunyueye/MVMD)          |   ✔️   |
+|    VMD2D (Two-Dimensional Variational Mode Decomposition)    | [[paper]](https://ww3.math.ucla.edu/camreport/cam14-16.pdf)  | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/45918-two-dimensional-variational-mode-decomposition?s_tid=srchtitle) |   ✖️   |
+|       SVMD (Successive Variational Mode Decomposition)       | [[paper]](https://www.sciencedirect.com/science/article/pii/S0165168420301535) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/98649-successive-variational-mode-decomposition-svmd-m?s_tid=FX_rc3_behav) |   ✖️   |
+|    VNCMD (Variational Nonlinear Chirp Mode Decomposition)    |   [[paper]](https://ieeexplore.ieee.org/document/7990179)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/64292-variational-nonlinear-chirp-mode-decomposition) |   ✔️   |
+|   MNCMD (Multivariate Nonlinear Chirp Mode Decomposition)    | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0165168420302103) |                          [[code]]()                          |   ✖️   |
+| AVNCMD (Adaptive Variational Nonlinear Chirp Mode Decomposition) | [[paper]](https://ieeexplore.ieee.org/abstract/document/9746147) |         [[code]](https://github.com/HauLiang/AVNCMD)         |   ✖️   |
+|           ACMD (Adaptive Chirp Mode Decomposition)           |                         [[paper]]()                          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/121373-data-driven-adaptive-chirp-mode-decomposition?s_tid=srchtitle) |   ✔️   |
+| BA-ACMD (Bandwidth-aware adaptive chirp mode decomposition)  |                         [[paper]]()                          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/132792-bandwidth-aware-adaptive-chirp-mode-decomposition-ba-acmd?s_tid=srchtitle) |   ✖️   |
+|           JMD (Jump Plus AM-FM Mode Decomposition)           |         [[paper]](https://arxiv.org/abs/2407.07800)          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/169388-jump-plus-am-fm-mode-decomposition-jmd?s_tid=prof_contriblnk) |   ✖️   |
+|    MJMD (Multivariate Jump Plus AM-FM Mode Decomposition)    |         [[paper]](https://arxiv.org/abs/2407.07800)          | [[code]](https://ms-intl.mathworks.com/matlabcentral/fileexchange/169393-multivariate-jump-plus-am-fm-mode-decomposition-mjmd?s_tid=FX_rc2_behav) |   ✖️   |
+|      ESMD (Extreme-Point Symmetric Mode Decomposition)       |          [[paper]](https://arxiv.org/abs/1303.6540)          |         [[code]](https://github.com/WuShichao/esmd)          |   ✖️   |

pysdkit-0.4.10/PySDKit.egg-info/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.2
+Name: PySDKit
+Version: 0.4.10
+Summary: A Python library for signal decomposition algorithms with a unified interface.
+Home-page: https://github.com/wwhenxuan/PySDKit
+Author: whenxuan
+Author-email: wwhenxuan@gmail.com
+Keywords: signal decomposition,signal processing,machine learning
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: numpy<=1.26.4,>=1.24.3
+Requires-Dist: scipy<=1.13.1,>=1.11.1
+Requires-Dist: matplotlib<=3.8.4,>=3.7.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# PySDKit: signal decomposition in Python 
+
+<div align="center">
+
+[![PyPI version](https://badge.fury.io/py/PySDKit.svg)](https://pypi.org/project/PySDKit/) 
+![License](https://img.shields.io/github/license/wwhenxuan/PySDKit)
+[![codecov](https://codecov.io/gh/wwhenxuan/PySDKit/branch/main/graph/badge.svg?token=YOUR_TOKEN)](https://codecov.io/gh/wwhenxuan/PySDKit)
+[![arXiv](https://img.shields.io/badge/arXiv-1234.56789-brightgreen.svg)](https://arxiv.org/abs/1234.56789) 
+[![Downloads](https://pepy.tech/badge/pysdkit)](https://pepy.tech/project/pysdkit)
+![Visits Badge](https://badges.pufler.dev/visits/ForestsKing/D3R)
+
+A Python library for signal decomposition algorithms 🥳
+
+<img src="https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/Logo_sd.png" alt="Logo_sd" width="500"/>
+
+</div>
+
+## Installation 🚀
+
+You can install `PySDKit` through pip:
+
+~~~
+pip install pysdkit
+~~~
+
+We only used [`NumPy`](https://numpy.org/), [`Scipy`](https://scipy.org/) and [`matplotlib`](https://matplotlib.org/) when developing the project.
+
+## Example script ✨
+
+This project integrates simple signal processing methods, signal decomposition and visualization, and builds a general interface similar to [`Scikit-learn`](https://scikit-learn.org/stable/). It is mainly divided into three steps:
+1. Import the signal decomposition method;
+2. Create an instance for signal decomposition;
+3. Use the `fit_transform` method to implement signal decomposition;
+4. Visualize and analyze the original signal and the intrinsic mode functions IMFs obtained by decomposition.
+
+~~~python
+from pysdkit import EMD
+from pysdkit.data import test_emd
+from pysdkit.plot import plot_IMFs
+
+t, signal = test_emd()
+
+# create an instance for signal decomposition
+emd = EMD()
+# implement signal decomposition
+IMFs = emd.fit_transform(signal, max_imf=2)
+plot_IMFs(signal, IMFs)
+~~~
+
+![example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/example.jpg)
+
+The EMD in the above example is the most classic [`empirical mode decomposition`](https://www.mathworks.com/help/signal/ref/emd.html) algorithm in signal decomposition. For more complex signals, you can try other algorithms such as variational mode decomposition ([`VMD`](https://ieeexplore.ieee.org/abstract/document/6655981)).
+
+~~~python
+import numpy as np
+from pysdkit import VMD
+
+# load new signal
+signal = np.load("./example/example.npy")
+
+# use variational mode decomposition
+vmd = VMD(alpha=500, K=3, tau=0.0, tol=1e-9)
+IMFs = vmd.fit_transform(signal=signal)
+print(IMFs.shape)
+
+vmd.plot_IMFs(save_figure=True)
+~~~
+
+![vmd_example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/vmd_example.jpg)
+
+Better observe the characteristics of the decomposed intrinsic mode function in the frequency domain.
+
+~~~python
+from pysdkit.plot import plot_IMFs_amplitude_spectra
+
+# frequency domain visualization
+plot_IMFs_amplitude_spectra(IMFs, smooth="exp")   # use exp smooth
+~~~
+
+![frequency_example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/frequency_example.jpg)
+
+## Target 🎯
+
+|                          Algorithm                           |                            Paper                             |                             Code                             | State |
+| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :---: |
+|              EMD (Empirical Mode Decomposition)              |                         [[paper]]()                          | [[code]](https://www.mathworks.com/help/signal/ref/emd.html) |   ✔️   |
+|       MEMD (Multivariate Empirical Mode Decomposition)       | [[paper]](https://royalsocietypublishing.org/doi/full/10.1098/rspa.2009.0502) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|      BEMD (Bidimensional Empirical Mode Decomposition)       | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0262885603000945) | [[code]](https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/BEMD.py) |   ✖️   |
+|         CEMD (Complex Empirical Mode Decomposition)          | [[paper]](https://ieeexplore.ieee.org/abstract/document/4063369) |                          [[code]]()                          |   ✖️   |
+|         EEMD (Ensemble Empirical Mode Decomposition)         | [[paper]](https://www.sciencedirect.com/topics/physics-and-astronomy/ensemble-empirical-mode-decomposition) | [[code]](https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/EEMD.py) |   ✖️   |
+|          REMD (Robust Empirical Mode Decomposition)          | [[paper]](https://www.sciencedirect.com/science/article/pii/S0019057821003785) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/70032-robust-empirical-mode-decomposition-remd) |   ✖️   |
+| BMEMD (Bidimensional Multivariate Empirical Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/8805082)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/72343-bidimensional-multivariate-empirical-mode-decomposition?s_tid=FX_rc1_behav) |   ✖️   |
+|     CEEMDAN (Complete Ensemble EMD with Adaptive Noise)      |   [[paper]](https://ieeexplore.ieee.org/document/5947265)    | [[code]](https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/EEMD.py) |   ✖️   |
+|           TVF_EMD (Time Varying Filter Based EMD)            | [[paper]](https://www.sciencedirect.com/science/article/pii/S0165168417301135) |   [[code]](https://github.com/stfbnc/pytvfemd/tree/master)   |   ✔️   |
+|                FAEMD (Fast and Adaptive EMD)                 |   [[paper]](https://ieeexplore.ieee.org/document/8447300)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|        MV_FAEMD (Multivariate Fast and Adaptive EMD)         |   [[paper]](https://ieeexplore.ieee.org/document/8447300)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|      MD_FAEMD (Multidimensional Fast and Adaptive EMD)       |   [[paper]](https://ieeexplore.ieee.org/document/8447300)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|                LMD (Local Mean Decomposition)                | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S1051200418308133?via%3Dihub) | [[code]](https://github.com/shownlin/PyLMD/blob/master/PyLMD/LMD.py) |   ✔️   |
+|            RLMD (Robust Local Mean Decomposition)            | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0888327017301619) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/66935-robust-local-mean-decomposition-rlmd) |   ✖️   |
+|               FMD (Feature Mode Decomposition)               |   [[paper]](https://ieeexplore.ieee.org/document/9732251)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/108099-feature-mode-decomposition-fmd) |   ✖️   |
+|              EWT (Empirical Wavelet Transform)               |   [[paper]](https://ieeexplore.ieee.org/document/6522142)    | [[code]](https://www.mathworks.com/help/wavelet/ug/empirical-wavelet-transform.html) |   ✔️   |
+|            EWT2D (2D Empirical Wavelet Transform)            |         [[paper]](https://arxiv.org/abs/2405.06188)          |        [[code]](https://github.com/bhurat/EWT-Python)        |   ✖️   |
+|             VMD (Variational Mode Decomposition)             |   [[paper]](https://ieeexplore.ieee.org/document/6655981)    |          [[code]](https://github.com/vrcarva/vmdpy)          |   ✔️   |
+|      MVMD (Multivariate Variational Mode Decomposition)      |   [[paper]](https://ieeexplore.ieee.org/document/8890883)    |          [[code]](https://github.com/yunyueye/MVMD)          |   ✔️   |
+|    VMD2D (Two-Dimensional Variational Mode Decomposition)    | [[paper]](https://ww3.math.ucla.edu/camreport/cam14-16.pdf)  | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/45918-two-dimensional-variational-mode-decomposition?s_tid=srchtitle) |   ✖️   |
+|       SVMD (Successive Variational Mode Decomposition)       | [[paper]](https://www.sciencedirect.com/science/article/pii/S0165168420301535) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/98649-successive-variational-mode-decomposition-svmd-m?s_tid=FX_rc3_behav) |   ✖️   |
+|    VNCMD (Variational Nonlinear Chirp Mode Decomposition)    |   [[paper]](https://ieeexplore.ieee.org/document/7990179)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/64292-variational-nonlinear-chirp-mode-decomposition) |   ✔️   |
+|   MNCMD (Multivariate Nonlinear Chirp Mode Decomposition)    | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0165168420302103) |                          [[code]]()                          |   ✖️   |
+| AVNCMD (Adaptive Variational Nonlinear Chirp Mode Decomposition) | [[paper]](https://ieeexplore.ieee.org/abstract/document/9746147) |         [[code]](https://github.com/HauLiang/AVNCMD)         |   ✖️   |
+|           ACMD (Adaptive Chirp Mode Decomposition)           |                         [[paper]]()                          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/121373-data-driven-adaptive-chirp-mode-decomposition?s_tid=srchtitle) |   ✔️   |
+| BA-ACMD (Bandwidth-aware adaptive chirp mode decomposition)  |                         [[paper]]()                          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/132792-bandwidth-aware-adaptive-chirp-mode-decomposition-ba-acmd?s_tid=srchtitle) |   ✖️   |
+|           JMD (Jump Plus AM-FM Mode Decomposition)           |         [[paper]](https://arxiv.org/abs/2407.07800)          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/169388-jump-plus-am-fm-mode-decomposition-jmd?s_tid=prof_contriblnk) |   ✖️   |
+|    MJMD (Multivariate Jump Plus AM-FM Mode Decomposition)    |         [[paper]](https://arxiv.org/abs/2407.07800)          | [[code]](https://ms-intl.mathworks.com/matlabcentral/fileexchange/169393-multivariate-jump-plus-am-fm-mode-decomposition-mjmd?s_tid=FX_rc2_behav) |   ✖️   |
+|      ESMD (Extreme-Point Symmetric Mode Decomposition)       |          [[paper]](https://arxiv.org/abs/1303.6540)          |         [[code]](https://github.com/WuShichao/esmd)          |   ✖️   |

{PySDKit-0.4.7 → pysdkit-0.4.10}/PySDKit.egg-info/SOURCES.txt

@@ -1,4 +1,3 @@
-LICENSE
 README.md
 setup.py
 PySDKit.egg-info/PKG-INFO
@@ -10,6 +9,7 @@ pysdkit/__init__.py
 pysdkit/data/__init__.py
 pysdkit/data/_add_noise.py
 pysdkit/data/_generator.py
+pysdkit/data/image.py
 pysdkit/emd/BEMD.py
 pysdkit/emd/EMD.py
 pysdkit/emd/__init__.py
@@ -19,27 +19,44 @@ pysdkit/emd/_splines.py
 pysdkit/emd2d/__init__.py
 pysdkit/ewt/__init__.py
 pysdkit/ewt/ewt.py
-pysdkit/metrics/_Index_of_Orthogonality.py
-pysdkit/metrics/__init__.py
+pysdkit/faemd/__init__.py
+pysdkit/faemd/faemd.py
+pysdkit/faemd/md_faemd.py
+pysdkit/faemd/mv_faemd.py
+pysdkit/fmd/__init__.py
+pysdkit/fmd/fmd.py
+pysdkit/ifd/__init__.py
+pysdkit/itd/__init__.py
+pysdkit/itd/itd.py
+pysdkit/lmd/__init__.py
+pysdkit/lmd/lmd.py
+pysdkit/lmd/rlmd.py
 pysdkit/plot/__init__.py
 pysdkit/plot/_fourier_spectra.py
 pysdkit/plot/_functions.py
 pysdkit/plot/_plot_imfs.py
-pysdkit/plot/main.py
+pysdkit/plot/plot_GrayScale.py
+pysdkit/tvf_emd/__init__.py
+pysdkit/tvf_emd/tvf_emd.py
+pysdkit/utils/_Index_of_Orthogonality.py
 pysdkit/utils/__init__.py
 pysdkit/utils/_differ.py
 pysdkit/utils/_fft.py
 pysdkit/utils/_function.py
 pysdkit/utils/_smooth1d.py
 pysdkit/utils/hilbert.py
+pysdkit/utils/instantaneous.py
 pysdkit/utils/mirror.py
 pysdkit/utils/process.py
 pysdkit/vmd/__init__.py
-pysdkit/vmd/_avmd.py
-pysdkit/vmd/_mvmd.py
-pysdkit/vmd/_svmd.py
-pysdkit/vmd/_vmd_c.py
-pysdkit/vmd/_vmd_f.py
+pysdkit/vmd/acmd.py
+pysdkit/vmd/avmd.py
 pysdkit/vmd/base.py
+pysdkit/vmd/mvmd.py
+pysdkit/vmd/svmd.py
+pysdkit/vmd/vmd_c.py
+pysdkit/vmd/vmd_f.py
+pysdkit/vmd2d/__init__.py
+pysdkit/vmd2d/vmd2d.py
 pysdkit/vncmd/__init__.py
 pysdkit/vncmd/vncmd.py

pysdkit-0.4.10/README.md

@@ -0,0 +1,114 @@
+# PySDKit: signal decomposition in Python 
+
+<div align="center">
+
+[![PyPI version](https://badge.fury.io/py/PySDKit.svg)](https://pypi.org/project/PySDKit/) 
+![License](https://img.shields.io/github/license/wwhenxuan/PySDKit)
+[![codecov](https://codecov.io/gh/wwhenxuan/PySDKit/branch/main/graph/badge.svg?token=YOUR_TOKEN)](https://codecov.io/gh/wwhenxuan/PySDKit)
+[![arXiv](https://img.shields.io/badge/arXiv-1234.56789-brightgreen.svg)](https://arxiv.org/abs/1234.56789) 
+[![Downloads](https://pepy.tech/badge/pysdkit)](https://pepy.tech/project/pysdkit)
+![Visits Badge](https://badges.pufler.dev/visits/ForestsKing/D3R)
+
+A Python library for signal decomposition algorithms 🥳
+
+<img src="https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/Logo_sd.png" alt="Logo_sd" width="500"/>
+
+</div>
+
+## Installation 🚀
+
+You can install `PySDKit` through pip:
+
+~~~
+pip install pysdkit
+~~~
+
+We only used [`NumPy`](https://numpy.org/), [`Scipy`](https://scipy.org/) and [`matplotlib`](https://matplotlib.org/) when developing the project.
+
+## Example script ✨
+
+This project integrates simple signal processing methods, signal decomposition and visualization, and builds a general interface similar to [`Scikit-learn`](https://scikit-learn.org/stable/). It is mainly divided into three steps:
+1. Import the signal decomposition method;
+2. Create an instance for signal decomposition;
+3. Use the `fit_transform` method to implement signal decomposition;
+4. Visualize and analyze the original signal and the intrinsic mode functions IMFs obtained by decomposition.
+
+~~~python
+from pysdkit import EMD
+from pysdkit.data import test_emd
+from pysdkit.plot import plot_IMFs
+
+t, signal = test_emd()
+
+# create an instance for signal decomposition
+emd = EMD()
+# implement signal decomposition
+IMFs = emd.fit_transform(signal, max_imf=2)
+plot_IMFs(signal, IMFs)
+~~~
+
+![example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/example.jpg)
+
+The EMD in the above example is the most classic [`empirical mode decomposition`](https://www.mathworks.com/help/signal/ref/emd.html) algorithm in signal decomposition. For more complex signals, you can try other algorithms such as variational mode decomposition ([`VMD`](https://ieeexplore.ieee.org/abstract/document/6655981)).
+
+~~~python
+import numpy as np
+from pysdkit import VMD
+
+# load new signal
+signal = np.load("./example/example.npy")
+
+# use variational mode decomposition
+vmd = VMD(alpha=500, K=3, tau=0.0, tol=1e-9)
+IMFs = vmd.fit_transform(signal=signal)
+print(IMFs.shape)
+
+vmd.plot_IMFs(save_figure=True)
+~~~
+
+![vmd_example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/vmd_example.jpg)
+
+Better observe the characteristics of the decomposed intrinsic mode function in the frequency domain.
+
+~~~python
+from pysdkit.plot import plot_IMFs_amplitude_spectra
+
+# frequency domain visualization
+plot_IMFs_amplitude_spectra(IMFs, smooth="exp")   # use exp smooth
+~~~
+
+![frequency_example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/frequency_example.jpg)
+
+## Target 🎯
+
+|                          Algorithm                           |                            Paper                             |                             Code                             | State |
+| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :---: |
+|              EMD (Empirical Mode Decomposition)              |                         [[paper]]()                          | [[code]](https://www.mathworks.com/help/signal/ref/emd.html) |   ✔️   |
+|       MEMD (Multivariate Empirical Mode Decomposition)       | [[paper]](https://royalsocietypublishing.org/doi/full/10.1098/rspa.2009.0502) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|      BEMD (Bidimensional Empirical Mode Decomposition)       | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0262885603000945) | [[code]](https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/BEMD.py) |   ✖️   |
+|         CEMD (Complex Empirical Mode Decomposition)          | [[paper]](https://ieeexplore.ieee.org/abstract/document/4063369) |                          [[code]]()                          |   ✖️   |
+|         EEMD (Ensemble Empirical Mode Decomposition)         | [[paper]](https://www.sciencedirect.com/topics/physics-and-astronomy/ensemble-empirical-mode-decomposition) | [[code]](https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/EEMD.py) |   ✖️   |
+|          REMD (Robust Empirical Mode Decomposition)          | [[paper]](https://www.sciencedirect.com/science/article/pii/S0019057821003785) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/70032-robust-empirical-mode-decomposition-remd) |   ✖️   |
+| BMEMD (Bidimensional Multivariate Empirical Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/8805082)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/72343-bidimensional-multivariate-empirical-mode-decomposition?s_tid=FX_rc1_behav) |   ✖️   |
+|     CEEMDAN (Complete Ensemble EMD with Adaptive Noise)      |   [[paper]](https://ieeexplore.ieee.org/document/5947265)    | [[code]](https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/EEMD.py) |   ✖️   |
+|           TVF_EMD (Time Varying Filter Based EMD)            | [[paper]](https://www.sciencedirect.com/science/article/pii/S0165168417301135) |   [[code]](https://github.com/stfbnc/pytvfemd/tree/master)   |   ✔️   |
+|                FAEMD (Fast and Adaptive EMD)                 |   [[paper]](https://ieeexplore.ieee.org/document/8447300)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|        MV_FAEMD (Multivariate Fast and Adaptive EMD)         |   [[paper]](https://ieeexplore.ieee.org/document/8447300)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|      MD_FAEMD (Multidimensional Fast and Adaptive EMD)       |   [[paper]](https://ieeexplore.ieee.org/document/8447300)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/71270-fast-and-adaptive-multivariate-and-multidimensional-emd) |   ✖️   |
+|                LMD (Local Mean Decomposition)                | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S1051200418308133?via%3Dihub) | [[code]](https://github.com/shownlin/PyLMD/blob/master/PyLMD/LMD.py) |   ✔️   |
+|            RLMD (Robust Local Mean Decomposition)            | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0888327017301619) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/66935-robust-local-mean-decomposition-rlmd) |   ✖️   |
+|               FMD (Feature Mode Decomposition)               |   [[paper]](https://ieeexplore.ieee.org/document/9732251)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/108099-feature-mode-decomposition-fmd) |   ✖️   |
+|              EWT (Empirical Wavelet Transform)               |   [[paper]](https://ieeexplore.ieee.org/document/6522142)    | [[code]](https://www.mathworks.com/help/wavelet/ug/empirical-wavelet-transform.html) |   ✔️   |
+|            EWT2D (2D Empirical Wavelet Transform)            |         [[paper]](https://arxiv.org/abs/2405.06188)          |        [[code]](https://github.com/bhurat/EWT-Python)        |   ✖️   |
+|             VMD (Variational Mode Decomposition)             |   [[paper]](https://ieeexplore.ieee.org/document/6655981)    |          [[code]](https://github.com/vrcarva/vmdpy)          |   ✔️   |
+|      MVMD (Multivariate Variational Mode Decomposition)      |   [[paper]](https://ieeexplore.ieee.org/document/8890883)    |          [[code]](https://github.com/yunyueye/MVMD)          |   ✔️   |
+|    VMD2D (Two-Dimensional Variational Mode Decomposition)    | [[paper]](https://ww3.math.ucla.edu/camreport/cam14-16.pdf)  | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/45918-two-dimensional-variational-mode-decomposition?s_tid=srchtitle) |   ✖️   |
+|       SVMD (Successive Variational Mode Decomposition)       | [[paper]](https://www.sciencedirect.com/science/article/pii/S0165168420301535) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/98649-successive-variational-mode-decomposition-svmd-m?s_tid=FX_rc3_behav) |   ✖️   |
+|    VNCMD (Variational Nonlinear Chirp Mode Decomposition)    |   [[paper]](https://ieeexplore.ieee.org/document/7990179)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/64292-variational-nonlinear-chirp-mode-decomposition) |   ✔️   |
+|   MNCMD (Multivariate Nonlinear Chirp Mode Decomposition)    | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0165168420302103) |                          [[code]]()                          |   ✖️   |
+| AVNCMD (Adaptive Variational Nonlinear Chirp Mode Decomposition) | [[paper]](https://ieeexplore.ieee.org/abstract/document/9746147) |         [[code]](https://github.com/HauLiang/AVNCMD)         |   ✖️   |
+|           ACMD (Adaptive Chirp Mode Decomposition)           |                         [[paper]]()                          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/121373-data-driven-adaptive-chirp-mode-decomposition?s_tid=srchtitle) |   ✔️   |
+| BA-ACMD (Bandwidth-aware adaptive chirp mode decomposition)  |                         [[paper]]()                          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/132792-bandwidth-aware-adaptive-chirp-mode-decomposition-ba-acmd?s_tid=srchtitle) |   ✖️   |
+|           JMD (Jump Plus AM-FM Mode Decomposition)           |         [[paper]](https://arxiv.org/abs/2407.07800)          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/169388-jump-plus-am-fm-mode-decomposition-jmd?s_tid=prof_contriblnk) |   ✖️   |
+|    MJMD (Multivariate Jump Plus AM-FM Mode Decomposition)    |         [[paper]](https://arxiv.org/abs/2407.07800)          | [[code]](https://ms-intl.mathworks.com/matlabcentral/fileexchange/169393-multivariate-jump-plus-am-fm-mode-decomposition-mjmd?s_tid=FX_rc2_behav) |   ✖️   |
+|      ESMD (Extreme-Point Symmetric Mode Decomposition)       |          [[paper]](https://arxiv.org/abs/1303.6540)          |         [[code]](https://github.com/WuShichao/esmd)          |   ✖️   |

pysdkit-0.4.10/pysdkit/__init__.py

@@ -0,0 +1,29 @@
+# 经验模态分解算法
+from .emd import EMD
+
+# 基于时变滤波器的经验模态分解
+from .tvf_emd import TVF_EMD
+
+# 变分模态分解算法
+from .vmd import vmd, VMD
+
+# 自适应调频模态分解
+from .vmd import ACMD
+
+# 多元变分模态分解算法
+from .vmd import MVMD
+
+# 非线性啁啾模式分解
+from .vncmd import VNCMD
+
+# 经验小波变换
+from .ewt import ewt, EWT
+
+# 本征时间尺度分解
+from .itd import ITD
+
+# 局部均值分解
+from .lmd import LMD
+
+# 稳健局部均值分解
+from .lmd import RLMD

{PySDKit-0.4.7 → pysdkit-0.4.10}/pysdkit/data/__init__.py

@@ -18,3 +18,6 @@ from ._generator import plot_generate_signal
 
 # add Gaussian noise
 from ._add_noise import add_noise
+
+# 加载二维灰度图像的测试案例
+from .image import test_grayscale

pysdkit-0.4.10/pysdkit/data/image.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+"""
+Created on 2025/02/02 13:01:46
+@author: Whenxuan Wang
+@email: wwhenxuan@gmail.com
+生成用于测试二维图像数据的样例
+"""
+import numpy as np
+from os import path
+
+
+def test_grayscale() -> np.ndarray:
+    """
+    加载用于测试的二维灰度图像样例
+    This data comes from https://www.mathworks.com/matlabcentral/fileexchange/45918-two-dimensional-variational-mode-decomposition
+    Konstantin, Dragomiretskiy, and Dominique Zosso. "Two-dimensional variational mode decomposition."
+    Energy Minimization Methods in Computer Vision and Pattern Recognition. Vol. 8932. 2015.
+    """
+    # 获取当前数据的路径
+    current_file_path = path.dirname(path.abspath(__file__))
+    data_path = path.join(current_file_path, "texture.txt")
+    # 读取数据并返回文件
+    return np.loadtxt(data_path)

pysdkit-0.4.10/pysdkit/ewt/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+"""
+Created on 2024/7/12 13:41
+@author: Whenxuan Wang
+@email: wwhenxuan@gmail.com
+"""
+from .ewt import ewt
+
+from .ewt import EWT