izContainer-class: Class '"izContainer"'

Description Objects from the Class Slots Methods Author(s) See Also Examples

Description

This is a virtual class whose purpose is to define a container class for objects of class "InclusionZone." It provides slots and validity checks that would be common to all subclasses. Please note that this is not a completely functional container class in the traditional sense at present as it does not have replacement, deletion, or addition functions. Please see “The InclusionZone Class” vignette for more information.

Objects from the Class

This is a virtual class, so no objects can be created of this type. However, subclass objects can be created by their constructors (see, e.g., "downLogIZs").

Slots

iZones:

Object of class "list": This slot holds a list of objects that all correspond to the same subclass of the "InclusionZone" class. In other words, each item must have been generated from the same sampling method; i.e., all of class "sausageIZ," for example.

units:

Object of class "character": The same units as the "Stem" class objects in the collection; note that they must all be measured in the same units.

bbox:

Object of class "matrix": The overall bounding box for the collection used in plotting.

description:

Object of class "character": A description of the collection.

Methods

bbox

signature(obj = "izContainer"): Return the minimal bounding box matrix.

hist

signature(x = "izContainer"): Histogram for population of objects.

perimeter

signature(object = "izContainer"): Graphical perimeter corresponding to the mnimal bounding box.

plot

signature(x = "izContainer", y = "missing"): Graphical plot of the collection.

sampSurf

signature(object = "izContainer", tract = "Tract"): Create a sampling surface for the collection on a given "Tract".

show

signature(object = "izContainer"): Print some information about the collection.

summary

signature(object = "izContainer"): A summary of the collection.

Author(s)

Jeffrey H. Gove

See Also

downLogIZs, standingTreeIZs

Examples

1
showClass("izContainer")

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