downLogs-class: Class "downLogs"

In sampSurf: Sampling Surface Simulation for Areal Sampling Methods

Description

The “downLogs” class is a simplified container class that can hold multiple objects of class “downLog”. Its specific purpose is to hold a population of down logs that are either generated synthetically as part of a simulation, or a collection from field measurements. The constructor of the same name has several different forms corresponding to possible argument signatures.

Objects from the Class

Objects can be created by calls of the form new("downLogs", ...); however, as in the other classes within this package, constructors have been written to simplify the process. The downLogs constructor should therefore be used in preference to new.

Slots

Please see the virtual base class, “StemContainer”, for additional slots definitions.

logs:

Object of class "list": This holds the collection of “downLog” objects.

Please note that at the present time this class only partially meets the requirements of a true “container class” in object oriented programming. This is because it does not as yet have methods for object deletion, editing, or addition to the list of down logs. Because the statistics and bounding box are tied to the collection, a caution is in order regarding changing in any way the objects within your R code. The best way to handle this is to simply extract the list from the object, do whatever editing has to be done to it, then use the constructor below to make a new object. Then everything will be correctly represented within the object.

Extends

Class "StemContainer", directly.

Methods

hist

signature(x = "downLogs"): Displays a histogram of different variables in the collection.

plot

signature(x = "downLogs", y = "missing"): Plot the collection.

summary

signature(object = "downLogs"): Same as show currently.

Author(s)

Jeffrey H. Gove

See Also

sampleLogs, "downLog", "Stem", "StemContainer"

Examples

showClass("downLogs")
buff = matrix(c(0,100,0,100), nrow=2, byrow=TRUE,
              dimnames=list(c('x','y'),c('min','max')))
sl = sampleLogs(10, buttDiam = c(10,25), sampleRect = buff)
dls = downLogs(sl)
summary(dls)

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