Class "StemContainer" for collections of tree and log objects

Share:

Description

This is a virtual class that provides the minimal shared structure for the actual usable subclasses such as “standingTrees” and “downLogs”. In general, the idea for container objects is similar to what is found in some other languages such as C++ or Java. The container object just hold a collection of objects of the appropriate subclass, and has methods that work on this collection as a whole, like plotting the collection. It is a simplified view of traditional container classes in that it does not currently allow for deletion or addition of objects.

Objects from the Class

A virtual Class: No objects may be created from it.

Slots

units:

Object of class "character": The units of measure used, must be either "English" or "metric".

bbox:

Object of class "matrix": The overall bounding box extents for the collection.

stats:

Object of class "data.frame": A summary of simple statistics on the collection; e.g., the mean and variance for volume etc.

description:

Object of class "character": A helpful comment about the collection.

Methods

bbox

signature(obj = "StemContainer"): Calculates the overall bounding box matrix.

perimeter

signature(object = "StemContainer"): Extract the perimeter of the collection corresponding to the bounding box as a "SpatialPolygons" object for possible plotting.

plot

signature(x = "StemContainer", y = "missing"): Plots the collection.

show

signature(object = "StemContainer"): Show component summary for the base slots in the collection.

summary

signature(object = "StemContainer"): Same as show.

Author(s)

Jeffrey H. Gove

References

“The Stem Class” vignette in this package.

See Also

Subclasses: downLogs and standingTrees.

Examples

1
showClass("StemContainer")

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.