period: Basic summary of an mimf object
In PierreMasselot/Library--emdr: Tools for EMD-regression

Description Usage Arguments Details Value See Also Examples

period returns the mean period and mean_amplitude returns the mean amplitude of each imf on object. summary wraps them up into a single object.

period(object, tt = attr(object, "tt"))

mean_amplitude(object, tt = attr(object, "tt"))

## S3 method for class 'mimf'
summary(object, ...)

## S3 method for class 'summary.mimf'
print(x, ...)

`object`	A `mimf` object resulting from a call to `memd`.
`tt`	A vector of custom time indices.
`...`	Additional parameters to be passed to the function `format` for the print method.
`x`	An object of class `summary.mimf` resulting from a call to `summary.mimf`.

period computes the mean period of an IMF by counting its number of zero crossing. The period then corresponds to twice the mean time difference between two zero crossings.

mean_amplitude computes the root mean square amplitude of the IMF, i.e. the square root of the sum of its squared values.

summary computes the mean periods, amplitudes and a reconstruction error, i.e. the mean relative difference between the original series and the sum of IMFs. The print method allows pretty printing in the console.

period and mean_amplitude both return a nimfs x nvariables matrix containing the mean period and mean amplitude respectively.

summary return a list containing the mean periods, mean amplitudes, and the relative difference between the original signal and its reconstruction when EEMD is used.

as.mimf to convert an array into a mimf object.

   library(dlnm)
   
   # Decompose both temperature and relative humidity with NA-MEMD
   # Adding two noise variables 
   X <- chicagoNMMAPS[,c("temp", "rhum")]
   set.seed(123)
   mimfs <- memd(X, l = 2) # Takes a couple of minutes
   cmimfs <- combine.mimf(mimfs, list(10:11, 12:13), 
     new.names = c("C10", "C11"))

   summary(cmimfs)