The following are the constructor methods for class
“standingTrees
”
in Package sampSurf. Please see “The Stem Class”
vignette for more information and examples on the usage of the 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 “standingTree
”
objects into a list
structure. So if one wishes, one
can simply create one's own list of “standingTree” objects and use
this constructor.
usage...
standingTrees(object, description = '', ... )
object
: A list
as discussed above.
description
: A character description of the
collection.
... : Other arguments to be passed along (not used currently).
signature(object = "data.frame", container = "missing")
This particular method allows one to pass a data frame in the form
generated from sampleTrees
in the object
argument to construct an object of class
“standingTrees
”. Note, however, that the
data frame does not have to be created by sampleTrees
, and it
does not have to contain synthetic/simulated trees. As long as all
of the columns are present that are generated by sampleTrees
it will be used; for example, the data frame can be constructed from
a field sample of trees.
usage...
standingTrees(object, units = 'metric', ... )
object
: A data frame as discussed above.
units
: The units of measurement.
... : Other arguments to be passed along to the
standingTree
constructor—these apply uniformly to all
trees in the collection.
signature(object = "numeric", container = "bufferedTract")
This method will take as its first argument (object
) the number
of trees to be synthetically generated. The centers of the trees at
breast height will all lie within the interior region of the
“bufferedTract
” object passed in the
second (container
) argument.
usage...
standingTrees(object, container, units = 'metric', ... )
object
: A numeric (truncated to integer) object specifying the number
of trees to generate as discussed above.
container
: A “bufferedTract
”
object specifying the internal portion of the tract within
which the tree centers will be generated.
units
: The units of measurement.
... : Other arguments to be passed along to the last constructor described below.
signature(object = "numeric", container = "missing")
This constructor looks like it just generates trees 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...
standingTrees(object, xlim = c(0,100), ylim = c(0,50), units = 'metric', ...)
object
: See explanation in the following constructor
method.
units
: The units of measurement.
xlim
: Limits for the bounding rectangle in
x
.
ylim
: Limits for the bounding rectangle in
y
.
... : Other arguments to be passed along as described in the last constructor method.
signature(object = "numeric", container = "matrix")
Like the previous constructor, the trees 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 trees is generated by a call to
sampleTrees
.
usage...
standingTrees(object, container, units = 'metric', dbhs = c(8, 40), #cm for object construction! topDiams = c(0.4, 0.9), #proportion multiplier heights = c(5,15), solidTypes = c(1,10), species = .StemEnv$species, ...)
object
: A numeric (truncated to integer) object specifying the number
of trees to generate as discussed above.
container
: A matrix
object specifically in the form
of a bbox
, bounding box object (e.g., see the
sp
package). It must be a 2x2
matrix with row names
c("x","y")
and the column names must be
c("min","max")
. The object specifies the internal portion
of the tract within which the log centers will be generated.
units
: The units of measurement.
dbhs
: A length-two vector specifying the
range of breast height diameters from which to
uniformly draw the sample. Note that this range is assumed to be
specified in cm for metric and inches for English units.
topDiams
: A length-two vector specifying the
range of top (at the tip) diameters in the form of a
proportion of the dbh
diameters, from which
to uniformly draw the sample. See also
sampleTrees
.
heights
: A length-two vector specifying the
range of tree heights in feet (English) or meters (metric)
from which to uniformly draw the sample.
solidTypes
: A length-two vector specifying the range in
the tree shape parameter for the default taper
and volume equations; where: 1-2 is a neiloid, 2 is a cone,
and >2 is a paraboloid.
species
: A character vector of possible species from which
to draw the sample uniformly. This can be any legal character
string, and so can include codes, names, Latin names, etc.
... : Other arguments to be passed along to
sampleTrees
. Note specifically that one can control
the random number stream by specifying a seed to be passed to
sampleTrees
with its startSeed
argument. Additionally,
this list can also contain arguments to be ultimately passed on to
the standingTree
constructor to be applied to each
individual tree in the collection. For example, one can specify the
number of segments desired in the taper function (nSegs
) in
this way.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.