repicea.simulation

Class REpiceaBinaryEventPredictor<S,T>

java.lang.Object

repicea.simulation.SensitivityAnalysisParameter<ModelParameterEstimates>

repicea.simulation.REpiceaPredictor

repicea.simulation.REpiceaBinaryEventPredictor<S,T>

Type Parameters:

S - a class that represents the stand or the plot

T - a class that represents the tree

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

FrenchNFIThinnerPredictor, MathildeMortalityPredictor, MathildeStandThinningPredictor, MathildeStandThinningPredictor, MathildeTreeThinningPredictor, MathildeTreeThinningPredictor

public abstract class REpiceaBinaryEventPredictor<S,T>
extends REpiceaPredictor

This REpiceaBinaryEventPredictor class implements logistic and other models that aim at predicting the occurrence of binary event.

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

Modifier	Constructor and Description
protected	REpiceaBinaryEventPredictor(boolean isParametersVariabilityEnabled, boolean isRandomEffectsVariabilityEnabled, boolean isResidualVariabilityEnabled)

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	findFirstParameterOfThisClass(java.lang.Class<?> clazz, java.lang.Object... parms) This method scans the parameters and finds the first object that is an instance of this class.
java.lang.Object	predictEvent(S stand, T tree, java.lang.Object... parms) This method returns either a boolean if isResidualVariabilityEnabled was set to true or the probability otherwise.
abstract double	predictEventProbability(S stand, T tree, java.lang.Object... parms) This method returns the probability of event for a particular tree represented by the parameter "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, init, 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

REpiceaBinaryEventPredictor

protected REpiceaBinaryEventPredictor(boolean isParametersVariabilityEnabled,
                                      boolean isRandomEffectsVariabilityEnabled,
                                      boolean isResidualVariabilityEnabled)

Method Detail

predictEventProbability

public abstract double predictEventProbability(S stand,
                                               T tree,
                                               java.lang.Object... parms)

This method returns the probability of event for a particular tree represented by the parameter "tree".

Parameters:

stand - a S-derived instance

tree - a T-derived instance

parms - some additional parameters

Returns:

the event probability

predictEvent

public java.lang.Object predictEvent(S stand,
                                     T tree,
                                     java.lang.Object... parms)

This method returns either a boolean if isResidualVariabilityEnabled was set to true or the probability otherwise.

Parameters:

stand - a S-derived instance

tree - a T-derived instance

parms - some additional parameters

Returns:

a Boolean or a double

findFirstParameterOfThisClass

public static java.lang.Object findFirstParameterOfThisClass(java.lang.Class<?> clazz,
                                                             java.lang.Object... parms)

This method scans the parameters and finds the first object that is an instance of this class.

Parameters:

clazz - the class of object to be looked for

parms - the parameters

Returns:

the first object of this class or null otherwise