emd.sift.get_config#

emd.sift.get_config(siftname='sift')[source]#

Return a SiftConfig with default options for a specified sift variant.

Helper function for specifying config objects specifying parameters to be used in a sift. The functions used during the sift areinspected automatically and default values are populated into a nested dictionary which can be modified and used as input to one of the sift functions.

Parameters:

siftnamestr: Name of the sift function to find configuration from

Returns:

SiftConfig: A modified dictionary containing the sift specification

Notes

The sift config acts as a nested dictionary which can be modified to specify parameters for different parts of the sift. This is initialised using this function

>>> config = emd.sift.get_config()

The first level of the dictionary contains three sub-dicts configuring different parts of the algorithm:

>>> config['imf_opts'] # options passed to `get_next_imf`
>>> config['envelope_opts'] # options passed to interp_envelope
>>> config['extrema_opts'] # options passed to get_padded_extrema

Specific values can be modified in the dictionary

>>> config['extrema_opts']['parabolic_extrema'] = True

or using this shorthand

>>> config['imf_opts/env_step_factor'] = 1/3

Finally, the SiftConfig dictionary should be nested before being passed as keyword arguments to a sift function.

>>> imfs = emd.sift.sift(X, **config)