lerfob.predictor.volume.frenchcommercialvolume2014

Class FrenchCommercialVolume2014Predictor

java.lang.Object

repicea.simulation.SensitivityAnalysisParameter<ModelParameterEstimates>

repicea.simulation.REpiceaPredictor

lerfob.predictor.volume.frenchcommercialvolume2014.FrenchCommercialVolume2014Predictor

All Implemented Interfaces:

java.io.Serializable

public final class FrenchCommercialVolume2014Predictor
extends REpiceaPredictor

The FrenchCommercialVolume2014Predictor class implements a model of volume for individual trees. It predicts the commercial volume from the stump height to a small diameter of 7 cm without eventual branches. It refers to "volume bois fort tige" in French. It is the OVER bark volume.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class repicea.simulation.REpiceaPredictor

REpiceaPredictor.CruiseLine, REpiceaPredictor.ErrorTermGroup, REpiceaPredictor.IntervalNestedInPlotDefinition

Field Summary

Fields inherited from class repicea.simulation.REpiceaPredictor

DefaultZeroIndex, isRandomEffectsVariabilityEnabled, isResidualVariabilityEnabled, listeners, oXVector

Fields inherited from class repicea.simulation.SensitivityAnalysisParameter

isParametersVariabilityEnabled

Constructor Summary

Constructors

Constructor and Description
FrenchCommercialVolume2014Predictor() Default constructor for deterministic mode.
FrenchCommercialVolume2014Predictor(boolean isVariabilityEnabled) General constructor.

Method Summary

Modifier and Type	Method and Description
protected void	init() This method reads all the parameters in .csv files and stores the estimates into members defaultBeta, defaultResidualError, and defaultRandomEffects.
double	predictTreeCommercialOverbarkVolumeDm3(FrenchCommercialVolume2014Tree tree) This method return the over-bark volume estimate for an individual tree.
double	predictTreeCommercialOverbarkVolumeDm3(FrenchCommercialVolume2014TreeImpl tree, int id) This method return the over-bark volume estimate for an individual tree.

Methods inherited from class repicea.simulation.REpiceaPredictor

addModelBasedSimulatorListener, doBlupsExistForThisSubject, doesThisSubjectHaveResidualErrorTerm, doRandomDeviatesExistForThisSubject, fireModelBasedSimulatorEvent, fireRandomEffectDeviateGeneratedEvent, getBlupsForThisSubject, getCruiseLineForThisSubject, getDefaultRandomEffects, getDefaultRandomEffects, getDefaultResidualError, getGaussianErrorTerms, getIntervalNestedInPlotDefinition, getParametersForThisRealization, getRandomEffectsForThisSubject, getResidualError, getResidualErrorForThisSubject, getSubjectPlusMonteCarloSpecificId, getSubjectPlusMonteCarloSpecificId, hasSubjectBeenTestedForBlups, recordSubjectTestedForBlups, removeModelBasedSimulatorListener, setBlupsForThisSubject, setDefaultRandomEffects, setDefaultResidualError, setDeviatesForRandomEffectsOfThisSubject, setParameterEstimates, simulateDeviatesForRandomEffectsOfThisSubject

Methods inherited from class repicea.simulation.SensitivityAnalysisParameter

getParameterEstimates

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FrenchCommercialVolume2014Predictor

public FrenchCommercialVolume2014Predictor(boolean isVariabilityEnabled)

General constructor.

Parameters:

isVariabilityEnabled - a boolean (true: stochastic mode, false: deterministic mode)

FrenchCommercialVolume2014Predictor

public FrenchCommercialVolume2014Predictor()

Default constructor for deterministic mode.

Method Detail

init

protected final void init()

Description copied from class: REpiceaPredictor

This method reads all the parameters in .csv files and stores the estimates into members defaultBeta, defaultResidualError, and defaultRandomEffects.

Specified by:

init in class REpiceaPredictor

predictTreeCommercialOverbarkVolumeDm3

public double predictTreeCommercialOverbarkVolumeDm3(FrenchCommercialVolume2014Tree tree)

This method return the over-bark volume estimate for an individual tree. The stochastic implementation is handled through the general constructor. It is thread safe ONLY if the Monte Carlo Id of trees is not modified. Basically, there should be as many instances of FrenchCommercialVolume2014 as the number of realizations. This is the implementation of the Extended type in the CAPSIS platform. Another implementation is available through the predictTreeCommercialVolumeDm3(tree, id) method. It is specifically designed for FrenchCommercialVolume2014TreeImpl instance and it assumes that the Monte Carlo id of these instances can change. It is thread safe. The method returns 0 if the tree is smaller than 7 cm in dbh. It returns -1 if tree height is not available.

Parameters:

tree - a FrenchCommercialVolume2014Tree object

Returns:

the commercial volume (dm3)

predictTreeCommercialOverbarkVolumeDm3

public double predictTreeCommercialOverbarkVolumeDm3(FrenchCommercialVolume2014TreeImpl tree,
                                                     int id)

This method return the over-bark volume estimate for an individual tree. The stochastic implementation is handled through the general constructor. It is specifically designed for FrenchCommercialVolume2014TreeImpl instance and it assumes that the Monte Carlo id of these instances can change. It is thread safe. The method returns 0 if the tree is smaller than 7 cm in dbh. It returns -1 if tree height is not available.

Parameters:

tree - a FrenchCommercialVolume2014TreeImpl object

id - the Monte Carlo id (the realization id)

Returns:

the commercial volume (dm3)