getVHat: Estimator of tree proxy variable

Description Usage Arguments Details Value Note See Also

Description

Recursively computes the estimator of the proxy variable at the tree level, from a terminal segment identified by 'segmentId' in a vector of 'treeSegments' ids

Usage

1
2
3
  getVHat(segmentId, treeSegments, treeParentSegments,
    pathProbabilities, segmentTargetVars, vHat = 0,
    pathProb = 0)

Arguments

segmentId

the segment identification id

treeSegments

a vector of unique segment identification ids

treeParentSegments

a vector of parent identification ids; a tree segment must have a match in treeParentSegment or a NA value if the segment is the butt of the tree (ie its first segment)

pathProbabilities

a vector of segment probabilities

segmentTargetVars

a vector of segment proxy variables (eg volume, biomass, etc.)

vHat

the estimator of the target variable at the tree level (defaults to 0, not to be set by the end-user function call)

pathProb

the cumulative probability of the 'segmentId' (defaults to 0, not to be set by the end-user function call)

Details

The proxy variable may be segment volume, biomass, Carbon content or whatever else

Value

a list of two elements, the estimator of tree proxy variable based on the 'segmentId' segment, and its cumulative probability (the product of all segments individual probabilities down to the butt)

Note

A tree segment must have 1 parent segment. The treeParentSegments vector must hold 1 NA value, corresponding to the first segment

See Also

getSegmentVHat


mbask/RBSperformance documentation built on May 21, 2019, 2:25 p.m.