lerfob.predictor.thinners.frenchnfithinner2018

Class FrenchNFIThinnerPredictor

java.lang.Object

repicea.simulation.SensitivityAnalysisParameter<ModelParameterEstimates>

repicea.simulation.REpiceaPredictor

repicea.simulation.REpiceaBinaryEventPredictor<FrenchNFIThinnerPlot,java.lang.Object>

lerfob.predictor.thinners.frenchnfithinner2018.FrenchNFIThinnerPredictor

All Implemented Interfaces:

java.io.Serializable

public class FrenchNFIThinnerPredictor
extends REpiceaBinaryEventPredictor<FrenchNFIThinnerPlot,java.lang.Object>

This thinner is based on the NFI data for the remeasurement campaigns that took place from 2010 to 2016. Plots measured 5 years earlier were revisited to record the occurrence of harvesting.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FrenchNFIThinnerPredictor.FrenchNFIThinnerSpecies

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

REpiceaPredictor.CruiseLine, REpiceaPredictor.ErrorTermGroup, REpiceaPredictor.IntervalNestedInPlotDefinition

Field Summary

Fields

Modifier and Type	Field and Description
protected lerfob.predictor.thinners.frenchnfithinner2018.FrenchNFIThinnerStandingPriceProvider	priceProvider

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
FrenchNFIThinnerPredictor(boolean isPredictionVariabilityEnabled, boolean isPriceVariabilityEnabled) Constructor.

Method Summary

Modifier and Type	Method and Description
protected static FrenchNFIThinnerPredictor.FrenchNFIThinnerSpecies	getFrenchNFIThinnerSpeciesFromThisString(java.lang.String speciesName) This method returns a FrenchNFIThinnerSpecies instance that matches the species name.
double[]	getStandingPrices(FrenchNFIThinnerPredictor.FrenchNFIThinnerSpecies targetSpecies, int year0, int year1, int monteCarloRealizationId) This method makes it possible to retrieve the prices for a given period and a given target species.
protected void	init() This method reads all the parameters in .csv files and stores the estimates into members defaultBeta, defaultResidualError, and defaultRandomEffects.
double	predictEventProbability(FrenchNFIThinnerPlot plot, java.lang.Object tree, java.lang.Object... parms) This method returns the probability of harvest occurrence at the plot level.
void	resetModifiers()
void	setBasicTrendModifier(FrenchNFIThinnerPredictor.FrenchNFIThinnerSpecies species, int fromYear, int toYear, double relativeChange) This method makes it possible to induce price changes over time for a particular species.
void	setBasicTrendModifier(int fromYear, int toYear, double relativeChange) This method makes it possible to induce price changes over time for all species.
void	setMultiplierModifier(FrenchNFIThinnerPredictor.FrenchNFIThinnerSpecies species, int fromYear, int toYear, double relativeChange) This method makes it possible to induce a proportional price changes for a given period and a give species.
void	setMultiplierModifier(int fromYear, int toYear, double relativeChange) This method makes it possible to induce a proportional price changes for a given period for all species.

Methods inherited from class repicea.simulation.REpiceaBinaryEventPredictor

findFirstParameterOfThisClass, predictEvent

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

Field Detail

priceProvider

protected final lerfob.predictor.thinners.frenchnfithinner2018.FrenchNFIThinnerStandingPriceProvider priceProvider

Constructor Detail

FrenchNFIThinnerPredictor

public FrenchNFIThinnerPredictor(boolean isPredictionVariabilityEnabled,
                                 boolean isPriceVariabilityEnabled)

Constructor.

Parameters:

isPredictionVariabilityEnabled - true to enable the classic stochastic mode

isPriceVariabilityEnabled - true to enable the stochasticity of the prices

Method Detail

init

protected 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

predictEventProbability

public double predictEventProbability(FrenchNFIThinnerPlot plot,
                                      java.lang.Object tree,
                                      java.lang.Object... parms)

This method returns the probability of harvest occurrence at the plot level.

Specified by:

predictEventProbability in class REpiceaBinaryEventPredictor<FrenchNFIThinnerPlot,java.lang.Object>

Parameters:

plot - a FrenchNFIThinnerPlot instance

tree - USELESS can be set to NULL

parms - should contain two integers being the initial and the final dates. Note that the price of the initial year does not contribute to the probability of harvesting. For example, if one provides 2012 and 2017 as initial and final dates, then the prices of 2013, 2014, 2015, 2016 and 2017 will contribute to the probability of harvesting.

Returns:

the event probability

getStandingPrices

public double[] getStandingPrices(FrenchNFIThinnerPredictor.FrenchNFIThinnerSpecies targetSpecies,
                                  int year0,
                                  int year1,
                                  int monteCarloRealizationId)

This method makes it possible to retrieve the prices for a given period and a given target species.

Parameters:

targetSpecies - a FrenchNFIThinnerSpecies enum

year0 - the beginning of the interval

year1 - the end of the interval

monteCarloRealizationId - the id of the Monte Carlo realization if needed

Returns:

an array of doubles

setBasicTrendModifier

public void setBasicTrendModifier(FrenchNFIThinnerPredictor.FrenchNFIThinnerSpecies species,
                                  int fromYear,
                                  int toYear,
                                  double relativeChange)

This method makes it possible to induce price changes over time for a particular species. Note that this change DOES not affect observed prices

Parameters:

species - a FrenchNFIThinnerSpecies instance

fromYear - the starting year

toYear - the final year

relativeChange - the relative change over the period. For example, 0.1 would be a 10% increase over the period.

setBasicTrendModifier

public void setBasicTrendModifier(int fromYear,
                                  int toYear,
                                  double relativeChange)

This method makes it possible to induce price changes over time for all species. Note that this change DOES not affect observed prices.

Parameters:

fromYear - the starting year

toYear - the final year

relativeChange - the relative change over the period. For example, 0.1 would be a 10% increase over the period.

setMultiplierModifier

public void setMultiplierModifier(FrenchNFIThinnerPredictor.FrenchNFIThinnerSpecies species,
                                  int fromYear,
                                  int toYear,
                                  double relativeChange)

This method makes it possible to induce a proportional price changes for a given period and a give species. Note that this change DOES affect observed prices.

Parameters:

species - a FrenchNFIThinnerSpecies instance

fromYear - the starting year

toYear - the final year

relativeChange - the relative change over the period. For example, 0.1 would be a 10% increase over the period.

setMultiplierModifier

public void setMultiplierModifier(int fromYear,
                                  int toYear,
                                  double relativeChange)

This method makes it possible to induce a proportional price changes for a given period for all species. Note that this change DOES affect observed prices.

Parameters:

fromYear - the starting year

toYear - the final year

relativeChange - the relative change over the period. For example, 0.1 would be a 10% increase over the period.

resetModifiers

public void resetModifiers()

getFrenchNFIThinnerSpeciesFromThisString

protected static FrenchNFIThinnerPredictor.FrenchNFIThinnerSpecies getFrenchNFIThinnerSpeciesFromThisString(java.lang.String speciesName)

This method returns a FrenchNFIThinnerSpecies instance that matches the species name. The species name is formatted.

Parameters:

speciesName - a String that represents the common species name in French.

Returns:

a FrenchNFIThinnerSpecies enum