Skip to main content

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

Project description

codecov DocStatus Codacy Badge DOI Conda

PyEMD

Links

Introduction

Python implementation of the Empirical Mode Decomposition (EMD). The package contains multiple EMD variations and intends to deliver more in time.

Recent changes

  • [2025-11 v1.9] Migrate to uv and nox for builds and tests
  • [2025-11 v1.8] Performance boost of 18% to the core EMD

EMD variations

  • Ensemble EMD (EEMD),
  • "Complete Ensemble EMD" (CEEMDAN)
  • different settings and configurations of vanilla EMD.
  • Image decomposition (EMD2D & BEMD) (experimental, no support)
  • Just-in-time compiled EMD (JitEMD)

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

Available splines

  • Natural cubic (default)
  • Pointwise cubic
  • Hermite cubic
  • Akima
  • PChip
  • Linear

Available stopping criteria

  • Cauchy convergence (default)
  • Fixed number of iterations
  • Number of consecutive proto-imfs

Extrema detection

  • Discrete extrema (default)
  • Parabolic interpolation

Installation

Note: Downloadable package is called emd-signal.

PyPi (recommended)

The quickest way to install package is through pip.

pip install EMD-signal

or with uv you can do

uv add emd-signal
#or
# uv pip install EMD-signal

In this way you install the latest stable release of PyEMD hosted on PyPi.

Conda

PyEMD (as emd-signal) is available for Conda via conda-forge channel

conda install -c conda-forge emd-signal

Source: https://anaconda.org/conda-forge/emd-signal

From source

In case, if you only want to use EMD and its variations, the best way to install PyEMD is through pip. However, if you want the latest version of PyEMD, anyhow you might want to download the code and build package yourself. The source is publicaly available and hosted on GitHub. To download the code you can either go to the source code page and click Code -> Download ZIP, or use git command line

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

Installing package from source is done using command line:

python3 -m pip install .

after entering the PyEM directory created by git.

A quicker way to install PyEMD from source is done using pip and git in the same command:

python3 -m pip install git+https://github.com/laszukdawid/PyEMD.git

Note, however, that this will install it in your current environment. If you are working on many projects, or sharing reources with others, we suggest using virtual environments. If you want to make your installation editable use the -e flag for pip

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.

Windows: Please don't skip the if __name__ == "__main__" section.

from PyEMD import EEMD
import numpy as np

if __name__ == "__main__":
    s = np.random.random(100)
    eemd = EEMD()
    eIMFs = eemd(s)

CEEMDAN

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

Windows: Please don't skip the if __name__ == "__main__" section.

from PyEMD import CEEMDAN
import numpy as np

if __name__ == "__main__":
    s = np.random.random(100)
    ceemdan = CEEMDAN()
    cIMFs = ceemdan(s)

Visualisation

The package contains 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()

Experimental

JitEMD

Just-in-time (JIT) compiled EMD is a version of EMD which exceed on very large signals or reusing the same instance multiple times. It's strongly sugested to be used in Jupyter notebooks when experimenting by modifyig input rather than the method itself.

The problem with JIT is that the compilation happens on the first execution and it can be quite costly. With small signals, or performing decomposition just once, the extra time for compilation will be significantly larger than the decomposition, making it less performant.

Please see documentation for more information or examples for how to use the code. This is experimental as it's value is still questionable, and the author (me) isn't proficient in JIT optimization so mistakes could've been made.

Any feedback is welcomed. Happy to improve if there's intrest. Please open tickets with questions and suggestions.

To enable JIT in your PyEMD, please install with jit option, i.e.

pip install EMD-signal[jit]

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.EMD2d 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)

F.A.Q

Why is EEMD/CEEMDAN so slow?

Unfortunately, that's their nature. They execute EMD multiple times every time with slightly modified version. Added noise can cause a creation of many extrema which will decrease performance of the natural cubic spline. For some tweaks on how to deal with that please see Speedup tricks in the documentation.

Contact

Feel free to contact me with any questions, requests or simply to say hi. It's always nice to know that I've helped someone or made their work easier. Contributing to the project is also acceptable and warmly welcomed.

Citation

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

@misc{pyemd,
  author = {Laszuk, Dawid},
  title = {Python implementation of Empirical Mode Decomposition algorithm},
  year = {2017},
  publisher = {GitHub},
  journal = {GitHub Repository},
  howpublished = {\url{https://github.com/laszukdawid/PyEMD}},
  doi = {10.5281/zenodo.5459184}
}

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-1.9.0.tar.gz (74.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

emd_signal-1.9.0-py3-none-any.whl (76.8 kB view details)

Uploaded Python 3

File details

Details for the file emd_signal-1.9.0.tar.gz.

File metadata

  • Download URL: emd_signal-1.9.0.tar.gz
  • Upload date:
  • Size: 74.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for emd_signal-1.9.0.tar.gz
Algorithm Hash digest
SHA256 b9fbca0a7059f0453f362fa926a4780bdfcece4f3411ab1fcb9dd257d60a3379
MD5 81e7110733c9cba3a2b772c2d56e5840
BLAKE2b-256 2783ed9119942a293ec92d0f2d9621f75a62433cd29b3dc5bc9dd21b7c6c5101

See more details on using hashes here.

File details

Details for the file emd_signal-1.9.0-py3-none-any.whl.

File metadata

  • Download URL: emd_signal-1.9.0-py3-none-any.whl
  • Upload date:
  • Size: 76.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for emd_signal-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1f2f0007711634420153670fab34f0c057fba0b63ad9ba81dacbcf559b3f9fd4
MD5 6ca35b91ca3a81ce117530caabe37bf2
BLAKE2b-256 5223fabd3687a2443802d7cd7f86ba0cdfde26b8553e4a2d6bc72466fcd21899

See more details on using hashes here.

Supported by

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