clipStemsToTract-methods: Methods for Generic Function 'clipStemsToTract' in Package...

In sampSurf: Sampling Surface Simulation for Areal Sampling Methods

Description

Please see the generic description clipStemsToTract for the main details. Essentially, using these methods one can check for stems that are wholly or paritally outside the tract, and can clip them to the tract boundary if desired so that only those portions of stems (e.g., logs) within the tract are preserved.

Methods

Only two of the following methods should be called by the user. The others are used to set up the checks and clipping details. The two methods for you to use are noted below, and make it simpler to use this function.

signature(stems = "downLogs", tract = "SpatialPolygons")

Please do not use this method, it is the "guts" that does all of the detailed checking and clipping for “downLogs” collections.

usage...

clipStemsToTract(stems,
                 tract,
                 checkOnly = FALSE,
                 runQuiet = TRUE,
                 showPlot = FALSE,
                 ... )

• stems: A "downLogs" collection object.

• tract: A "Tract" subclass object.

• checkOnly: TRUE: just check the status of logs, don't delete or clip any; FALSE: remove and clip as needed.

• runQuiet: TRUE: No feedback report; FALSE: a short summary report is printed.

• showPlot: TRUE: display a plot showing how the logs were clipped. East-west intersections are in green, N-S in red. It will show (by colors) how logs at corners that intersect more than once get clipped.

• ... : Other arguments, just gobbled for now.

signature(stems = "standingTrees", tract = "SpatialPolygons")

Please do not use this method, it is the "guts" that does all of the detailed checking and removal for “standingTrees” collections.

usage...

clipStemsToTract(stems,
                 tract,
                 checkOnly = FALSE,
                 runQuiet = TRUE,
                 ... )

• stems: A "standingTrees" collection object.

• tract: A "Tract" subclass object.

  All other arguments are as previously defined.

signature(stems = "StemContainer", tract = "bufferedTract")

This is one of the two methods that should be called by the user. A collection of logs or trees can be passed along with a buffered tract object. Please note that the internal buffer rectangle is used to clip against in this case by default, not the external tract boundary.

usage...

clipStemsToTract(stems,
                 tract,
                 checkOnly = FALSE,
                 runQuiet = TRUE,
                 clipToBuffer = TRUE,
                 ... )

• stems: A "downLogs" or "standingTrees" collection object.

• tract: A "bufferedTract" object.

• clipToBuffer: TRUE: Clip stems to the internal buffer (default); FALSE: clip to the tract boundary.

  All other arguments are as previously defined.

signature(stems = "StemContainer", tract = "SpatialPolygons")

This method should not be called by the user. Please use the methods for “Tract” or “bufferedTract” objects. All this does is a general test of whether the bounding box for the collection is within the tract, it is called automatically from the other methods.

usage...

clipStemsToTract(stems,
                 tract,
                 checkOnly = TRUE,
                 runQuiet = TRUE,
                 ... )

All arguments are as previously defined in other methods. Please don't use this!

signature(stems = "StemContainer", tract = "Tract")

This is one of the two methods that should be called by the user. A collection of logs or trees can be passed along with a tract subclass (though there is a special interface for buffered tracts, see above) object.

usage...

clipStemsToTract(stems,
                 tract,
                 checkOnly = FALSE,
                 runQuiet = TRUE,
                 ... )

• stems: A "downLogs" or "standingTrees" collection object.

• tract: A "Tract" object.

  All other arguments are as previously defined.

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