covMODWT: Function to Calculate (Co-) Variances for MODWT...
In ssWavelets: Wavelet Functionality for Package 'sampSurf'

Description Usage Arguments Details Value Note Author(s) See Also

This routine calculates various variances for objects of class “ssMODWT”, or covariances for objects of class “ssCovMODWT”. It is rather complex, so please see the Details section and the vignette referenced below for more information. Please also see the caveat in Details concerning the general use of this function.

1	covMODWT(ss.modwt.x, ss.modwt.y, ...)

`ss.modwt.x`	An list object as returned from `waveslim::modwt.2d`.
`ss.modwt.y`	A second list object from `waveslim::modwt.2d` for covariance calculations. If variance calculations are desired, then leave this argument out as the routine tests for this argument as `missing` and makes a second copy of it from the first argument for variance calculation.
`...`	Gobbled.

This routine acts much like the stats::cov routine in the sense that if the second argument, ss.modwt.y is missing, then it calculates the variance instead of the covariance. The return list object from this routine is quite long and complicated and is explained in adequate detail in the vignette.

Please note that this routine is an integral part of the constructor methods for both “ssMODWT” and “ssCovMODWT” objects, where the results are automatically incorporated into the correct slot in these objects. Because of this, there is very little need to call this routine on your own, in fact, it is discouraged.

This is a very succinct summary, please see the vignette and/or code for details. A list with components...

`isCovariance:`	`TRUE`: covariances; `FALSE`: variances
`summary:`	a list of marginal total (co-) variances (vectors)
`total:`	a list of surface decomposition total (co-) variances (scalars) as well as the smooth (surface) mean
`image:`	a list of matrix/image (co-) variances

Again, there should be little need to use this outside of the constructor functions. If one is extending the classes in this package and requires the calculation of (co-) variances, then please see the extant constructors for detailed examples. For this reason, no examples are presented below.

Jeffrey H. Gove

“ssMODWT”, “ssCovMODWT”.

ssWavelets documentation built on May 2, 2019, 5:54 p.m.