importanceSampling-methods {sampSurf}R Documentation

Methods for importanceSampling object construction in Package sampSurf

Description

The methods described below for the construction of objects of class "importanceSampling" fall into two categories as follows...

1. The object passed is a "Stem" subclass object: importance sampling is applied to the individual stem.

2. The object passed is a collection ("StemContainer") of "Stem" subclass objects: importance sampling is applied to each stem in the collection based on the other arguments passed.

In adition, there is a separate method for the case when object is of class "list". This is the base constructor that really performs all of the importance sampling code on the individual stems. The other methods are simply wrappers that call this method. The list constructor is detailed below for completeness; however, please do not use it, pass one of the other types of objects instead to use one of the other methods, this will ensure proper results inasmuch as is possible.

Methods

Each of the methods has either the same argument list, or a subset of arguments that correspond to the list signature method. Refer to that method for any arguments that have a universal interpretation over all methods.

signature(object = "downLog")

usage...

importanceSampling(object,
                   segBnds = c(low = 0,  up = object@logLen),
                   n.s = 1,
                   startSeed = NA,
                   u.s = NA,
                   proxy = 'gvProxy',
                   alphaLevel = 0.05,
                   description = 'Importance Sampling',
                   ... )
signature(object = "downLogs")

usage...

importanceSampling(object,
                   segBnds = NULL,
                   n.s = 1,
                   startSeed = NA,
                   u.s = NA,
                   proxy = 'gvProxy',
                   alphaLevel = 0.05,
                   description = 'Importance Sampling',
                   ... )
signature(object = "list")

Please do not use this method directly, use one of the others documented here that will ultimately call this method.

usage...

importanceSampling(object,
                   segBnds = c(low = 0, up = object$height),
                   n.s = 1,
                   startSeed = NA,
                   u.s = NA,
                   proxy = 'gvProxy',
                   alphaLevel = 0.05,
                   controlVariate = FALSE,
                   description = 'Monte Carlo Sampling',
                   ... )
signature(object = "standingTree")

usage...

importanceSampling(object,
                   segBnds = c(low = 0,  up = object@height),
                   n.s = 1,
                   startSeed = NA,
                   u.s = NA,
                   proxy = 'gvProxy',
                   alphaLevel = 0.05,
                   description = 'Importance Sampling',
                   ... )
signature(object = "standingTrees")

usage...

importanceSampling(object,
                   segBnds = NULL,
                   n.s = 1,
                   startSeed = NA,
                   u.s = NA,
                   proxy = 'gvProxy',
                   alphaLevel = 0.05,
                   description = 'Importance Sampling',
                   ... )

[Package sampSurf version 0.7-4 Index]