InclusionZone-class: Class "InclusionZone"

In sampSurf: Sampling Surface Simulation for Areal Sampling Methods

Description

This is a virtual class that defines the root structure for inclusion zones used in areal sampling methods. In general, subclasses will use objects generated from both "ArealSampling" and "Stem" classes to form the functional object. Therefore, the object will be tied to the actual "Stem" object and sampling method in use. Hence, individual “InclusionZone” objects will be made for each stem (i.e., downed log or standing tree) in a collection or population when the final objective is a sampling surface simulation.

Objects from the Class

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

Slots

description:

Object of class "character": Some descriptive text about this class.

units:

Object of class "character": A character string specifying the units of measure. Legal values are “English” and “metric.”

bbox:

Object of class "matrix": The bounding box enclosing the overall object and its inclusion zone.

spUnits:

Object of class "CRS": A valid string of class "CRS" denoting the spatial units coordinate system as in package sp.

puaBlowup:

Object of class "numeric": The per unit area blowup or expansion factor, based on an acre or hectare depending upon the units of measure.

puaEstimates:

Object of class "list": A list of estimates for per unit area quantities associated with the “Stem” component of the object.

userExtra:

Object of class "ANY": This can be anything else the user wants to include with the object. Often it would be in the form of a list object. (This slot may be removed in the future.)

Methods

bbox

signature(obj = "InclusionZone"): Return the bounding box

plot

signature(x = "InclusionZone", y = "missing"): Plot the object

show

signature(object = "InclusionZone"): Show the object

summary

signature(object = "InclusionZone"): Object summary

Author(s)

Jeffrey H. Gove

References

“The InclusionZone Class” vignette.

See Also

For subclasses associated with down logs, see: downLogIZ, standUpIZ, chainSawIZ, sausageIZ, pointRelascopeIZ, perpendicularDistanceIZ, omnibusPDSIZ, distanceLimitedPDSIZ, omnibusDLPDSIZ, distanceLimitedIZ, distanceLimitedMCIZ, and the downLogIZs container class. \

For subclasses associated with standing trees, see: standingTreeIZ, circularPlotIZ, horizontalPointIZ, horizontalLineIZ, and the standingTreeIZs container class.

Examples

showClass("InclusionZone")

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