emd.imftools.assess_joint_if#

emd.imftools.assess_joint_if(imf, freq_transform_args=None, return_mode='full')[source]#

Assess whether two signals have a well formed joint instantaneous frequency.

Parameters
imfndarray

Array of intrinsic mode functions.

freq_transform_args{None, dict}

Optional dictionary of keyword arguments to be passed to emd.spectra.frequency_transform

return_mode{‘binary’, ‘full’}

Whether to return the full joint instantaneous frequency or a binarised vector indicating samples that have positive joint instantaneous frequency.

Returns
joint_ifndarray

Array of joint instantaneous frequency values or binary values indicating whether the joint instantaneous frequency was less than zero.

References

1

Fabus, M. S., Woolrich, M. W., Warnaby, C. W., & Quinn, A. J. (2021). Understanding Harmonic Structures Through Instantaneous Frequency. Cold Spring Harbor Laboratory. https://doi.org/10.1101/2021.12.21.473676