listCellStem {ssExtra}R Documentation

Enumerate Cell Numbers Within Inclusion Zones

Description

Perhaps a somewhat poor choice of name for this routine, it finds the cell numbers that are within each stem's inclusion zone, and vice versa (not within the actual stem!).

Usage

listCellStem(ss, ...)

Arguments

ss

An object of class "sampSurf".

...

Gobbled presently.

Details

This routine forms the “guts” of the "ssCellStemList" class constructor. For every inclusion zone, it determines which cell numbers fall within the zone (cellsInStems). Conversely, it will find what would be the ‘inverse’ of this as the stem numbers whose inclusion zones overlap each cell in the tract (stemsInCells). This routine is essential for determining the tree-based quantities like individual tree VBARs that occur on a given sample point (grid cell). This allows us to aggregate tree-wise totals, &c., on a point-wise basis.

This may be run “stand-alone”, but it is probably better to call it as part of building an object of class "ssCellStemList". In this way, any helper functions, &c., that are developed for that class in the future would be available for used on the results. In addition, that class contains more slots that may be helpful.

Value

A list with...

cellsInStems

A list by tree IDs (see getID for information on stem IDs) of the grid cell numbers within each tree's inclusion zone.

stemsInCells

A list of all of the grid cell numbers with elements the IDs for the stems whose inclusion zones overlap the individual cells. Note that background cells are excluded since the list is constructed from cellsInStems.

Author(s)

Jeffrey H. Gove

See Also

"ssCellStemList", "ssBigBAF"

Examples

#
# if nhAll310.bb is an "ssBigBAF" object, then...
#
## Not run: 
#the following is for the big BAF surfaces...
csl.bb = listCellStem(nhAll310.bb@ss.bb.vol)
#and for the count surfaces...
csl.ct = listCellStem(nhAll310.bb@ss.ct.ba)

## End(Not run) 

[Package ssExtra version 0.1-2 Index]