PySDKit 0.4.12__tar.gz → 0.4.13__tar.gz

{pysdkit-0.4.12 → pysdkit-0.4.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PySDKit
-Version: 0.4.12
+Version: 0.4.13
 Summary: A Python library for signal decomposition algorithms with a unified interface.
 Home-page: https://github.com/wwhenxuan/PySDKit
 Author: whenxuan
@@ -43,7 +43,6 @@ Dynamic: summary
 ![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 🥳
@@ -132,7 +131,7 @@ plot_IMFs_amplitude_spectra(IMFs, smooth="exp")   # use exp smooth
 | [`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) |   ✖️   |
+| [`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)   |   ✔️   |

{pysdkit-0.4.12 → pysdkit-0.4.13}/PySDKit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PySDKit
-Version: 0.4.12
+Version: 0.4.13
 Summary: A Python library for signal decomposition algorithms with a unified interface.
 Home-page: https://github.com/wwhenxuan/PySDKit
 Author: whenxuan
@@ -43,7 +43,6 @@ Dynamic: summary
 ![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 🥳
@@ -132,7 +131,7 @@ plot_IMFs_amplitude_spectra(IMFs, smooth="exp")   # use exp smooth
 | [`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) |   ✖️   |
+| [`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)   |   ✔️   |

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

@@ -10,6 +10,7 @@ pysdkit/data/__init__.py
 pysdkit/data/_add_noise.py
 pysdkit/data/_generator.py
 pysdkit/data/_image.py
+pysdkit/data/_time_series.py
 pysdkit/data/texture.txt
 pysdkit/emd/__init__.py
 pysdkit/emd/_find_extrema.py
@@ -20,6 +21,7 @@ pysdkit/emd/eemd.py
 pysdkit/emd/emd.py
 pysdkit/emd/memd.py
 pysdkit/emd/remd.py
+pysdkit/emd/tvf_emd.py
 pysdkit/emd2d/__init__.py
 pysdkit/emd2d/bemd.py
 pysdkit/emd2d/bmemd.py
@@ -55,23 +57,24 @@ pysdkit/plot/_plot_images.py
 pysdkit/plot/_plot_imfs.py
 pysdkit/ssa/__init__.py
 pysdkit/ssa/ssa.py
-pysdkit/tvf_emd/__init__.py
-pysdkit/tvf_emd/tvf_emd.py
+pysdkit/tsa/__init__.py
+pysdkit/tsa/_moving_decomp.py
 pysdkit/utils/_Index_of_Orthogonality.py
 pysdkit/utils/__init__.py
+pysdkit/utils/_cite.py
+pysdkit/utils/_correlation.py
 pysdkit/utils/_diagnalization.py
 pysdkit/utils/_differ.py
 pysdkit/utils/_fft.py
 pysdkit/utils/_function.py
+pysdkit/utils/_hilbert.py
+pysdkit/utils/_instantaneous.py
 pysdkit/utils/_kernel_matrix.py
 pysdkit/utils/_lags.py
+pysdkit/utils/_mirror.py
+pysdkit/utils/_process.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
-pysdkit/utils/process.py
 pysdkit/vmd/__init__.py
 pysdkit/vmd/acmd.py
 pysdkit/vmd/avmd.py

{pysdkit-0.4.12 → pysdkit-0.4.13}/README.md

@@ -6,7 +6,6 @@
 ![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 🥳
@@ -95,7 +94,7 @@ plot_IMFs_amplitude_spectra(IMFs, smooth="exp")   # use exp smooth
 | [`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) |   ✖️   |
+| [`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)   |   ✔️   |

{pysdkit-0.4.12 → pysdkit-0.4.13}/pysdkit/__init__.py

@@ -7,11 +7,14 @@ from .emd import EEMD
 # 具有自适应噪声的完全集合经验模态分解
 from .emd import CEEMDAN
 
+# 稳健经验模态分解
+from .emd import REMD
+
 # 多元变分模态分解算法
 from .emd import MEMD
 
 # 基于时变滤波器的经验模态分解
-from .tvf_emd import TVF_EMD
+from .emd import TVF_EMD
 
 # 希尔伯特震动分解
 from .hvd import HVD
@@ -45,3 +48,6 @@ from .vncmd import VNCMD
 
 # 经验小波变换
 from .ewt import ewt, EWT
+
+# 滑动平均分解
+from .tsa import Moving_Decomp

{pysdkit-0.4.12 → pysdkit-0.4.13}/pysdkit/data/__init__.py

@@ -37,3 +37,6 @@ from ._image import test_uni_image
 
 # Test case for multivariate image
 from ._image import test_multi_image
+
+# Generator for 1D univariate time series data
+from ._time_series import generate_time_series

pysdkit-0.4.13/pysdkit/data/_time_series.py

@@ -0,0 +1,137 @@
+# -*- coding: utf-8 -*-
+"""
+Created on 2025/02/10 18:35:29
+@author: Whenxuan Wang
+@email: wwhenxuan@gmail.com
+Generate time series test examples
+"""
+import numpy as np
+from typing import Optional, Union
+
+
+def simulate_seasonal_term(
+    periodicity: Union[float, np.ndarray],
+    total_cycles: Union[float, np.ndarray],
+    noise_std: Union[float, np.ndarray] = 1.0,
+    harmonics=None,
+) -> np.ndarray:
+    """
+    This function is adapted from the famous statistical analysis library in Python, statsmodels.
+    It synthesizes time series data based on a specified periodicity, number of cycles, and noise.
+
+    Code reference: https://www.statsmodels.org/stable/examples/notebooks/generated/statespace_seasonal.html
+
+    :param periodicity: The length of one cycle in the seasonal pattern (e.g., the number of time steps per cycle).
+    :param total_cycles: The total number of full cycles to generate in the time series data.
+    :param noise_std: The standard deviation of the noise to be added to the seasonal components.
+    :param harmonics: The number of harmonics (sinusoidal components) used to generate the seasonal pattern.
+                       If None, it defaults to half the periodicity.
+    :return: A numpy array representing the generated time series data with seasonal behavior.
+    """
+
+    # Calculate the total duration of the time series (in terms of time steps).
+    duration = periodicity * total_cycles
+    # Ensure that the total duration is an integer.
+    assert duration == int(duration)
+    duration = int(duration)
+
+    # Set the number of harmonics if not provided. Default is half the periodicity.
+    harmonics = harmonics if harmonics else int(np.floor(periodicity / 2))
+
+    # Calculate the angular frequency corresponding to the periodicity.
+    lambda_p = 2 * np.pi / float(periodicity)
+
+    # Initialize the seasonal noise components for each harmonic (both cosine and sine components).
+    gamma_jt = noise_std * np.random.randn(harmonics)
+    gamma_star_jt = noise_std * np.random.randn(harmonics)
+
+    # Define the total number of time steps, including extra time for burn-in.
+    total_timesteps = 100 * duration  # Pad for burn-in phase
+    # Initialize an array to hold the generated time series.
+    series = np.zeros(total_timesteps)
+
+    # Loop over each time step to generate the time series data.
+    for t in range(total_timesteps):
+        # Initialize new gamma values for the next time step.
+        gamma_jtp1 = np.zeros_like(gamma_jt)
+        gamma_star_jtp1 = np.zeros_like(gamma_star_jt)
+
+        # For each harmonic, update its seasonal components (cosine and sine) based on the previous values.
+        for j in range(1, harmonics + 1):
+            # Calculate the cosine and sine values for this harmonic.
+            cos_j = np.cos(lambda_p * j)
+            sin_j = np.sin(lambda_p * j)
+
+            # Update the gamma values for the next time step using a recursive process.
+            gamma_jtp1[j - 1] = (
+                gamma_jt[j - 1] * cos_j
+                + gamma_star_jt[j - 1] * sin_j
+                + noise_std * np.random.randn()
+            )
+            gamma_star_jtp1[j - 1] = (
+                -gamma_jt[j - 1] * sin_j
+                + gamma_star_jt[j - 1] * cos_j
+                + noise_std * np.random.randn()
+            )
+
+        # Assign the new gamma values to the time series for the current time step.
+        series[t] = np.sum(gamma_jtp1)
+
+        # Move to the next time step.
+        gamma_jt = gamma_jtp1
+        gamma_star_jt = gamma_star_jtp1
+
+    # After generating the series, discard the burn-in period and return the desired portion of the time series.
+    wanted_series = series[-duration:]  # Discard burn-in phase
+
+    return wanted_series
+
+
+def generate_time_series(
+    duration: int = 300,
+    periodicities: np.ndarray = np.array([10, 30, 50]),
+    num_harmonics: np.ndarray = np.array([3, 2, 2]),
+    std: np.ndarray = np.array([2, 3, 5]),
+    seed: Optional[int] = 42,
+) -> np.ndarray:
+    """
+    Generates a time series data by combining multiple seasonal components with different periodicities,
+    numbers of harmonics, and noise levels. Each component represents a periodic signal, and the final
+    series is the sum of these components.
+
+    :param duration: The length of the time series to generate, in terms of number of time steps.
+    :param periodicities: An array of the periodicities (number of time steps per cycle) for each seasonal component.
+    :param num_harmonics: An array specifying the number of harmonics (sinusoidal components) to use for each seasonal component.
+    :param std: An array of standard deviations of the noise for each seasonal component. The noise is added to each harmonic.
+    :param seed: A random seed for reproducibility. If None, a random seed is used.
+    :return: A numpy array representing the generated time series that combines all the seasonal components.
+    """
+
+    # Set the random seed for reproducibility of the results (if provided).
+    np.random.seed(seed=seed)
+
+    # List to store the seasonal components that will be combined to form the final series.
+    terms = []
+
+    # Loop through each input periodicity and generate a seasonal time series for each.
+    for ix, _ in enumerate(periodicities):
+        # For each periodicity, generate a seasonal time series using the simulate_seasonal_term function.
+        s = simulate_seasonal_term(
+            periodicity=periodicities[
+                ix
+            ],  # The length of the cycle for this component.
+            total_cycles=duration
+            / periodicities[
+                ix
+            ],  # Number of cycles to generate based on the total duration.
+            harmonics=num_harmonics[ix],  # Number of harmonics for this component.
+            noise_std=std[ix],  # Standard deviation of noise for this component.
+        )
+        # Append the generated seasonal component to the list of terms.
+        terms.append(s)
+
+    # Combine all the seasonal components (terms) by summing them together element-wise.
+    series = np.sum(terms, axis=0)
+
+    # Return the final time series, which is a combination of the different seasonal components.
+    return series

pysdkit-0.4.13/pysdkit/emd/__init__.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+"""
+Created on 2025/02/03 18:36:18
+@author: Whenxuan Wang
+@email: wwhenxuan@gmail.com
+"""
+from ._splines import akima, cubic, pchip, cubic_hermite, cubic_spline_3pts
+
+from ._find_extrema import find_extrema_parabol, find_extrema_simple
+
+from ._prepare_points import prepare_points_parabol, prepare_points_simple
+
+from .emd import EMD
+
+from .eemd import EEMD
+
+from .ceemdan import CEEMDAN
+
+from .remd import REMD
+
+from .memd import MEMD
+
+from .tvf_emd import TVF_EMD

{pysdkit-0.4.12 → pysdkit-0.4.13}/pysdkit/emd/_find_extrema.py

@@ -7,7 +7,7 @@ The following code is mainly used to find extreme points in the EMD algorithm
 Code taken from https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/EMD.py
 """
 import numpy as np
-from pysdkit.utils.process import not_duplicate, find_zero_crossings
+from pysdkit.utils._process import not_duplicate, find_zero_crossings
 from typing import Tuple
 
 FindExtremaOutput = Tuple[np.ndarray, np.ndarray, np.ndarray, np.ndarray, np.ndarray]

{pysdkit-0.4.12 → pysdkit-0.4.13}/pysdkit/emd/ceemdan.py

@@ -125,6 +125,10 @@ class CEEMDAN(object):
             signal=signal, time=time, max_imfs=max_imfs, progress=progress
         )
 
+    def __str__(self) -> str:
+        """Get the full name and abbreviation of the algorithm"""
+        return "Complete Ensemble Empirical Mode Decomposition with Adaptive Noise (CEEMDAN)"
+
     def generate_noise(
         self, scale: float, size: Union[int, Sequence[int]]
     ) -> np.ndarray:

{pysdkit-0.4.12 → pysdkit-0.4.13}/pysdkit/emd/eemd.py

@@ -101,6 +101,10 @@ class EEMD(object):
         """allow instances to be called like functions"""
         return self.fit_transform(signal, time, max_imfs, progress)
 
+    def __str__(self) -> str:
+        """Get the full name and abbreviation of the algorithm"""
+        return "Ensemble Empirical Mode Decomposition (EEMD)"
+
     def generate_noise(
         self, scale: float, size: Union[int, Sequence[int]]
     ) -> np.ndarray:

{pysdkit-0.4.12 → pysdkit-0.4.13}/pysdkit/emd/emd.py

@@ -8,11 +8,11 @@ Code taken from https://github.com/laszukdawid/PyEMD/blob/master/PyEMD/EMD.py
 import numpy as np
 from numpy import ndarray
 from scipy.interpolate import interp1d
-from typing import Optional, Tuple, List
+from typing import Optional, Tuple
 
-from ._splines import akima, cubic, pchip, cubic_hermite, cubic_spline_3pts
-from ._find_extrema import find_extrema_parabol, find_extrema_simple
-from ._prepare_points import prepare_points_parabol, prepare_points_simple
+from pysdkit.emd import akima, cubic, pchip, cubic_hermite, cubic_spline_3pts
+from pysdkit.emd import find_extrema_parabol, find_extrema_simple
+from pysdkit.emd import prepare_points_parabol, prepare_points_simple
 
 from pysdkit.utils import get_timeline, normalize_signal, common_dtype
 
@@ -20,6 +20,7 @@ from pysdkit.utils import get_timeline, normalize_signal, common_dtype
 class EMD(object):
     """
     Empirical Mode Decomposition
+
     Huang, Norden E., et al.
     "The empirical mode decomposition and the Hilbert spectrum for nonlinear and non-stationary time series analysis."
     Proceedings of the Royal Society of London.
@@ -92,6 +93,10 @@ class EMD(object):
         """allow instances to be called like functions"""
         return self.fit_transform(signal=signal, time=time, max_imfs=max_imfs)
 
+    def __str__(self) -> str:
+        """Get the full name and abbreviation of the algorithm"""
+        return "Empirical Mode Decomposition (EMD)"
+
     @staticmethod
     def _check_length(signal: np.ndarray, time: Optional[np.ndarray] = None):
         """Check input timing and signal length are equal"""
@@ -140,7 +145,7 @@ class EMD(object):
         max_val: np.ndarray,
         min_pos: np.ndarray,
         min_val: np.ndarray,
-    ):
+    ) -> Tuple[np.ndarray, np.ndarray]:
         """
         Further processing of the maximum and minimum points of the input signal makes the upper and lower envelope spectra smoother.
         :param time: position or time array of numpy

{pysdkit-0.4.12 → pysdkit-0.4.13}/pysdkit/emd/memd.py

@@ -87,6 +87,10 @@ class MEMD(object):
         """allow instances to be called like functions"""
         return self.fit_transform(signal=signal)
 
+    def __str__(self) -> str:
+        """Get the full name and abbreviation of the algorithm"""
+        return "Multivariate Empirical Mode Decomposition (MEMD)"
+
     def init_hammersley(self, N_dim: int) -> np.ndarray:
         """Initializations for Hammersley function"""
         base = [-self.n_dir]