downLogs-methods {sampSurf}R Documentation

Methods for "downLogs" Object Construction

Description

The following are the constructor methods for class “downLogs” in Package sampSurf. Please see “The Stem Class” vignette for more information and examples on the usage of the methods.

Methods

signature(object = "list", container = "missing")

Ultimately, all of the constructors end up calling this one to generate the object after they have done what they were meant to, and then converted all of the “downLog” objects into a list structure. So if one wishes, one can simply create one's own list of “downLog” objects and use this constructor.

usage...

downLogs(object,
         description = '',
         ... )
signature(object = "data.frame", container = "missing")

This particular method allows one to pass a data frame in the form generated from sampleLogs in object argument to construct an object of class “downLogs”. Note, however, that the data frame does not have to be created by sampleLogs, and it does not have to contain synthetic/simulated logs. As long as all of the columns are present that are generated by sampleLogs it will be used; for example, the data frame can be constructed from a field sample of logs.

usage...

downLogs(object, units = 'metric', ... )
signature(object = "numeric", container = "bufferedTract")

This method will take as its first argument (object) the number of logs to be synthetically generated. The centers of the logs will all lie within the interior region of the “bufferedTract” object passed in the second (container) argument.

usage...

downLogs(object, container, units = 'metric', ... )
signature(object = "numeric", container = "missing")

This constructor looks like it just generates logs randomly. But in reality, note the arguments below. It takes limits of a rectangular region as an alternative to specifying a bounding box matrix or a “bufferedTract” object as in two of the other constructors. Essentially, these limits get converted to a matrix bounding box and the appropriate constructor is used (see below).

usage...

downLogs(object,
         xlim = c(0,100), 
         ylim = c(0,50),
         units = 'metric',
         ...)
signature(object = "numeric", container = "matrix")

Like the previous constructor, the logs will be generated so that their centers lie within a rectangular area specified by the matrix object in the second argument. Note that ultimately, the synthetic population of logs is generated by a call to sampleLogs.

usage...

downLogs(object,
         container,
         units = 'metric',
         buttDiams = c(8, 40), 
         topDiams = c(0, 0.9), 
         logLens = c(1,10),
         logAngles = c(0, 2*pi),
         solidTypes = c(1,10),
         species = .StemEnv$species,
         ... )

[Package sampSurf version 0.7-5 Index]