API#
This page is the reference for the functions in the EMD package. Further details can be found on the page for each individual function.
Sift Functions#
Primary user-level functions for running the sift.
|
Compute Intrinsic Mode Functions from an input data vector. |
|
Compute Intrinsic Mode Functions with the ensemble EMD. |
|
Compute Intrinsic Mode Functions with complete ensemble EMD. |
|
Compute Intrinsic Mode Functions using a mask sift. |
|
Compute Intrinsic Mode Functions using an iterated mask sift. |
|
Compute second layer intrinsic mode functions. |
|
Compute second layer IMFs using a mask sift. |
Sift Utilities#
Low-level utility functions used by the sift routines.
|
Return a SiftConfig with default options for a specified sift variant. |
|
Compute the next IMF from a data set. |
|
Compute the next IMF from a data set a mask sift. |
|
Interpolate the amplitude envelope of a signal. |
|
Identify and pad the extrema in a signal. |
|
Compute the fixed-iteraiton sift stopping metric. |
|
Compute the sd sift stopping metric. |
|
Compute the Rilling et al 2003 sift stopping metric. |
|
Compute energy change in IMF during a sift. |
Frequency Functions#
Computing frequency transforms from narrow band oscillations (IMFs).
|
Compute instantaneous phase, frequency and amplitude from a set of IMFs. |
|
Compute the instantaneous phase from a complex signal. |
|
Compute the instantaneous frequency from the instantaneous phase. |
|
Compute the instantaneous phase of a signal from its instantaneous frequency. |
Spectrum Functions#
Compute Hilbert-Huang and Holospectra from instantaneous frequency data.
|
Compute a Hilbert-Huang transform (HHT). |
|
Compute a Holospectrum. |
|
Compute a generalised Hilbert marginal spectrum. |
Spectrum Utilities#
Low-level helper functions for spectrum computations.
|
Define the bin edges and centre values for use in a histogram. |
|
Find the bin edges and centre frequencies for use in a histogram. |
IMF-Tools#
Assess and analyse IMFs and their derivatives.
|
Normalise the amplitude envelope of an IMF to be 1. |
|
Wrap a phase time-course. |
Count the number of zero-crossings within a time-course. |
|
|
Determine whether a signal is a 'true IMF'. |
Compute the index of orthogonality from a set of IMFs. |
|
|
Similar to method 1 in http://dx.doi.org/10.11601/ijates.v5i1.139. |
Compute the Pseudo Mode Mixing Index from a set of IMFs. |
|
|
Assess IMFs for potential harmonic relationships. |
|
Assess whether two signals have a well formed joint instantaneous frequency. |
|
Apply a set of epochs to a continuous dataset. |
Define epochs around peaks or troughs within the data. |
Simulate#
Create artificial oscillations.
|
Create a simulated oscillation using an autoregressive filter. |
|
Simulate a non-linear waveform using equation 7 in [R441f6af671e2-1]. |
|
Compute joint instantaneous frequency from a set of oscillations. |
Cycle Analysis#
Identify and analyse single cycles of an oscillation.
|
Find, store and analyse single cycles [R9208c59e353f-1]. |
|
Identify cycles within a instantaneous phase time-course. |
|
Compute the average of a set of observations for each cycle. |
|
Identify sets of control points from identified cycles. |
|
Align a vector of observations to a template phase time-course. |
|
Compute the time-domain waveform of an phase-aligned IF profile. |
|
Compute distribution of x by phase-bins in the Instantaneous Frequency. |
|
Compute the mean vector of a set of values wrapped around the unit circle. |
|
Find unique nearest-neighbours between two n-dimensional feature sets. |
Package Utilities#
Routines related to python, logging and installation.
Get directory path of currently installed & imported emd. |
|
Read version of currently installed & imported emd. |
|
|
Initialise the EMD module logger. |