perimeter-methods: Methods for Function perimeter in Package 'sampSurf'

Description Methods

Description

The methods below will extract the spatial perimeter in the form of a "SpatialPolygons" object, which can then be plotted. In some cases, where the actual perimeter of the object makes sense, this is returned; in others, where it does not, the perimeter of the bounding box is returned.

Methods

In what follows the constructor methods are loosely organized by those applicable to (e.g., sampling methods associated with) (i) down logs, (ii) standing trees, and (iii) other.

Down log constructors...

signature(object = "downLog")

Returns the spatial object associated with the perimeter of the down log.

signature(object = "sausageIZ")

Returns the spatial object associated with the perimeter of the sausage-shaped inclusion zone.

signature(object = "standUpIZ")

Returns the spatial object associated with the perimeter of the circular-shaped inclusion zone.

signature(object = "chainSawIZ")

This will return different inclusion zone objects based on the second argument below...

usage...

perimeter(object, 
           whatSense = c('point', 'plot', 'sausage'),
           ... )
  • object: An object of one of class "chainSawIZ."

  • whatSense: 'point' returns the circular plot center point; 'plot' returns the perimeter of the circular plot; 'sausage' returns the whole-log inclusion zone.

  • ... : Other arguments to be passed along–not used at present.

signature(object = "pointRelascopeIZ")

Returns the spatial object associated with the perimeter of the dual circle-shaped inclusion zone.

signature(object = "perpendicularDistanceIZ")

Returns the spatial object associated with the perimeter of the inclusion zone—works on all subclasses; i.e., "omnibusPDSIZ", "distanceLimitedPDSIZ", "omnibusDLPDSIZ", and "hybridDLPDSIZ".

signature(object = "distanceLimitedIZ")

Returns the spatial object associated with the perimeter of the inclusion zone. This alsow works for objects of class "distanceLimitedMCIZ".

Standing tree constructors...

signature(object = "standingTree")

Returns the spatial object associated with the perimeter of the standing tree.

signature(object = "circularPlotIZ")

Returns the spatial object associated with the perimeter of the inclusion zone for objects of class "circularPlotIZ". It also will return the perimeter of any object that is a subclass; e.g., "horizontalPointIZ", "criticalHeightIZ", "importanceCHSIZ", "antitheticICHSIZ", "pairedAICHSIZ", "horizontalPointCMCIZ", "horizontalPointISIZ", and "horizontalPointCVIZ".

signature(object = "horizontalLineIZ")

Returns the spatial object associated with the perimeter of the inclusion zone for objects of class "horizontalLineIZ".

Other constructors...

signature(object = "StemContainer")

Returns the spatial object associated with the bounding box for the collection of “downLog” or “standingTree” objects within the appropriate “downLogs” or “standingTrees” container objects, respectively.

signature(object = "circularPlot")

Returns the spatial object associated with the perimeter of the circular plot.

signature(object = "izContainer")

Returns the spatial object associated with the bounding box for the collection of “izContainer” subclass objects.

signature(object = "Tract")

Returns the spatial object associated with the perimeter of the “Tract”.

signature(object = "sampSurf")

Returns the spatial object associated with the perimeter of the tract slot in the object.


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