PySDKit 0.4.15__tar.gz → 0.4.17__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (139) hide show
  1. pysdkit-0.4.17/LICENSE +21 -0
  2. pysdkit-0.4.17/PKG-INFO +175 -0
  3. pysdkit-0.4.17/PySDKit.egg-info/PKG-INFO +175 -0
  4. {pysdkit-0.4.15 → pysdkit-0.4.17}/PySDKit.egg-info/SOURCES.txt +13 -6
  5. pysdkit-0.4.17/PySDKit.egg-info/requires.txt +5 -0
  6. pysdkit-0.4.17/README.md +137 -0
  7. pysdkit-0.4.17/pysdkit/__init__.py +132 -0
  8. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd/__init__.py +25 -23
  9. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd/_find_extrema.py +146 -144
  10. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd/_prepare_points.py +275 -269
  11. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd/_splines.py +130 -123
  12. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd/ceemdan.py +12 -3
  13. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd/eemd.py +12 -0
  14. pysdkit-0.4.17/pysdkit/_emd/efd.py +204 -0
  15. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd/emd.py +537 -521
  16. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd/memd.py +15 -10
  17. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd/remd.py +1 -0
  18. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd/tvf_emd.py +2 -0
  19. pysdkit-0.4.17/pysdkit/_emd2d/__init__.py +7 -0
  20. pysdkit-0.4.17/pysdkit/_emd2d/emd2d.py +411 -0
  21. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_ewt/__init__.py +9 -9
  22. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_ewt/ewt.py +7 -7
  23. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_faemd/__init__.py +2 -2
  24. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_faemd/extrema.py +6 -1
  25. pysdkit-0.4.17/pysdkit/_faemd/faemd.py +461 -0
  26. pysdkit-0.4.15/pysdkit/_faemd/md_faemd.py → pysdkit-0.4.17/pysdkit/_faemd/faemd2d.py +2 -2
  27. pysdkit-0.4.15/pysdkit/_faemd/mv_faemd.py → pysdkit-0.4.17/pysdkit/_faemd/faemd3d.py +2 -1
  28. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_fmd/fmd.py +1 -0
  29. pysdkit-0.4.17/pysdkit/_fmd/nfmd.py +25 -0
  30. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_hvd/hvd.py +3 -0
  31. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_jmd/__init__.py +1 -0
  32. pysdkit-0.4.17/pysdkit/_jmd/jmd.py +395 -0
  33. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_lmd/lmd.py +2 -0
  34. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_lmd/rlmd.py +1 -0
  35. pysdkit-0.4.17/pysdkit/_osd/__init__.py +21 -0
  36. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_ssa/ssa.py +2 -0
  37. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd/__init__.py +16 -14
  38. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd/acmd.py +1 -0
  39. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd/avmd.py +27 -27
  40. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd/base.py +82 -82
  41. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd/mvmd.py +260 -255
  42. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd/svmd.py +402 -402
  43. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd/vmd_c.py +273 -266
  44. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd/vmd_f.py +157 -155
  45. pysdkit-0.4.17/pysdkit/_vmd/vme.py +219 -0
  46. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd2d/cvmd2d.py +5 -0
  47. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd2d/vmd2d.py +2 -0
  48. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vncmd/__init__.py +9 -9
  49. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vncmd/incmd.py +21 -8
  50. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vncmd/vncmd.py +347 -339
  51. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/data/__init__.py +48 -48
  52. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/data/_add_noise.py +29 -27
  53. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/data/_cube.py +22 -7
  54. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/data/_generator.py +504 -471
  55. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/data/_image.py +12 -1
  56. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/entropy/_permutation_entropy.py +3 -0
  57. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/entropy/_sample_entropy.py +5 -3
  58. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/hht/hht.py +2 -0
  59. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/plot/__init__.py +22 -22
  60. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/plot/_fourier_spectra.py +147 -146
  61. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/plot/_functions.py +102 -102
  62. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/plot/_plot_images.py +1 -1
  63. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/plot/_plot_imfs.py +587 -585
  64. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/plot/_plot_signal.py +1 -0
  65. pysdkit-0.4.17/pysdkit/tests/test_ceemdan.py +294 -0
  66. pysdkit-0.4.17/pysdkit/tests/test_faemd.py +170 -0
  67. pysdkit-0.4.17/pysdkit/tests/test_faemd2d.py +10 -0
  68. pysdkit-0.4.17/pysdkit/tests/test_faemd3d.py +10 -0
  69. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tsa/__init__.py +4 -0
  70. pysdkit-0.4.17/pysdkit/tsa/_dtw.py +54 -0
  71. pysdkit-0.4.17/pysdkit/tsa/_knn.py +152 -0
  72. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tsa/_moving_decomp.py +5 -0
  73. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/utils/__init__.py +107 -107
  74. pysdkit-0.4.17/pysdkit/utils/_cite.py +33 -0
  75. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/utils/_diagnalization.py +224 -228
  76. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/utils/_differ.py +34 -33
  77. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/utils/_fft.py +32 -32
  78. pysdkit-0.4.17/pysdkit/utils/_function.py +357 -0
  79. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/utils/_hilbert.py +119 -116
  80. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/utils/_kernel_matrix.py +288 -270
  81. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/utils/_mirror.py +47 -40
  82. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/utils/_process.py +156 -148
  83. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/utils/_smooth1d.py +124 -119
  84. {pysdkit-0.4.15 → pysdkit-0.4.17}/setup.py +44 -42
  85. pysdkit-0.4.15/PKG-INFO +0 -168
  86. pysdkit-0.4.15/PySDKit.egg-info/PKG-INFO +0 -168
  87. pysdkit-0.4.15/PySDKit.egg-info/requires.txt +0 -5
  88. pysdkit-0.4.15/README.md +0 -133
  89. pysdkit-0.4.15/pysdkit/__init__.py +0 -59
  90. pysdkit-0.4.15/pysdkit/_emd2d/__init__.py +0 -0
  91. pysdkit-0.4.15/pysdkit/_emd2d/emd2d.py +0 -18
  92. pysdkit-0.4.15/pysdkit/_faemd/faemd.py +0 -63
  93. pysdkit-0.4.15/pysdkit/_jmd/jmd.py +0 -40
  94. pysdkit-0.4.15/pysdkit/tsa/_dtw.py +0 -264
  95. pysdkit-0.4.15/pysdkit/utils/_Index_of_Orthogonality.py +0 -38
  96. pysdkit-0.4.15/pysdkit/utils/_cite.py +0 -8
  97. pysdkit-0.4.15/pysdkit/utils/_function.py +0 -57
  98. pysdkit-0.4.15/pysdkit/utils/_lags.py +0 -163
  99. pysdkit-0.4.15/pysdkit/utils/_types.py +0 -79
  100. {pysdkit-0.4.15 → pysdkit-0.4.17}/PySDKit.egg-info/dependency_links.txt +0 -0
  101. {pysdkit-0.4.15 → pysdkit-0.4.17}/PySDKit.egg-info/top_level.txt +0 -0
  102. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd2d/bemd.py +0 -0
  103. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_emd2d/bmemd.py +0 -0
  104. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_esmd/__init__.py +0 -0
  105. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_esmd/esmd.py +0 -0
  106. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_ewt/ewt2d.py +0 -0
  107. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_faemd/filter.py +0 -0
  108. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_fmd/__init__.py +0 -0
  109. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_hvd/__init__.py +0 -0
  110. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_ifd/__init__.py +0 -0
  111. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_itd/__init__.py +0 -0
  112. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_itd/itd.py +0 -0
  113. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_jmd/mjmd.py +0 -0
  114. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_lmd/__init__.py +0 -0
  115. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_ssa/__init__.py +0 -0
  116. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd/ba_acmd.py +0 -0
  117. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vmd2d/__init__.py +0 -0
  118. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vncmd/anvcmd.py +0 -0
  119. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/_vncmd/mncmd.py +0 -0
  120. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/data/_time_series.py +0 -0
  121. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/data/texture.txt +0 -0
  122. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/entropy/__init__.py +0 -0
  123. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/entropy/_approxiamte_entropy.py +0 -0
  124. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/hht/__init__.py +0 -0
  125. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tests/__init__.py +0 -0
  126. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tests/test_all.py +0 -0
  127. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tests/test_emd.py +0 -0
  128. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tests/test_ewt.py +0 -0
  129. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tests/test_generator_cube.py +0 -0
  130. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tests/test_generator_image.py +0 -0
  131. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tests/test_generator_signal.py +0 -0
  132. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tests/test_moving_decomp.py +0 -0
  133. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tests/test_vmd.py +0 -0
  134. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tests/test_vmd2d.py +0 -0
  135. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tsa/_mstl.py +0 -0
  136. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/tsa/_stl.py +0 -0
  137. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/utils/_correlation.py +0 -0
  138. {pysdkit-0.4.15 → pysdkit-0.4.17}/pysdkit/utils/_instantaneous.py +0 -0
  139. {pysdkit-0.4.15 → pysdkit-0.4.17}/setup.cfg +0 -0
pysdkit-0.4.17/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2019 Whenxuan Wang
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,175 @@
1
+ Metadata-Version: 2.2
2
+ Name: PySDKit
3
+ Version: 0.4.17
4
+ Summary: A Python library for signal decomposition algorithms with a unified interface.
5
+ Home-page: https://github.com/wwhenxuan/PySDKit
6
+ Author: whenxuan
7
+ Author-email: wwhenxuan@gmail.com
8
+ Keywords: signal decomposition,signal processing,machine learning
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Intended Audience :: Science/Research
11
+ Classifier: Topic :: Scientific/Engineering :: Mathematics
12
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
13
+ Classifier: License :: OSI Approved :: MIT License
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.6
16
+ Classifier: Programming Language :: Python :: 3.7
17
+ Classifier: Programming Language :: Python :: 3.8
18
+ Classifier: Programming Language :: Python :: 3.9
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Requires-Python: >=3.6
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE
23
+ Requires-Dist: numpy>=1.24.3
24
+ Requires-Dist: scipy>=1.11.1
25
+ Requires-Dist: matplotlib>=3.7.2
26
+ Requires-Dist: tqdm>=4.66.5
27
+ Requires-Dist: requests>=2.32.3
28
+ Dynamic: author
29
+ Dynamic: author-email
30
+ Dynamic: classifier
31
+ Dynamic: description
32
+ Dynamic: description-content-type
33
+ Dynamic: home-page
34
+ Dynamic: keywords
35
+ Dynamic: requires-dist
36
+ Dynamic: requires-python
37
+ Dynamic: summary
38
+
39
+ # PySDKit: signal decomposition in Python
40
+
41
+ <div align="center">
42
+
43
+ [![PyPI version](https://badge.fury.io/py/PySDKit.svg)](https://pypi.org/project/PySDKit/)
44
+ ![License](https://img.shields.io/github/license/wwhenxuan/PySDKit)
45
+ [![Python](https://img.shields.io/badge/python-3.8+-blue?logo=python)](https://www.python.org/)
46
+ [![Downloads](https://pepy.tech/badge/pysdkit)](https://pepy.tech/project/pysdkit)
47
+ [![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
48
+
49
+ A Python library for signal decomposition algorithms 🥳
50
+
51
+ [Installation](#Installation) |
52
+ [Example Script](#Example-Script) |
53
+ [Target](#Target) |
54
+ [Acknowledgements](#Acknowledgements)
55
+
56
+ <img src="https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/Logo_sd.png" alt="Logo_sd" width="500"/>
57
+
58
+ </div>
59
+
60
+ ## Installation 🚀 <a id="Installation"></a>
61
+
62
+ You can install `PySDKit` through pip:
63
+
64
+ ~~~
65
+ pip install pysdkit
66
+ ~~~
67
+
68
+ We only used [`NumPy`](https://numpy.org/), [`Scipy`](https://scipy.org/) and [`matplotlib`](https://matplotlib.org/) when developing the project.
69
+
70
+ ## Example Script ✨ <a id="Example-Script"></a>
71
+
72
+ 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:
73
+ 1. Import the signal decomposition method;
74
+ 2. Create an instance for signal decomposition;
75
+ 3. Use the `fit_transform` method to implement signal decomposition;
76
+ 4. Visualize and analyze the original signal and the intrinsic mode functions IMFs obtained by decomposition.
77
+
78
+ ~~~python
79
+ from pysdkit import EMD
80
+ from pysdkit.data import test_emd
81
+ from pysdkit.plot import plot_IMFs
82
+
83
+ t, signal = test_emd()
84
+
85
+ # create an instance for signal decomposition
86
+ emd = EMD()
87
+ # implement signal decomposition
88
+ IMFs = emd.fit_transform(signal, max_imfs=2)
89
+ plot_IMFs(signal, IMFs)
90
+ ~~~
91
+
92
+ ![example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/example.jpg)
93
+
94
+ 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)).
95
+
96
+ ~~~python
97
+ import numpy as np
98
+ from pysdkit import VMD
99
+
100
+ # load new signal
101
+ signal = np.load("./example/example.npy")
102
+
103
+ # use variational mode decomposition
104
+ vmd = VMD(alpha=500, K=3, tau=0.0, tol=1e-9)
105
+ IMFs = vmd.fit_transform(signal=signal)
106
+ print(IMFs.shape)
107
+
108
+ vmd.plot_IMFs(save_figure=True)
109
+ ~~~
110
+
111
+ ![vmd_example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/vmd_example.jpg)
112
+
113
+ Better observe the characteristics of the decomposed intrinsic mode function in the frequency domain.
114
+
115
+ ~~~python
116
+ from pysdkit.plot import plot_IMFs_amplitude_spectra
117
+
118
+ # frequency domain visualization
119
+ plot_IMFs_amplitude_spectra(IMFs, smooth="exp") # use exp smooth
120
+ ~~~
121
+
122
+ ![frequency_example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/frequency_example.jpg)
123
+
124
+ ## Target 🎯 <a id="Target"></a>
125
+
126
+ `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. See [`Mission`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/README.md) for the reasons why we developed PySDKit.
127
+
128
+ | Algorithm | Paper | Code | State |
129
+ |:---------------------------------------------------------------------------------------------------------------------------------------------:| :----------------------------------------------------------: | :----------------------------------------------------------: | :---: |
130
+ | [`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) | ✔️ |
131
+ | [`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) | ✔️ |
132
+ | [`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) | ✖️ |
133
+ | [`CEMD`]() (Complex Empirical Mode Decomposition) | [[paper]](https://ieeexplore.ieee.org/abstract/document/4063369) | [[code]]() | ✖️ |
134
+ | [`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) | ✔️ |
135
+ | [`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) | ✔️ |
136
+ | [`EMD2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_emd2d/emd2d.py) (Empirical Mode Decomposition 2D for images) | [[paper]](http://aquador.vovve.net/IEMD/) | [[code]](http://aquador.vovve.net/IEMD/) | ✔️ |
137
+ | [`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) | ✖️ |
138
+ | [`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) | ✔️ |
139
+ | [`TVF_EMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_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) | ✔️ |
140
+ | [`EFD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_emd/efd.py) (Empirical Fourier Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0888327021005355) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/97747-empirical-fourier-decomposition-efd) | ✔️ |
141
+ | [`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) | ✔️ |
142
+ | [`FAEMD2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_faemd/faemd2d.py) (Two-Dimensional 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) | ✖️ |
143
+ | [`FAEMD3D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_faemd/faemd3d.py) (Three-Dimensional 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) | ✖️ |
144
+ | [`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) | ✔️ |
145
+ | [`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) | ✔️ |
146
+ | [`ALIF`]() (Adaptive Local Iterative Filtering) | [[paper]](https://arxiv.org/abs/1411.6051) | [[code]](https://ww2.mathworks.cn/matlabcentral/fileexchange/56210-alif) | ✖️ |
147
+ | [`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) | ✔️ |
148
+ | [`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) | ✖️ |
149
+ | [`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) | ✖️ |
150
+ | [`NFMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_fmd/nfmd.py) (Non-stationary Feature Mode Decomposition) | [[paper]](https://ieeexplore.ieee.org/document/9732251) | [[code]](https://github.com/sheadan/NFMD-ExtractionInstantaneous/blob/master/nfmd/NFMD.py) | ✖️ |
151
+ | [`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) | ✔️ |
152
+ | [`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) | ✔️ |
153
+ | [`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) | ✖️ |
154
+ | [`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) | ✔️ |
155
+ | [`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) | ✔️ |
156
+ | [`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) | ✔️ |
157
+ | [`CVMD2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_vmd2d/cvmd2d.py) (Two-Dimensional Compact Variational Mode Decomposition) | [[paper]](https://link.springer.com/article/10.1007/s10851-017-0710-z) | [[code]](https://ww2.mathworks.cn/matlabcentral/fileexchange/67285-two-dimensional-compact-variational-mode-decomposition-2d-tv-vmd?s_tid=FX_rc2_behav) | ✔️ |
158
+ | [`VME`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_vmd/vme.py) (Variational Mode Extraction) | [[paper]](https://ieeexplore.ieee.org/document/7997854) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/76003-variational-mode-extraction-vme-m?s_tid=srchtitle) | ✔️ |
159
+ | [`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) | ✖️ |
160
+ | [`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) | ✔️ |
161
+ | [`INCMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_vncmd/incmd.py) (Iterative Nonlinear Chirp Mode Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/pii/S0022460X2030403X?via%3Dihub) | [[code]](https://github.com/sheadan/IterativeNCMD) | ✔️ |
162
+ | [`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]]() | ✖️ |
163
+ | [`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) | ✖️ |
164
+ | [`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) | ✔️ |
165
+ | [`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) | ✖️ |
166
+ | [`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) | ️✔️ |
167
+ | [`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://www.mathworks.com/matlabcentral/fileexchange/169393-multivariate-jump-plus-am-fm-mode-decomposition-mjmd?s_tid=prof_contriblnk) | ✖️ |
168
+ | [`ESMD`]() (Extreme-Point Symmetric Mode Decomposition) | [[paper]](https://arxiv.org/abs/1303.6540) | [[code]](https://github.com/WuShichao/esmd) | ✖️ |
169
+ | [`STNBMD`]() (Short-Time Narrow-Band Mode Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/pii/S0022460X16002443?via%3Dihub) | [[code]](https://ww2.mathworks.cn/matlabcentral/fileexchange/56226-short-time-narrow-band-mode-decomposition-stnbmd-toolbox) | ✖️ |
170
+ | [`STL`]() (Seasonal-Trend decomposition using LOESS) | [[paper]](https://www.nniiem.ru/file/news/2016/stl-statistical-model.pdf) | [[code]](https://www.statsmodels.org/stable/examples/notebooks/generated/stl_decomposition.html) | ✖️ |
171
+ | [`MSTL`]() (Multivariate Seasonal-Trend decomposition using LOESS) | [[paper]](https://www.nniiem.ru/file/news/2016/stl-statistical-model.pdf) | [[code]](https://www.statsmodels.org/stable/examples/notebooks/generated/mstl_decomposition.html) | ✖️ |
172
+
173
+ ## Acknowledgements 🎖️ <a id="Acknowledgements"></a>
174
+
175
+ 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), [Scikit-learn](https://scikit-learn.org/stable/), [Scikit-Image](https://scikit-image.org/docs/stable/), [statsmodels](https://www.statsmodels.org/stable/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), [signal-decomposition](https://github.com/wwhenxuan/signal-decomposition).
@@ -0,0 +1,175 @@
1
+ Metadata-Version: 2.2
2
+ Name: PySDKit
3
+ Version: 0.4.17
4
+ Summary: A Python library for signal decomposition algorithms with a unified interface.
5
+ Home-page: https://github.com/wwhenxuan/PySDKit
6
+ Author: whenxuan
7
+ Author-email: wwhenxuan@gmail.com
8
+ Keywords: signal decomposition,signal processing,machine learning
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Intended Audience :: Science/Research
11
+ Classifier: Topic :: Scientific/Engineering :: Mathematics
12
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
13
+ Classifier: License :: OSI Approved :: MIT License
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.6
16
+ Classifier: Programming Language :: Python :: 3.7
17
+ Classifier: Programming Language :: Python :: 3.8
18
+ Classifier: Programming Language :: Python :: 3.9
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Requires-Python: >=3.6
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE
23
+ Requires-Dist: numpy>=1.24.3
24
+ Requires-Dist: scipy>=1.11.1
25
+ Requires-Dist: matplotlib>=3.7.2
26
+ Requires-Dist: tqdm>=4.66.5
27
+ Requires-Dist: requests>=2.32.3
28
+ Dynamic: author
29
+ Dynamic: author-email
30
+ Dynamic: classifier
31
+ Dynamic: description
32
+ Dynamic: description-content-type
33
+ Dynamic: home-page
34
+ Dynamic: keywords
35
+ Dynamic: requires-dist
36
+ Dynamic: requires-python
37
+ Dynamic: summary
38
+
39
+ # PySDKit: signal decomposition in Python
40
+
41
+ <div align="center">
42
+
43
+ [![PyPI version](https://badge.fury.io/py/PySDKit.svg)](https://pypi.org/project/PySDKit/)
44
+ ![License](https://img.shields.io/github/license/wwhenxuan/PySDKit)
45
+ [![Python](https://img.shields.io/badge/python-3.8+-blue?logo=python)](https://www.python.org/)
46
+ [![Downloads](https://pepy.tech/badge/pysdkit)](https://pepy.tech/project/pysdkit)
47
+ [![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
48
+
49
+ A Python library for signal decomposition algorithms 🥳
50
+
51
+ [Installation](#Installation) |
52
+ [Example Script](#Example-Script) |
53
+ [Target](#Target) |
54
+ [Acknowledgements](#Acknowledgements)
55
+
56
+ <img src="https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/Logo_sd.png" alt="Logo_sd" width="500"/>
57
+
58
+ </div>
59
+
60
+ ## Installation 🚀 <a id="Installation"></a>
61
+
62
+ You can install `PySDKit` through pip:
63
+
64
+ ~~~
65
+ pip install pysdkit
66
+ ~~~
67
+
68
+ We only used [`NumPy`](https://numpy.org/), [`Scipy`](https://scipy.org/) and [`matplotlib`](https://matplotlib.org/) when developing the project.
69
+
70
+ ## Example Script ✨ <a id="Example-Script"></a>
71
+
72
+ 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:
73
+ 1. Import the signal decomposition method;
74
+ 2. Create an instance for signal decomposition;
75
+ 3. Use the `fit_transform` method to implement signal decomposition;
76
+ 4. Visualize and analyze the original signal and the intrinsic mode functions IMFs obtained by decomposition.
77
+
78
+ ~~~python
79
+ from pysdkit import EMD
80
+ from pysdkit.data import test_emd
81
+ from pysdkit.plot import plot_IMFs
82
+
83
+ t, signal = test_emd()
84
+
85
+ # create an instance for signal decomposition
86
+ emd = EMD()
87
+ # implement signal decomposition
88
+ IMFs = emd.fit_transform(signal, max_imfs=2)
89
+ plot_IMFs(signal, IMFs)
90
+ ~~~
91
+
92
+ ![example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/example.jpg)
93
+
94
+ 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)).
95
+
96
+ ~~~python
97
+ import numpy as np
98
+ from pysdkit import VMD
99
+
100
+ # load new signal
101
+ signal = np.load("./example/example.npy")
102
+
103
+ # use variational mode decomposition
104
+ vmd = VMD(alpha=500, K=3, tau=0.0, tol=1e-9)
105
+ IMFs = vmd.fit_transform(signal=signal)
106
+ print(IMFs.shape)
107
+
108
+ vmd.plot_IMFs(save_figure=True)
109
+ ~~~
110
+
111
+ ![vmd_example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/vmd_example.jpg)
112
+
113
+ Better observe the characteristics of the decomposed intrinsic mode function in the frequency domain.
114
+
115
+ ~~~python
116
+ from pysdkit.plot import plot_IMFs_amplitude_spectra
117
+
118
+ # frequency domain visualization
119
+ plot_IMFs_amplitude_spectra(IMFs, smooth="exp") # use exp smooth
120
+ ~~~
121
+
122
+ ![frequency_example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/frequency_example.jpg)
123
+
124
+ ## Target 🎯 <a id="Target"></a>
125
+
126
+ `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. See [`Mission`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/README.md) for the reasons why we developed PySDKit.
127
+
128
+ | Algorithm | Paper | Code | State |
129
+ |:---------------------------------------------------------------------------------------------------------------------------------------------:| :----------------------------------------------------------: | :----------------------------------------------------------: | :---: |
130
+ | [`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) | ✔️ |
131
+ | [`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) | ✔️ |
132
+ | [`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) | ✖️ |
133
+ | [`CEMD`]() (Complex Empirical Mode Decomposition) | [[paper]](https://ieeexplore.ieee.org/abstract/document/4063369) | [[code]]() | ✖️ |
134
+ | [`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) | ✔️ |
135
+ | [`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) | ✔️ |
136
+ | [`EMD2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_emd2d/emd2d.py) (Empirical Mode Decomposition 2D for images) | [[paper]](http://aquador.vovve.net/IEMD/) | [[code]](http://aquador.vovve.net/IEMD/) | ✔️ |
137
+ | [`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) | ✖️ |
138
+ | [`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) | ✔️ |
139
+ | [`TVF_EMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_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) | ✔️ |
140
+ | [`EFD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_emd/efd.py) (Empirical Fourier Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/abs/pii/S0888327021005355) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/97747-empirical-fourier-decomposition-efd) | ✔️ |
141
+ | [`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) | ✔️ |
142
+ | [`FAEMD2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_faemd/faemd2d.py) (Two-Dimensional 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) | ✖️ |
143
+ | [`FAEMD3D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_faemd/faemd3d.py) (Three-Dimensional 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) | ✖️ |
144
+ | [`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) | ✔️ |
145
+ | [`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) | ✔️ |
146
+ | [`ALIF`]() (Adaptive Local Iterative Filtering) | [[paper]](https://arxiv.org/abs/1411.6051) | [[code]](https://ww2.mathworks.cn/matlabcentral/fileexchange/56210-alif) | ✖️ |
147
+ | [`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) | ✔️ |
148
+ | [`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) | ✖️ |
149
+ | [`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) | ✖️ |
150
+ | [`NFMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_fmd/nfmd.py) (Non-stationary Feature Mode Decomposition) | [[paper]](https://ieeexplore.ieee.org/document/9732251) | [[code]](https://github.com/sheadan/NFMD-ExtractionInstantaneous/blob/master/nfmd/NFMD.py) | ✖️ |
151
+ | [`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) | ✔️ |
152
+ | [`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) | ✔️ |
153
+ | [`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) | ✖️ |
154
+ | [`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) | ✔️ |
155
+ | [`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) | ✔️ |
156
+ | [`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) | ✔️ |
157
+ | [`CVMD2D`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_vmd2d/cvmd2d.py) (Two-Dimensional Compact Variational Mode Decomposition) | [[paper]](https://link.springer.com/article/10.1007/s10851-017-0710-z) | [[code]](https://ww2.mathworks.cn/matlabcentral/fileexchange/67285-two-dimensional-compact-variational-mode-decomposition-2d-tv-vmd?s_tid=FX_rc2_behav) | ✔️ |
158
+ | [`VME`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_vmd/vme.py) (Variational Mode Extraction) | [[paper]](https://ieeexplore.ieee.org/document/7997854) | [[code]](https://www.mathworks.com/matlabcentral/fileexchange/76003-variational-mode-extraction-vme-m?s_tid=srchtitle) | ✔️ |
159
+ | [`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) | ✖️ |
160
+ | [`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) | ✔️ |
161
+ | [`INCMD`](https://github.com/wwhenxuan/PySDKit/blob/main/pysdkit/_vncmd/incmd.py) (Iterative Nonlinear Chirp Mode Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/pii/S0022460X2030403X?via%3Dihub) | [[code]](https://github.com/sheadan/IterativeNCMD) | ✔️ |
162
+ | [`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]]() | ✖️ |
163
+ | [`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) | ✖️ |
164
+ | [`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) | ✔️ |
165
+ | [`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) | ✖️ |
166
+ | [`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) | ️✔️ |
167
+ | [`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://www.mathworks.com/matlabcentral/fileexchange/169393-multivariate-jump-plus-am-fm-mode-decomposition-mjmd?s_tid=prof_contriblnk) | ✖️ |
168
+ | [`ESMD`]() (Extreme-Point Symmetric Mode Decomposition) | [[paper]](https://arxiv.org/abs/1303.6540) | [[code]](https://github.com/WuShichao/esmd) | ✖️ |
169
+ | [`STNBMD`]() (Short-Time Narrow-Band Mode Decomposition) | [[paper]](https://www.sciencedirect.com/science/article/pii/S0022460X16002443?via%3Dihub) | [[code]](https://ww2.mathworks.cn/matlabcentral/fileexchange/56226-short-time-narrow-band-mode-decomposition-stnbmd-toolbox) | ✖️ |
170
+ | [`STL`]() (Seasonal-Trend decomposition using LOESS) | [[paper]](https://www.nniiem.ru/file/news/2016/stl-statistical-model.pdf) | [[code]](https://www.statsmodels.org/stable/examples/notebooks/generated/stl_decomposition.html) | ✖️ |
171
+ | [`MSTL`]() (Multivariate Seasonal-Trend decomposition using LOESS) | [[paper]](https://www.nniiem.ru/file/news/2016/stl-statistical-model.pdf) | [[code]](https://www.statsmodels.org/stable/examples/notebooks/generated/mstl_decomposition.html) | ✖️ |
172
+
173
+ ## Acknowledgements 🎖️ <a id="Acknowledgements"></a>
174
+
175
+ 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), [Scikit-learn](https://scikit-learn.org/stable/), [Scikit-Image](https://scikit-image.org/docs/stable/), [statsmodels](https://www.statsmodels.org/stable/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), [signal-decomposition](https://github.com/wwhenxuan/signal-decomposition).
@@ -1,3 +1,4 @@
1
+ LICENSE
1
2
  README.md
2
3
  setup.py
3
4
  PySDKit.egg-info/PKG-INFO
@@ -12,6 +13,7 @@ pysdkit/_emd/_prepare_points.py
12
13
  pysdkit/_emd/_splines.py
13
14
  pysdkit/_emd/ceemdan.py
14
15
  pysdkit/_emd/eemd.py
16
+ pysdkit/_emd/efd.py
15
17
  pysdkit/_emd/emd.py
16
18
  pysdkit/_emd/memd.py
17
19
  pysdkit/_emd/remd.py
@@ -28,11 +30,12 @@ pysdkit/_ewt/ewt2d.py
28
30
  pysdkit/_faemd/__init__.py
29
31
  pysdkit/_faemd/extrema.py
30
32
  pysdkit/_faemd/faemd.py
33
+ pysdkit/_faemd/faemd2d.py
34
+ pysdkit/_faemd/faemd3d.py
31
35
  pysdkit/_faemd/filter.py
32
- pysdkit/_faemd/md_faemd.py
33
- pysdkit/_faemd/mv_faemd.py
34
36
  pysdkit/_fmd/__init__.py
35
37
  pysdkit/_fmd/fmd.py
38
+ pysdkit/_fmd/nfmd.py
36
39
  pysdkit/_hvd/__init__.py
37
40
  pysdkit/_hvd/hvd.py
38
41
  pysdkit/_ifd/__init__.py
@@ -44,6 +47,7 @@ pysdkit/_jmd/mjmd.py
44
47
  pysdkit/_lmd/__init__.py
45
48
  pysdkit/_lmd/lmd.py
46
49
  pysdkit/_lmd/rlmd.py
50
+ pysdkit/_osd/__init__.py
47
51
  pysdkit/_ssa/__init__.py
48
52
  pysdkit/_ssa/ssa.py
49
53
  pysdkit/_vmd/__init__.py
@@ -55,6 +59,7 @@ pysdkit/_vmd/mvmd.py
55
59
  pysdkit/_vmd/svmd.py
56
60
  pysdkit/_vmd/vmd_c.py
57
61
  pysdkit/_vmd/vmd_f.py
62
+ pysdkit/_vmd/vme.py
58
63
  pysdkit/_vmd2d/__init__.py
59
64
  pysdkit/_vmd2d/cvmd2d.py
60
65
  pysdkit/_vmd2d/vmd2d.py
@@ -84,8 +89,12 @@ pysdkit/plot/_plot_imfs.py
84
89
  pysdkit/plot/_plot_signal.py
85
90
  pysdkit/tests/__init__.py
86
91
  pysdkit/tests/test_all.py
92
+ pysdkit/tests/test_ceemdan.py
87
93
  pysdkit/tests/test_emd.py
88
94
  pysdkit/tests/test_ewt.py
95
+ pysdkit/tests/test_faemd.py
96
+ pysdkit/tests/test_faemd2d.py
97
+ pysdkit/tests/test_faemd3d.py
89
98
  pysdkit/tests/test_generator_cube.py
90
99
  pysdkit/tests/test_generator_image.py
91
100
  pysdkit/tests/test_generator_signal.py
@@ -94,10 +103,10 @@ pysdkit/tests/test_vmd.py
94
103
  pysdkit/tests/test_vmd2d.py
95
104
  pysdkit/tsa/__init__.py
96
105
  pysdkit/tsa/_dtw.py
106
+ pysdkit/tsa/_knn.py
97
107
  pysdkit/tsa/_moving_decomp.py
98
108
  pysdkit/tsa/_mstl.py
99
109
  pysdkit/tsa/_stl.py
100
- pysdkit/utils/_Index_of_Orthogonality.py
101
110
  pysdkit/utils/__init__.py
102
111
  pysdkit/utils/_cite.py
103
112
  pysdkit/utils/_correlation.py
@@ -108,8 +117,6 @@ pysdkit/utils/_function.py
108
117
  pysdkit/utils/_hilbert.py
109
118
  pysdkit/utils/_instantaneous.py
110
119
  pysdkit/utils/_kernel_matrix.py
111
- pysdkit/utils/_lags.py
112
120
  pysdkit/utils/_mirror.py
113
121
  pysdkit/utils/_process.py
114
- pysdkit/utils/_smooth1d.py
115
- pysdkit/utils/_types.py
122
+ pysdkit/utils/_smooth1d.py
@@ -0,0 +1,5 @@
1
+ numpy>=1.24.3
2
+ scipy>=1.11.1
3
+ matplotlib>=3.7.2
4
+ tqdm>=4.66.5
5
+ requests>=2.32.3