sampSurf-methods: Methods for "sampSurf" object construction in Package...

Description Methods

Description

The following methods will construct valid objects of class "sampSurf". Please see "The sampSurf Class" vignette for more details and examples.

Methods

signature(object = "izContainer", tract = "Tract")

This constructor will allow the most flexibility. One can create all of the individual objects from generating a population of "Stem" objects up through the corresponding collection of inclusion zones and give the latter, along with the “Tract” object to this constructor to generate the surface.

usage...

sampSurf(object, 
         tract,
         estimate = unlist(c(.StemEnv$puaEstimates, .StemEnv$ppEstimates)),
         description = 'sampling surface object',
         runQuiet = FALSE,
         ... )
  • object: An object of one of the subclasses of "izContainer."

  • tract: An object of class "Tract" or subclass.

  • estimate: A character variable corresponding to the desired estimate attribute; these include 'volume', 'Length' (logs), 'Density', 'surfaceArea', 'coverageArea' (logs), 'basalArea' (trees), 'biomass' and 'carbon'. The sample 'depth' surface is now also available.

  • description: A description of the object as a character string.

  • runQuiet: This routine will print a report of the grid cells as it visits them; set this to TRUE: (default) to see the report; FALSE: to run quietly, which is useful for larger simulations.

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

signature(object = "numeric", tract = "Tract")

This constructor masks much of the job of creating a sampling surface. Just specify the number of stems and a tract for signature arguments along with any options to generate a surface. All arguments except those listed below are as in the above constructor. Note that this constructor eventually calls the first constructor detailed above to generate the sampling surface.

usage...

sampSurf(object, 
         tract,
         iZone, 
         estimate = unlist(.StemEnv$puaEstimates),
         description = 'sampling surface object',
         runQuiet = FALSE,
         ...
        )
  • object: The number of "Stem" subclass objects (i.e., down logs) to generate in the population.

  • iZone: The type of inclusion zone or sampling method/protocol desired. The routine will determine whether to generate logs or trees based on this argument.

  • ... : Other arguments to be passed along to routines that construct the downlog population, the inclusion zones, and eventually the first “sampSurf” constructor given above. For example, one can pass arguments affecting how the sample log population will be drawn as shown in the vignette mentioned above (e.g., logLens=c(4,12)).


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