PySDKit 0.4.10__tar.gz → 0.4.12__tar.gz

pysdkit-0.4.12/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.2
+Name: PySDKit
+Version: 0.4.12
+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
+Requires-Dist: tqdm>=4.66.5
+Requires-Dist: requests>=2.32.3
+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)
+[![Python](https://img.shields.io/badge/python-3.8+-blue?logo=python)](https://www.python.org/)
+[![Downloads](https://pepy.tech/badge/pysdkit)](https://pepy.tech/project/pysdkit)
+![Visits Badge](https://badges.pufler.dev/visits/ForestsKing/D3R)
+[![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+A Python library for signal decomposition algorithms 🥳
+
+[Installation](#Installation) |
+[Example Script](#Example-Script) |
+[Target](#Target) |
+[Acknowledgements](#Acknowledgements)
+
+<img src="https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/Logo_sd.png" alt="Logo_sd" width="500"/>
+
+</div>
+
+## Installation 🚀 <a id="Installation"></a>
+
+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 ✨ <a id="Example-Script"></a>
+
+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_imfs=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 🎯 <a id="Target"></a>
+
+`PySDKit` is still under development. We are currently working on reproducing the signal decomposition algorithms in the table below, including not only common decomposition algorithms for `univariate signals` such as EMD and VMD, but also decomposition algorithms for `multivariate signals` such as MEMD and MVMD. We will also further reproduce the decomposition algorithms for `two-dimensional images` to make PySDKit not only suitable for signal processing, but also for image analysis and understanding.
+
+|                          Algorithm                           |                            Paper                             |                             Code                             | State |
+| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :---: |
+| [`EMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/EMD.py) (Empirical Mode Decomposition) | [[paper]](https://royalsocietypublishing.org/doi/abs/10.1098/rspa.1998.0193) | [[code]](https://www.mathworks.com/help/signal/ref/emd.html) |   ✔️   |
+| [`MEMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/memd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd2d/bemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/eemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/remd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd2d/bmemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/ceemdan.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/tvf_emd/tvf_emd.py) (Time Varying Filter Based EMD) | [[paper]](https://www.sciencedirect.com/science/article/pii/S0165168417301135) |   [[code]](https://github.com/stfbnc/pytvfemd/tree/master)   |   ✔️   |
+| [`FAEMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/faemd/faemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/faemd/md_faemd.py) (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) |   ✖️   |
+| [`HVD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/hvd/hvd.py) (Hilbert Vibration Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/pii/S0022460X06001556) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/178804-hilbert-vibration-decomposition?s_tid=FX_rc1_behav) |   ✔️   |
+| [`ITD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/itd/itd.py) (Intrinsic Time-Scale Decomposition) | [[paper]](https://royalsocietypublishing.org/doi/10.1098/rspa.2006.1761) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/69380-intrinsic-time-scale-decomposition-itd) |   ✔️   |
+| [`LMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/lmd/lmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/lmd/rlmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/fmd/fmd.py) (Feature Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/9732251)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/108099-feature-mode-decomposition-fmd) |   ✖️   |
+| [`SSA`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/ssa/ssa.py) (Singular Spectral Analysis) | [[paper]](https://orca.cardiff.ac.uk/id/eprint/15208/1/Zhiglavsky_SSA_encyclopedia.pdf) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/58967-singular-spectrum-analysis-beginners-guide) |   ✔️   |
+| [`EWT`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/ewt/ewt.py) (Empirical Wavelet Transform) |   [[paper]](https://ieeexplore.ieee.org/document/6522142)    | [[code]](https://www.mathworks.com/help/wavelet/ug/empirical-wavelet-transform.html) |   ✔️   |
+| [`EWT2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/ewt/ewt2d.py) (2D Empirical Wavelet Transform) |         [[paper]](https://arxiv.org/abs/2405.06188)          |        [[code]](https://github.com/bhurat/EWT-Python)        |   ✖️   |
+| [`VMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/vmd_c.py) (Variational Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/6655981)    |          [[code]](https://github.com/vrcarva/vmdpy)          |   ✔️   |
+| [`MVMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/mvmd.py) (Multivariate Variational Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/8890883)    |          [[code]](https://github.com/yunyueye/MVMD)          |   ✔️   |
+| [`VMD2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd2d/vmd2d.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/svmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vncmd/vncmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vncmd/mncmd.py) (Multivariate Nonlinear Chirp Mode Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0165168420302103) |                          [[code]]()                          |   ✖️   |
+| [`AVNCMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vncmd/avncmd.py) (Adaptive Variational Nonlinear Chirp Mode Decomposition) | [[paper]](https://ieeexplore.ieee.org/abstract/document/9746147) |         [[code]](https://github.com/HauLiang/AVNCMD)         |   ✖️   |
+| [`ACMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/acmd.py) (Adaptive Chirp Mode Decomposition) |                         [[paper]]()                          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/121373-data-driven-adaptive-chirp-mode-decomposition?s_tid=srchtitle) |   ✔️   |
+| [`BA-ACMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/ba_acmd.py) (Bandwidth-aware adaptive chirp mode decomposition) | [[paper]](https://journals.sagepub.com/doi/abs/10.1177/14759217231174699) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/132792-bandwidth-aware-adaptive-chirp-mode-decomposition-ba-acmd?s_tid=srchtitle) |   ✖️   |
+| [`JMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/jmd/jmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/jmd/mjmd.py) (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)          |   ✖️   |
+
+## Acknowledgements 🎖️ <a id="Acknowledgements"></a>
+
+We would like to thank the researchers in signal processing for providing us with valuable algorithms and promoting the continuous progress in this field. However, since the main programming language used in `signal processing` is `Matlab`, and `Python` is the main battlefield of `machine learning` and `deep learning`, the usage of signal decomposition in machine learning and deep learning is far less extensive than `wavelet transformation`. In order to further promote the organic combination of signal decomposition and machine learning, we developed `PySDKit`. We would like to express our gratitude to [PyEMD](https://github.com/laszukdawid/PyEMD), [Sktime](https://www.sktime.net/en/latest/index.html), [vmdpy](https://github.com/vrcarva/vmdpy),  [MEMD-Python-](https://github.com/mariogrune/MEMD-Python-),  [ewtpy](https://github.com/vrcarva/ewtpy), [EWT-Python](https://github.com/bhurat/EWT-Python), [PyLMD](https://github.com/shownlin/PyLMD), [pywt](https://github.com/PyWavelets/pywt), [SP_Lib](https://github.com/hustcxl/SP_Lib)and [dsatools](https://github.com/MVRonkin/dsatools).

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

@@ -0,0 +1,165 @@
+Metadata-Version: 2.2
+Name: PySDKit
+Version: 0.4.12
+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
+Requires-Dist: tqdm>=4.66.5
+Requires-Dist: requests>=2.32.3
+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)
+[![Python](https://img.shields.io/badge/python-3.8+-blue?logo=python)](https://www.python.org/)
+[![Downloads](https://pepy.tech/badge/pysdkit)](https://pepy.tech/project/pysdkit)
+![Visits Badge](https://badges.pufler.dev/visits/ForestsKing/D3R)
+[![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+A Python library for signal decomposition algorithms 🥳
+
+[Installation](#Installation) |
+[Example Script](#Example-Script) |
+[Target](#Target) |
+[Acknowledgements](#Acknowledgements)
+
+<img src="https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/Logo_sd.png" alt="Logo_sd" width="500"/>
+
+</div>
+
+## Installation 🚀 <a id="Installation"></a>
+
+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 ✨ <a id="Example-Script"></a>
+
+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_imfs=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 🎯 <a id="Target"></a>
+
+`PySDKit` is still under development. We are currently working on reproducing the signal decomposition algorithms in the table below, including not only common decomposition algorithms for `univariate signals` such as EMD and VMD, but also decomposition algorithms for `multivariate signals` such as MEMD and MVMD. We will also further reproduce the decomposition algorithms for `two-dimensional images` to make PySDKit not only suitable for signal processing, but also for image analysis and understanding.
+
+|                          Algorithm                           |                            Paper                             |                             Code                             | State |
+| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :---: |
+| [`EMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/EMD.py) (Empirical Mode Decomposition) | [[paper]](https://royalsocietypublishing.org/doi/abs/10.1098/rspa.1998.0193) | [[code]](https://www.mathworks.com/help/signal/ref/emd.html) |   ✔️   |
+| [`MEMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/memd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd2d/bemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/eemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/remd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd2d/bmemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/ceemdan.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/tvf_emd/tvf_emd.py) (Time Varying Filter Based EMD) | [[paper]](https://www.sciencedirect.com/science/article/pii/S0165168417301135) |   [[code]](https://github.com/stfbnc/pytvfemd/tree/master)   |   ✔️   |
+| [`FAEMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/faemd/faemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/faemd/md_faemd.py) (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) |   ✖️   |
+| [`HVD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/hvd/hvd.py) (Hilbert Vibration Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/pii/S0022460X06001556) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/178804-hilbert-vibration-decomposition?s_tid=FX_rc1_behav) |   ✔️   |
+| [`ITD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/itd/itd.py) (Intrinsic Time-Scale Decomposition) | [[paper]](https://royalsocietypublishing.org/doi/10.1098/rspa.2006.1761) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/69380-intrinsic-time-scale-decomposition-itd) |   ✔️   |
+| [`LMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/lmd/lmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/lmd/rlmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/fmd/fmd.py) (Feature Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/9732251)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/108099-feature-mode-decomposition-fmd) |   ✖️   |
+| [`SSA`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/ssa/ssa.py) (Singular Spectral Analysis) | [[paper]](https://orca.cardiff.ac.uk/id/eprint/15208/1/Zhiglavsky_SSA_encyclopedia.pdf) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/58967-singular-spectrum-analysis-beginners-guide) |   ✔️   |
+| [`EWT`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/ewt/ewt.py) (Empirical Wavelet Transform) |   [[paper]](https://ieeexplore.ieee.org/document/6522142)    | [[code]](https://www.mathworks.com/help/wavelet/ug/empirical-wavelet-transform.html) |   ✔️   |
+| [`EWT2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/ewt/ewt2d.py) (2D Empirical Wavelet Transform) |         [[paper]](https://arxiv.org/abs/2405.06188)          |        [[code]](https://github.com/bhurat/EWT-Python)        |   ✖️   |
+| [`VMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/vmd_c.py) (Variational Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/6655981)    |          [[code]](https://github.com/vrcarva/vmdpy)          |   ✔️   |
+| [`MVMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/mvmd.py) (Multivariate Variational Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/8890883)    |          [[code]](https://github.com/yunyueye/MVMD)          |   ✔️   |
+| [`VMD2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd2d/vmd2d.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/svmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vncmd/vncmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vncmd/mncmd.py) (Multivariate Nonlinear Chirp Mode Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0165168420302103) |                          [[code]]()                          |   ✖️   |
+| [`AVNCMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vncmd/avncmd.py) (Adaptive Variational Nonlinear Chirp Mode Decomposition) | [[paper]](https://ieeexplore.ieee.org/abstract/document/9746147) |         [[code]](https://github.com/HauLiang/AVNCMD)         |   ✖️   |
+| [`ACMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/acmd.py) (Adaptive Chirp Mode Decomposition) |                         [[paper]]()                          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/121373-data-driven-adaptive-chirp-mode-decomposition?s_tid=srchtitle) |   ✔️   |
+| [`BA-ACMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/ba_acmd.py) (Bandwidth-aware adaptive chirp mode decomposition) | [[paper]](https://journals.sagepub.com/doi/abs/10.1177/14759217231174699) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/132792-bandwidth-aware-adaptive-chirp-mode-decomposition-ba-acmd?s_tid=srchtitle) |   ✖️   |
+| [`JMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/jmd/jmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/jmd/mjmd.py) (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)          |   ✖️   |
+
+## Acknowledgements 🎖️ <a id="Acknowledgements"></a>
+
+We would like to thank the researchers in signal processing for providing us with valuable algorithms and promoting the continuous progress in this field. However, since the main programming language used in `signal processing` is `Matlab`, and `Python` is the main battlefield of `machine learning` and `deep learning`, the usage of signal decomposition in machine learning and deep learning is far less extensive than `wavelet transformation`. In order to further promote the organic combination of signal decomposition and machine learning, we developed `PySDKit`. We would like to express our gratitude to [PyEMD](https://github.com/laszukdawid/PyEMD), [Sktime](https://www.sktime.net/en/latest/index.html), [vmdpy](https://github.com/vrcarva/vmdpy),  [MEMD-Python-](https://github.com/mariogrune/MEMD-Python-),  [ewtpy](https://github.com/vrcarva/ewtpy), [EWT-Python](https://github.com/bhurat/EWT-Python), [PyLMD](https://github.com/shownlin/PyLMD), [pywt](https://github.com/PyWavelets/pywt), [SP_Lib](https://github.com/hustcxl/SP_Lib)and [dsatools](https://github.com/MVRonkin/dsatools).

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

@@ -9,41 +9,65 @@ 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/data/_image.py
+pysdkit/data/texture.txt
 pysdkit/emd/__init__.py
 pysdkit/emd/_find_extrema.py
 pysdkit/emd/_prepare_points.py
 pysdkit/emd/_splines.py
+pysdkit/emd/ceemdan.py
+pysdkit/emd/eemd.py
+pysdkit/emd/emd.py
+pysdkit/emd/memd.py
+pysdkit/emd/remd.py
 pysdkit/emd2d/__init__.py
+pysdkit/emd2d/bemd.py
+pysdkit/emd2d/bmemd.py
+pysdkit/emd2d/emd2d.py
+pysdkit/esmd/__init__.py
+pysdkit/esmd/esmd.py
 pysdkit/ewt/__init__.py
 pysdkit/ewt/ewt.py
+pysdkit/ewt/ewt2d.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/hht/__init__.py
+pysdkit/hht/hht.py
+pysdkit/hvd/__init__.py
+pysdkit/hvd/hvd.py
 pysdkit/ifd/__init__.py
 pysdkit/itd/__init__.py
 pysdkit/itd/itd.py
+pysdkit/jmd/__init__.py
+pysdkit/jmd/jmd.py
+pysdkit/jmd/mjmd.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_images.py
 pysdkit/plot/_plot_imfs.py
-pysdkit/plot/plot_GrayScale.py
+pysdkit/ssa/__init__.py
+pysdkit/ssa/ssa.py
 pysdkit/tvf_emd/__init__.py
 pysdkit/tvf_emd/tvf_emd.py
 pysdkit/utils/_Index_of_Orthogonality.py
 pysdkit/utils/__init__.py
+pysdkit/utils/_diagnalization.py
 pysdkit/utils/_differ.py
 pysdkit/utils/_fft.py
 pysdkit/utils/_function.py
+pysdkit/utils/_kernel_matrix.py
+pysdkit/utils/_lags.py
 pysdkit/utils/_smooth1d.py
+pysdkit/utils/_types.py
+pysdkit/utils/correlation.py
 pysdkit/utils/hilbert.py
 pysdkit/utils/instantaneous.py
 pysdkit/utils/mirror.py
@@ -51,6 +75,7 @@ pysdkit/utils/process.py
 pysdkit/vmd/__init__.py
 pysdkit/vmd/acmd.py
 pysdkit/vmd/avmd.py
+pysdkit/vmd/ba_acmd.py
 pysdkit/vmd/base.py
 pysdkit/vmd/mvmd.py
 pysdkit/vmd/svmd.py
@@ -59,4 +84,6 @@ pysdkit/vmd/vmd_f.py
 pysdkit/vmd2d/__init__.py
 pysdkit/vmd2d/vmd2d.py
 pysdkit/vncmd/__init__.py
+pysdkit/vncmd/anvcmd.py
+pysdkit/vncmd/mncmd.py
 pysdkit/vncmd/vncmd.py

{pysdkit-0.4.10 → pysdkit-0.4.12}/PySDKit.egg-info/requires.txt

@@ -1,3 +1,5 @@
 numpy<=1.26.4,>=1.24.3
 scipy<=1.13.1,>=1.11.1
 matplotlib<=3.8.4,>=3.7.2
+tqdm>=4.66.5
+requests>=2.32.3

pysdkit-0.4.12/README.md

@@ -0,0 +1,128 @@
+# 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)
+[![Python](https://img.shields.io/badge/python-3.8+-blue?logo=python)](https://www.python.org/)
+[![Downloads](https://pepy.tech/badge/pysdkit)](https://pepy.tech/project/pysdkit)
+![Visits Badge](https://badges.pufler.dev/visits/ForestsKing/D3R)
+[![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+A Python library for signal decomposition algorithms 🥳
+
+[Installation](#Installation) |
+[Example Script](#Example-Script) |
+[Target](#Target) |
+[Acknowledgements](#Acknowledgements)
+
+<img src="https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/Logo_sd.png" alt="Logo_sd" width="500"/>
+
+</div>
+
+## Installation 🚀 <a id="Installation"></a>
+
+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 ✨ <a id="Example-Script"></a>
+
+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_imfs=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 🎯 <a id="Target"></a>
+
+`PySDKit` is still under development. We are currently working on reproducing the signal decomposition algorithms in the table below, including not only common decomposition algorithms for `univariate signals` such as EMD and VMD, but also decomposition algorithms for `multivariate signals` such as MEMD and MVMD. We will also further reproduce the decomposition algorithms for `two-dimensional images` to make PySDKit not only suitable for signal processing, but also for image analysis and understanding.
+
+|                          Algorithm                           |                            Paper                             |                             Code                             | State |
+| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :---: |
+| [`EMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/EMD.py) (Empirical Mode Decomposition) | [[paper]](https://royalsocietypublishing.org/doi/abs/10.1098/rspa.1998.0193) | [[code]](https://www.mathworks.com/help/signal/ref/emd.html) |   ✔️   |
+| [`MEMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/memd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd2d/bemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/eemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/remd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd2d/bmemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/emd/ceemdan.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/tvf_emd/tvf_emd.py) (Time Varying Filter Based EMD) | [[paper]](https://www.sciencedirect.com/science/article/pii/S0165168417301135) |   [[code]](https://github.com/stfbnc/pytvfemd/tree/master)   |   ✔️   |
+| [`FAEMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/faemd/faemd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/faemd/md_faemd.py) (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) |   ✖️   |
+| [`HVD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/hvd/hvd.py) (Hilbert Vibration Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/pii/S0022460X06001556) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/178804-hilbert-vibration-decomposition?s_tid=FX_rc1_behav) |   ✔️   |
+| [`ITD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/itd/itd.py) (Intrinsic Time-Scale Decomposition) | [[paper]](https://royalsocietypublishing.org/doi/10.1098/rspa.2006.1761) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/69380-intrinsic-time-scale-decomposition-itd) |   ✔️   |
+| [`LMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/lmd/lmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/lmd/rlmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/fmd/fmd.py) (Feature Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/9732251)    | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/108099-feature-mode-decomposition-fmd) |   ✖️   |
+| [`SSA`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/ssa/ssa.py) (Singular Spectral Analysis) | [[paper]](https://orca.cardiff.ac.uk/id/eprint/15208/1/Zhiglavsky_SSA_encyclopedia.pdf) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/58967-singular-spectrum-analysis-beginners-guide) |   ✔️   |
+| [`EWT`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/ewt/ewt.py) (Empirical Wavelet Transform) |   [[paper]](https://ieeexplore.ieee.org/document/6522142)    | [[code]](https://www.mathworks.com/help/wavelet/ug/empirical-wavelet-transform.html) |   ✔️   |
+| [`EWT2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/ewt/ewt2d.py) (2D Empirical Wavelet Transform) |         [[paper]](https://arxiv.org/abs/2405.06188)          |        [[code]](https://github.com/bhurat/EWT-Python)        |   ✖️   |
+| [`VMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/vmd_c.py) (Variational Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/6655981)    |          [[code]](https://github.com/vrcarva/vmdpy)          |   ✔️   |
+| [`MVMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/mvmd.py) (Multivariate Variational Mode Decomposition) |   [[paper]](https://ieeexplore.ieee.org/document/8890883)    |          [[code]](https://github.com/yunyueye/MVMD)          |   ✔️   |
+| [`VMD2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd2d/vmd2d.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/svmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vncmd/vncmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vncmd/mncmd.py) (Multivariate Nonlinear Chirp Mode Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0165168420302103) |                          [[code]]()                          |   ✖️   |
+| [`AVNCMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vncmd/avncmd.py) (Adaptive Variational Nonlinear Chirp Mode Decomposition) | [[paper]](https://ieeexplore.ieee.org/abstract/document/9746147) |         [[code]](https://github.com/HauLiang/AVNCMD)         |   ✖️   |
+| [`ACMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/acmd.py) (Adaptive Chirp Mode Decomposition) |                         [[paper]]()                          | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/121373-data-driven-adaptive-chirp-mode-decomposition?s_tid=srchtitle) |   ✔️   |
+| [`BA-ACMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/vmd/ba_acmd.py) (Bandwidth-aware adaptive chirp mode decomposition) | [[paper]](https://journals.sagepub.com/doi/abs/10.1177/14759217231174699) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/132792-bandwidth-aware-adaptive-chirp-mode-decomposition-ba-acmd?s_tid=srchtitle) |   ✖️   |
+| [`JMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/jmd/jmd.py) (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`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/jmd/mjmd.py) (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)          |   ✖️   |
+
+## Acknowledgements 🎖️ <a id="Acknowledgements"></a>
+
+We would like to thank the researchers in signal processing for providing us with valuable algorithms and promoting the continuous progress in this field. However, since the main programming language used in `signal processing` is `Matlab`, and `Python` is the main battlefield of `machine learning` and `deep learning`, the usage of signal decomposition in machine learning and deep learning is far less extensive than `wavelet transformation`. In order to further promote the organic combination of signal decomposition and machine learning, we developed `PySDKit`. We would like to express our gratitude to [PyEMD](https://github.com/laszukdawid/PyEMD), [Sktime](https://www.sktime.net/en/latest/index.html), [vmdpy](https://github.com/vrcarva/vmdpy),  [MEMD-Python-](https://github.com/mariogrune/MEMD-Python-),  [ewtpy](https://github.com/vrcarva/ewtpy), [EWT-Python](https://github.com/bhurat/EWT-Python), [PyLMD](https://github.com/shownlin/PyLMD), [pywt](https://github.com/PyWavelets/pywt), [SP_Lib](https://github.com/hustcxl/SP_Lib)and [dsatools](https://github.com/MVRonkin/dsatools).