lerfob.predictor.hdrelationships.frenchgeneralhdrelationship2018

Class FrenchHDRelationship2018Predictor

java.lang.Object

repicea.simulation.SensitivityAnalysisParameter<ModelParameterEstimates>

repicea.simulation.REpiceaPredictor

lerfob.predictor.hdrelationships.frenchgeneralhdrelationship2018.FrenchHDRelationship2018Predictor

All Implemented Interfaces:

java.io.Serializable, FertilityClassEmulator, HeightPredictor<FrenchHDRelationship2018Plot,FrenchHDRelationship2018Tree>

public final class FrenchHDRelationship2018Predictor
extends REpiceaPredictor
implements FertilityClassEmulator, HeightPredictor<FrenchHDRelationship2018Plot,FrenchHDRelationship2018Tree>

This class implements the general height-diameter relationships for the French National Forest Inventory. The 2018 version has been updated with climate variables. More specifically, the mean temperature and mean precipitation of the growth season are now explanatory variables for most species.

See Also:

Fortin, M., R. Van Couwenberghe, V. Perez and C. Piedallu. 2019. Evidence of climate effects on the height-diameter relationships of tree species. Annals of Forest Science 76: 1. , Serialized Form

Nested Class Summary

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

REpiceaPredictor.CruiseLine, REpiceaPredictor.ErrorTermGroup, REpiceaPredictor.IntervalNestedInPlotDefinition

Nested classes/interfaces inherited from interface lerfob.predictor.FertilityClassEmulator

FertilityClassEmulator.FertilityClass

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
FrenchHDRelationship2018Predictor() Default constructor with all sources of uncertainty disabled.
FrenchHDRelationship2018Predictor(boolean isVariabilityEnabled) General constructor for all combinations of uncertainty sources.

Method Summary

Modifier and Type	Method and Description
void	addModelBasedSimulatorListener(REpiceaPredictorListener listener) This method adds the listener instance to the list of listeners.
void	emulateFertilityClass(FertilityClassEmulator.FertilityClass fertilityClass) This method allows to tweak the plot random effect in order to reproduce a sort of site index.
protected Estimate<? extends StandardGaussianDistribution>	getBlups(FrenchHDRelationship2018Plot stand, FrenchHDRelationship2018Tree tree) For testing purpose only
protected void	init() This method reads all the parameters in .csv files and stores the estimates into members defaultBeta, defaultResidualError, and defaultRandomEffects.
double	predictHeightM(FrenchHDRelationship2018Plot stand, FrenchHDRelationship2018Tree tree) Predicts the height for individual trees and also implements the Monte Carlo simulation automatically.
void	removeModelBasedSimulatorListener(REpiceaPredictorListener listener) This method removes the listener instance from the list of listeners.
void	setClimateChangeGenerator(REpiceaClimateChangeGenerator<? extends GeographicalCoordinatesProvider> generator) Sets a climate change generator that will impact the internal climate generator for the HD relationship.

Methods inherited from class repicea.simulation.REpiceaPredictor

doBlupsExistForThisSubject, doesThisSubjectHaveResidualErrorTerm, doRandomDeviatesExistForThisSubject, fireModelBasedSimulatorEvent, fireRandomEffectDeviateGeneratedEvent, getBlupsForThisSubject, getCruiseLineForThisSubject, getDefaultRandomEffects, getDefaultRandomEffects, getDefaultResidualError, getGaussianErrorTerms, getIntervalNestedInPlotDefinition, getParametersForThisRealization, getRandomEffectsForThisSubject, getResidualError, getResidualErrorForThisSubject, getSubjectPlusMonteCarloSpecificId, getSubjectPlusMonteCarloSpecificId, hasSubjectBeenTestedForBlups, recordSubjectTestedForBlups, 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

FrenchHDRelationship2018Predictor

public FrenchHDRelationship2018Predictor(boolean isVariabilityEnabled)

General constructor for all combinations of uncertainty sources.

Parameters:

isVariabilityEnabled - a boolean that enables the variability at the parameter level

FrenchHDRelationship2018Predictor

public FrenchHDRelationship2018Predictor()

Default constructor with all sources of uncertainty disabled.

Method Detail

emulateFertilityClass

public void emulateFertilityClass(FertilityClassEmulator.FertilityClass fertilityClass)

Description copied from interface: FertilityClassEmulator

This method allows to tweak the plot random effect in order to reproduce a sort of site index.

Specified by:

emulateFertilityClass in interface FertilityClassEmulator

Parameters:

fertilityClass - a FertilityClass enum

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

predictHeightM

public double predictHeightM(FrenchHDRelationship2018Plot stand,
                             FrenchHDRelationship2018Tree tree)

Description copied from interface: HeightPredictor

Predicts the height for individual trees and also implements the Monte Carlo simulation automatically. In case of exception, it also returns -1. If the predicted height is lower than 1.3, this method returns 1.3.

Specified by:

predictHeightM in interface HeightPredictor<FrenchHDRelationship2018Plot,FrenchHDRelationship2018Tree>

Parameters:

stand - a HDRelationshipStand-derived instance

tree - a HDRelationshipTree-derived instance

Returns:

tree height (m)

getBlups

protected Estimate<? extends StandardGaussianDistribution> getBlups(FrenchHDRelationship2018Plot stand,
                                                                    FrenchHDRelationship2018Tree tree)

For testing purpose only

Parameters:

stand -

addModelBasedSimulatorListener

public void addModelBasedSimulatorListener(REpiceaPredictorListener listener)

Description copied from class: REpiceaPredictor

This method adds the listener instance to the list of listeners.

Overrides:

addModelBasedSimulatorListener in class REpiceaPredictor

Parameters:

listener - a ModelBasedSimulatorListener listener

removeModelBasedSimulatorListener

public void removeModelBasedSimulatorListener(REpiceaPredictorListener listener)

Description copied from class: REpiceaPredictor

This method removes the listener instance from the list of listeners.

Overrides:

removeModelBasedSimulatorListener in class REpiceaPredictor

Parameters:

listener - a ModelBasedSimulatorListener listener

setClimateChangeGenerator

public void setClimateChangeGenerator(REpiceaClimateChangeGenerator<? extends GeographicalCoordinatesProvider> generator)

Sets a climate change generator that will impact the internal climate generator for the HD relationship.

Parameters:

generator - a REpiceaClimateChangeGenerator instance