taperInterpolate-methods: Methods for Function 'taperInterpolate' in Package 'sampSurf'

In sampSurf: Sampling Surface Simulation for Areal Sampling Methods

Description

There are three methods for the taperInterpolate generic function keyed off the one object signature. Each of them share the same argument list, but with one argument having slightly different meanings between the methods. The method associated with list objects should not be used unless you know what you are doing. Please use the wrappers in the other two methods below, which set the correct list structure up, and call the list version to do all the calculations.

Methods

signature(object = "downLog")

usage...

taperInterpolate(object,
                 whichSense = c('diameter', 'length'),
                 pts = NULL,
                 ...) 

• object: An object of class “downLog”.

• whichSense: Either "diameter" to interpolate diameters, or "length" to interpolate lengths.

• pts: If whichSense = "diameter" then this is a vector of lengths at which to interpolate the diameters. Alternatively, if whichSense = "length" then this is a vector of diameters at which to interpolate the lengths.

signature(object = "list")

Please do not use this method, use the other two which call it correctly...

usage...

taperInterpolate(object,
                 whichSense = c('diameter', 'length', 'height'),
                 pts = NULL,
                 ...) 

• object: An object of class “list”.

• whichSense: Either “diameter” to interpolate diameters, “length” to interpolate lengths for “downLog” objects, or “height” to interpolate heights for “standingTree” objects.

• pts: If whichSense = "diameter" then this is a vector of lengths/heights at which to interpolate the diameters. Alternatively, if whichSense = "length" (or "height") then this is a vector of diameters at which to interpolate the lengths/heights.

signature(object = "standingTree")

usage...

taperInterpolate(object,
                 whichSense = c('diameter', 'height'),
                 pts = NULL,
                 ...) 

• object: An object of class “standingTree”.

• whichSense: Either "diameter" to interpolate diameters, or "height" to interpolate heights.

• pts: If whichSense = "diameter" then this is a vector of heights at which to interpolate the diameters. Alternatively, if whichSense = "height" then this is a vector of diameters at which to interpolate the heights.

sampSurf documentation built on March 5, 2021, 5:06 p.m.