PySDKit 0.3__py3-none-any.whl → 0.4.1__py3-none-any.whl

PySDKit-0.4.1.dist-info/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

PySDKit-0.4.1.dist-info/METADATA

@@ -0,0 +1,97 @@
+Metadata-Version: 2.1
+Name: PySDKit
+Version: 0.4.1
+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
+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
+License-File: LICENSE
+Requires-Dist: numpy (>=1.24.3)
+Requires-Dist: scipy (>=1.11.1)
+Requires-Dist: matplotlib (>=3.7.2)
+
+# PySDKit: signal decomposition in Python
+
+[![PyPI version](https://badge.fury.io/py/PySDKit.svg)](https://pypi.org/project/PySDKit/) ![License](https://img.shields.io/github/license/wwhenxuan/PySDKit) [![codecov](https://codecov.io/gh/wwhenxuan/PySDKit/branch/main/graph/badge.svg?token=YOUR_TOKEN)](https://codecov.io/gh/wwhenxuan/PySDKit) [![arXiv](https://img.shields.io/badge/arXiv-1234.56789-brightgreen.svg)](https://arxiv.org/abs/1234.56789) [![Downloads](https://pepy.tech/badge/pysdkit)](https://pepy.tech/project/pysdkit) ![Static Badge](https://img.shields.io/badge/https%3A%2F%2Fimg.shields.io%2Fbadge%2Fjust%2520the%2520message--8A2BE2?logo=appveyor&logoColor=royalblue&label=NumPy&link=https%3A%2F%2Fnumpy.org%2Fdoc%2Fstable%2F) ![Static Badge](https://img.shields.io/badge/https%3A%2F%2Fimg.shields.io%2Fbadge%2Fjust%2520the%2520message--8A2BE2?logo=appveyor&logoColor=violet&label=SciPy&link=https%3A%2F%2Fdocs.scipy.org%2Fdoc%2Fscipy%2F)
+
+
+A Python library for signal decomposition algorithms
+
+![Logo](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/Logo_sd.png)
+
+## Installation
+
+You can install `PySDKit` through pip.
+
+~~~
+pip install pysdkit
+~~~
+
+We only used [`NumPy`](https://numpy.org/), [`Scipy`](https://scipy.org/) and [`matplotlib`](https://matplotlib.org/) when developing the project.
+
+## Example script
+
+This project integrates simple signal processing methods, signal decomposition and visualization, and builds a general interface similar to [`Scikit-learn`](https://scikit-learn.org/stable/). It is mainly divided into three steps:
+1. Import the signal decomposition method;
+2. Create an instance for signal decomposition;
+3. Use the `fit_transform` method to implement signal decomposition;
+4. Visualize and analyze the original signal and the intrinsic mode functions IMFs obtained by decomposition.
+
+~~~python
+from pysdkit import EMD
+from pysdkit.data import test_emd
+from pysdkit.plot import plot_IMFs
+
+t, signal = test_emd()
+
+# create an instance for signal decomposition
+emd = EMD()
+# implement signal decomposition
+IMFs = emd.fit_transform(signal, max_imf=2)
+plot_IMFs(signal, IMFs)
+~~~
+
+![example](https://raw.githubusercontent.com/wwhenxuan/PySDKit/main/images/example.jpg)
+
+The EMD in the above example is the most classic `empirical mode decomposition` 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
+from pysdkit import VMD
+
+# load new signal
+signal = np.load("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)

PySDKit-0.4.1.dist-info/RECORD

@@ -0,0 +1,42 @@
+pysdkit/__init__.py,sha256=nsuYXOdFNc3J-NNu5kkMXbeF8z_CBVLIo3tTKwEP53k,259
+pysdkit/data/__init__.py,sha256=i_ZMKR_FcLq8wWXJ0MyLA4S41iXTMWbpf9sGpoLWdpw,621
+pysdkit/data/_add_noise.py,sha256=8cGzAquIPlf0hzTMUOBj8R1SEjGd2-JveWyzPPII05M,949
+pysdkit/data/_generator.py,sha256=gW7D9A8OTKJ5CBQ40oTbowu9PMZx-WiyN43oz42OAL4,12119
+pysdkit/emd/BEMD.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pysdkit/emd/EMD.py,sha256=xyQT7IqitAQ9mdOfDDh4QEwlFU7SODl_9y5wd3M-v-k,18090
+pysdkit/emd/__init__.py,sha256=HdOfha6kuiKz2sdTENF_7bHTN2BT2Qtr5i1xXc9dOm8,22
+pysdkit/emd/_find_extrema.py,sha256=EnUZB9Z4uUaVTfuH2J2hERUR6cmsWQ890gQt8BpE1f0,5368
+pysdkit/emd/_prepare_points.py,sha256=XwEkwRPmHTZZcHhjiBx2lv_Qvj-gx2lw76locyOBf-8,10528
+pysdkit/emd/_splines.py,sha256=aaAULcznyn6mSciDeht4hdKZx1MhvKTvd0Z-bQVpd9E,2575
+pysdkit/emd2d/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pysdkit/ewt/__init__.py,sha256=Yz5QcfLHTqf_69qJ663ESoUzrbKSnhHY0angsegqhvk,60
+pysdkit/ewt/_ewt.py,sha256=TVo7GbVtBtFr7vHFQmE2PPyxX3hp0Pe3aNQyNAH_P5E,15703
+pysdkit/metrics/_Index_of_Orthogonality.py,sha256=nmUEP56TVeZqKogP0QqylJwLL3QMxUNLup273PM1yV4,1128
+pysdkit/metrics/__init__.py,sha256=4TgRjJuOxNMCEloP-Vnq-z5VnrzYKQCypUaAMJb_nkI,169
+pysdkit/plot/__init__.py,sha256=_SklnKYnFm42Yso9R_UGkzwyyi98tTngkHhgQ4JrIug,92
+pysdkit/plot/_fourier_spectra.py,sha256=7HzjHf6EeZ2DScgvMvveIQYSPVhXLfQSL6sGSUJmGZc,5068
+pysdkit/plot/_functions.py,sha256=rakosRbEg6KgdQJB26x6DGO6On3Ht9KD2MR2Wu7gSyc,4040
+pysdkit/plot/_plot_imfs.py,sha256=YsVyazrSwBzQ3EmLj7pzZqVmxolTbSljYnAP-sIJRdQ,4239
+pysdkit/plot/main.py,sha256=O_CKGAPPVaNBOqZwA7FrWcGJJEz76bbL_PomNJMtO7w,102
+pysdkit/utils/__init__.py,sha256=6M-DhV8ghK_O2PoMBnj6tLbv_3XcR1CeAqxw-DM0Ass,1076
+pysdkit/utils/_differ.py,sha256=q0AoYecFLOlPsFcbjV7G_r4AGfp8WfVJ3aD9rbHIdJo,866
+pysdkit/utils/_fft.py,sha256=VgluJaLeuuJ333_kJH1CKDbnlc6m_KX60pNfdRbv73Q,472
+pysdkit/utils/_function.py,sha256=dBF4gSjEBavAZjx0PrnZ8Z_iBk5T-zLmU3XEC1XvwTE,1436
+pysdkit/utils/_smooth1d.py,sha256=ICovGCD53Wb0YX2b0eOPEsrK85RNccbbb_zA_Wu4_Bw,3485
+pysdkit/utils/hilbert.py,sha256=74DLvAmfWOdhS391RoRBAzJ-P6rnldaPLYc3xexNPWI,3793
+pysdkit/utils/mirror.py,sha256=I4mV_pskDQjuPxLfq20jIOY0MRHI1doZd3wxvaxQhTI,1195
+pysdkit/utils/process.py,sha256=mtlY6ftqwdtjXVLVxvczUb0_ug41jZa5k__29hUR1cc,6149
+pysdkit/vmd/__init__.py,sha256=nNmNpo65_SlqZhqQXsYj-FRkCO-KHSRY2XeGp5vmzPo,73
+pysdkit/vmd/_avmd.py,sha256=xUtmiyFOqkol7Oqh_yDPzGAr6b7FrfVXG6AlDOnTvr8,473
+pysdkit/vmd/_mvmd.py,sha256=ANXqmfJA0Y5Ib80Yw0URzqHIIFFiJfg5p1CswTXiM1o,9109
+pysdkit/vmd/_svmd.py,sha256=JDoR0BrocbsHn-zeg2fJ4wkuykEVh700yZKdgPk5M2o,384
+pysdkit/vmd/_vmd_c.py,sha256=BxgdERwbyEE88NWvaKCuhSBxB3gz9hUr-2qWDoRpfZU,8758
+pysdkit/vmd/_vmd_f.py,sha256=kb2GiAThe_xqU7qLATkOdlbXj4kWFFLayKJ1nouc6eQ,5402
+pysdkit/vmd/base.py,sha256=frcDhMadR2WHM6UTnjGgufAiZhweqrNti9E71h7zUQI,3442
+pysdkit/vncmd/__init__.py,sha256=n9grWZ12fpbtfAtiQO50Bkg1sB0eiUDXbiMmbWk_i8c,25
+pysdkit/vncmd/vncmd.py,sha256=digpTAUGRsddbS3bM-9p6-5tENq-__AT7aonYgVHEzA,12362
+PySDKit-0.4.1.dist-info/LICENSE,sha256=ogEPNDSH0_dhiv_lT3ifVIdgIzHAqNA_SemnxUfPBJk,7048
+PySDKit-0.4.1.dist-info/METADATA,sha256=j2b2GUb_jvaNfM3o_Rwnr3fntyvqwy5-uC9Xqj12dmg,4376
+PySDKit-0.4.1.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+PySDKit-0.4.1.dist-info/top_level.txt,sha256=wN_Yil0woB5Tu_WrIRt4_T4eoRyXljCYvH0dL6-7ei0,8
+PySDKit-0.4.1.dist-info/RECORD,,

pysdkit/__init__.py

@@ -1,5 +1,14 @@
-# 经验模态分解算法
-from .emd import EMD
-
-# 变分模态分解算法
-from .vmd import vmd, VMD
+# 经验模态分解算法
+from .emd import EMD
+
+# 变分模态分解算法
+from .vmd import vmd, VMD
+
+# 多元变分模态分解算法
+from .vmd import MVMD
+
+# 非线性啁啾模式分解
+from .vncmd import VNCMD
+
+# 经验小波变换
+from .ewt import EWT1D

pysdkit/data/__init__.py

@@ -1,10 +1,20 @@
-# A series of functions for generating 1D NumPy signals
-from .generator import generate_sin_signal, generate_cos_signal
-from .generator import generate_square_wave, generate_triangle_wave, generate_sawtooth_wave
-from .generator import generate_am_signal, generate_exponential_signal
-
-# Generates the main test sample signal
-from .generator import test_emd
-
-# Functions that generate signal visualizations
-from .generator import plot_generate_signal
+# -*- coding: utf-8 -*-
+"""
+Created on 2024/7/22 22:56
+@author: Whenxuan Wang
+@email: wwhenxuan@gmail.com
+"""
+
+# A series of functions for generating 1D NumPy signals
+from ._generator import generate_sin_signal, generate_cos_signal
+from ._generator import generate_square_wave, generate_triangle_wave, generate_sawtooth_wave
+from ._generator import generate_am_signal, generate_exponential_signal
+
+# Generates the main test sample signal
+from ._generator import test_emd
+
+# Functions that generate signal visualizations
+from ._generator import plot_generate_signal
+
+# add Gaussian noise
+from ._add_noise import add_noise

pysdkit/data/_add_noise.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Sat Mar 8 21:45:02 2024
+@author: Whenxuan Wang
+@email: wwhenxuan@gmail.com
+"""
+import numpy as np
+
+
+def add_noise(N: int, Mean: float, STD: float) -> np.ndarray:
+    """
+    Generate Gaussian white noise with mean values Mean and standard deviation STD.
+    :param N: The number of samples.
+    :param Mean: The mean value of the noise.
+    :param STD: The standard deviation of the noise.
+    :return: numpy.ndarray: Generated Gaussian white noise.
+    """
+    # Generate noise using the given mean and standard deviation
+    y = np.random.randn(N)
+    # Standardize y so that its standard deviation is 1
+    y = y / np.std(y)
+    # Adjust y so that its mean is 0
+    y = y - np.mean(y)
+    # Generate noise using the given mean and standard deviation
+    y = Mean + STD * y
+
+    return y
+
+
+if __name__ == '__main__':
+    N = 1000
+    Mean = 0
+    STD = 1
+    noise = add_noise(N, Mean, STD)
+    print(noise)