Skip to main content

Implementation of the Empirical Mode Decomposition (EMD) and its variations

Project description

codecov BuildStatus DocStatus Codacy

PyEMD

Links

Introduction

This is yet another Python implementation of Empirical Mode Decomposition (EMD). The package contains many EMD variations and intends to deliver more in time.

EMD variations:

  • Ensemble EMD (EEMD),
  • "Complete Ensemble EMD" (CEEMDAN)
  • different settings and configurations of vanilla EMD.
  • Image decomposition (EMD2D & BEMD) (experimental)

PyEMD allows to use different splines for envelopes, stopping criteria and extrema interpolation.

Available splines:

  • Natural cubic [default]
  • Pointwise cubic
  • Akima
  • Linear

Available stopping criteria:

  • Cauchy convergence [default]
  • Fixed number of iterations
  • Number of consecutive proto-imfs

Extrema detection:

  • Discrete extrema [default]
  • Parabolic interpolation

Installation

Recommended

Simply download this directory either directly from GitHub, or using command line:

$ git clone https://github.com/laszukdawid/PyEMD

Then go into the downloaded project and run from command line:

$ python setup.py install

PyPi

Packaged obtained from PyPi is/will be slightly behind this project, so some features might not be the same. However, it seems to be the easiest/nicest way of installing any Python packages, so why not this one?

$ pip install EMD-signal

Example

More detailed examples are included in the documentation or in the PyEMD/examples.

EMD

In most cases default settings are enough. Simply import EMD and pass your signal to instance or to emd() method.

from PyEMD import EMD
import numpy as np

s = np.random.random(100)
emd = EMD()
IMFs = emd(s)

The Figure below was produced with input: $S(t) = cos(22 \pi t^2) + 6t^2$

simpleExample

EEMD

Simplest case of using Ensemble EMD (EEMD) is by importing EEMD and passing your signal to the instance or eemd() method.

from PyEMD import EEMD
import numpy as np

s = np.random.random(100)
eemd = EEMD()
eIMFs = eemd(s)

CEEMDAN

As with previous methods, there is also simple way to use CEEMDAN.

from PyEMD import CEEMDAN
import numpy as np

s = np.random.random(100)
ceemdan = CEEMDAN()
cIMFs = ceemdan(s)

Visualisation

The package contain a simple visualisation helper that can help, e.g., with time series and instantaneous frequencies.

import numpy as np
from PyEMD import EMD, Visualisation

t = np.arange(0, 3, 0.01)
S = np.sin(13*t + 0.2*t**1.4) - np.cos(3*t)

# Extract imfs and residue
# In case of EMD
emd = EMD()
emd.emd(S)
imfs, res = emd.get_imfs_and_residue()

# In general:
#components = EEMD()(S)
#imfs, res = components[:-1], components[-1]

vis = Visualisation()
vis.plot_imfs(imfs=imfs, residue=res, t=t, include_residue=True)
vis.plot_instant_freq(t, imfs=imfs)
vis.show()

EMD2D/BEMD

Unfortunately, this is Experimental and we can't guarantee that the output is meaningful. The simplest use is to pass image as monochromatic numpy 2D array. Sample as with the other modules one can use the default setting of an instance or, more explicitly, use the emd2d() method.

from PyEMD import EMD2D  #, BEMD
import numpy as np

x, y = np.arange(128), np.arange(128).reshape((-1,1))
img = np.sin(0.1*x)*np.cos(0.2*y)
emd2d = EMD2D()  # BEMD() also works
IMFs_2D = emd2d(img)

Contact

Feel free to contact me with any questions, requests or simply to say hi. It's always nice to know that I one's work have eased others and saved someone's time. Contributing to the project is also acceptable.

Contact me either through gmail (laszukdawid @ gmail) or search me through your favourite web search.

Citation

If you found this package useful and would like to cite it in your work please use following structure:

Dawid Laszuk (2017-), Python implementation of Empirical Mode Decomposition algorithm. http://www.laszukdawid.com/codes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

EMD-signal-0.2.7.tar.gz (41.7 kB view details)

Uploaded Source

Built Distribution

EMD_signal-0.2.7-py2.py3-none-any.whl (36.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file EMD-signal-0.2.7.tar.gz.

File metadata

  • Download URL: EMD-signal-0.2.7.tar.gz
  • Upload date:
  • Size: 41.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for EMD-signal-0.2.7.tar.gz
Algorithm Hash digest
SHA256 7e02fb3a1b2b1e5ef91766203688e5f890f9410741296f425dd743ea88123462
MD5 83e67a4ec25c55893d2ca75ba2d47654
BLAKE2b-256 645b1722c387b7e89b2995dff058b5816fcc670858a126ccf739ba21e22971db

See more details on using hashes here.

File details

Details for the file EMD_signal-0.2.7-py2.py3-none-any.whl.

File metadata

  • Download URL: EMD_signal-0.2.7-py2.py3-none-any.whl
  • Upload date:
  • Size: 36.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for EMD_signal-0.2.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0c2e77115fff120c19cd33ef245afde0abd5bf9fd1dca9e42a844b40e678d824
MD5 fd6e66e4ae2273ca6192a2eedf62b364
BLAKE2b-256 86ebb979a2e9f0b6eed816913731defaaaf5e9e26985dce9d33570dc08e94db9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page