ssCovMODWT-class: Class '"ssCovMODWT"'

In ssWavelets: Wavelet Functionality for Package 'sampSurf'

Description

This class encompasses the essentials of two ssMODWT classes that share the same decomposition attributes as found in the levels slot. The two surfaces produce a set of covariances that are also contained in the object.

The “ssMODWT” objects used to create the class must be from the same underlying tract and population of trees or logs in the sense of a sampSurf simulation. The difference in the two lies in applying different sampling methods or, say, plot sizes for circular plot sampling as an example. The wavelet covariance decomposition is then based on the two wavelet decompositions of the “sampSurf” objects.

Examples and information concerning this class are found in the package vignette in the references below. This vignette should be consulted for more details on creating and using objects from this class.

Objects from the Class

Objects are created using the the constructor method ssCovMODWT.

Slots

Two “ssMODWT” objects are used to construct this object. They are variously referred to as the primary or first object, which appears in the “default” fields corresponding to those in “ssMODWT” below, and the second(ary) object. However, the primary often appears with an appended ‘a’ in the code to distinguish it from the second object, which always appears with an appended ‘b’ as seen below. I have tried to use [a,b] to distinguish the objects in the code and have stayed away from using [x,y] so as not confuse the latter's use in referring to the dimensions of the images; the exception being in covMODWT and some of the text in the vignette.

ss.b:

Object of class "sampSurf": The second sampling surface.

ss.modwt.b:

Object of class "list": The raw wavelet coefficient results from running a 2-D MODWT wavelet transformation using modwt.2d in package waveslim on the ss.b surface.

ss.mra.b:

Object of class "list": The results of applying a 2-D multi-resolution analysis (MRA) to the ss.modwt.b decomposition.

covStats:

Object of class "list": A succinct summary of the overall covariances and correlations. These are used when showing or performing a summary on the object.

ss.modwt:

Object of class "list": See “ssMODWT”; this is for the first surface in the ss slot.

vars.modwt:

Object of class "list": The covariance results. This is a rather long list containing marginal summary, total, and image covariances. Details are provided in the vignette. Please note that this slot does not contain variances as in “ssMODWT”, though the two have the same structure.

ss.mra:

Object of class "list": See “ssMODWT”; this is for the primary object..

levels:

Object of class "list": See “ssMODWT”. The information here should match exactly as checked in the constructor for both decomposition objects and is thus the shared result.

description:

Object of class "character": See “ssWavelet”.

wfName:

Object of class "character": See “ssWavelet”.

ss:

Object of class "sampSurf": See “ssWavelet”.

Extends

Class "ssMODWT", directly.
Class "ssWavelet", by class "ssMODWT", distance 2.

Methods

No methods defined with class "ssCovMODWT" in the signature. However the ‘summary’ method is available as a subclass of “ssMODWT”.

Author(s)

Jeffrey H. Gove

See Also

“ssWavelet”, “ssMODWT”, and package references: ssWavelets and sampSurf

Examples

showClass("ssCovMODWT")

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