lerfob.predictor.hdrelationships.frenchgeneralhdrelationship2018

Class FrenchHDRelationship2018TreeImpl

java.lang.Object

lerfob.predictor.hdrelationships.frenchgeneralhdrelationship2018.FrenchHDRelationship2018TreeImpl

All Implemented Interfaces:

FrenchHDRelationship2018Tree, FrenchHDRelationshipTree, FrenchCommercialVolume2014Tree, DbhCmProvider, HeightMProvider, LnDbhCmPlus1Provider, SquaredDbhCmProvider, SquaredLnDbhCmPlus1Provider, HDRelationshipTree, MonteCarloSimulationCompliantObject, GaussianErrorTermList.IndexableErrorTerm

public class FrenchHDRelationship2018TreeImpl
extends java.lang.Object
implements FrenchHDRelationship2018Tree, FrenchCommercialVolume2014Tree

The FrenchHDRelationship2018TreeImpl class is a basic implementation of the FrenchHDRelationship2018Tree. It facilitates the connection to JNI.

Nested Class Summary

Nested classes/interfaces inherited from interface lerfob.predictor.hdrelationships.FrenchHDRelationshipTree

FrenchHDRelationshipTree.FrenchHdSpecies

Nested classes/interfaces inherited from interface lerfob.predictor.volume.frenchcommercialvolume2014.FrenchCommercialVolume2014Tree

FrenchCommercialVolume2014Tree.FrenchCommercialVolume2014TreeSpecies

Field Summary

Fields

Modifier and Type	Field and Description
protected double	dbhCm
protected java.lang.Double	gOther
protected double	heightM
protected int	id
protected FrenchHDRelationship2018PlotImpl	plot
protected FrenchHDRelationshipTree.FrenchHdSpecies	species

Constructor Summary

Constructors

Modifier	Constructor and Description
	FrenchHDRelationship2018TreeImpl(double dbhCm, java.lang.String speciesName, FrenchHDRelationship2018PlotImpl plot) Constructor for NFI data.
protected	FrenchHDRelationship2018TreeImpl(int id, double heightM, double dbhCm, java.lang.Double gOther, java.lang.String speciesName, FrenchHDRelationship2018PlotImpl plot) Constructor.
	FrenchHDRelationship2018TreeImpl(int id, double heightM, double dbhCm, java.lang.String speciesName, FrenchHDRelationship2018PlotImpl plot) Constructor for NFI data.

Method Summary

Modifier and Type	Method and Description
protected double	getBasalAreaM2()
double	getDbhCm() This method returns the diameter at breast height of the tree.
int	getErrorTermIndex() This method returns the index of the error term.
FrenchCommercialVolume2014Tree.FrenchCommercialVolume2014TreeSpecies	getFrenchCommercialVolume2014TreeSpecies() This method returns the species of the tree instance.
FrenchHDRelationshipTree.FrenchHdSpecies	getFrenchHDTreeSpecies() This method ensures the species compatibility with the hd relationship.
protected double	getGOther()
java.lang.Enum<?>	getHDRelationshipTreeErrorGroup() This method returns the error group in case of different error correlation structure.
double	getHeightM() This method returns the tree height in m.
HierarchicalLevel	getHierarchicalLevel() This method returns the hierarchical levels of the object.
double	getLnDbhCmPlus1() This method returns ln(dbh + 1) with the dbh in cm.
int	getMonteCarloRealizationId() This method returns the id of the Monte Carlo realization.
double	getSquaredDbhCm() This method returns the square of dbh.
double	getSquaredLnDbhCmPlus1() This method returns (ln(dbh + 1))^2 with the dbh in cm.
java.lang.String	getSubjectId() This method returns an object that makes it possible to identify the subject that implements this interface.

Methods inherited from class java.lang.Object

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

Field Detail

heightM

protected double heightM

dbhCm

protected double dbhCm

species

protected final FrenchHDRelationshipTree.FrenchHdSpecies species

plot

protected final FrenchHDRelationship2018PlotImpl plot

id

protected final int id

gOther

protected java.lang.Double gOther

Constructor Detail

FrenchHDRelationship2018TreeImpl

protected FrenchHDRelationship2018TreeImpl(int id,
                                           double heightM,
                                           double dbhCm,
                                           java.lang.Double gOther,
                                           java.lang.String speciesName,
                                           FrenchHDRelationship2018PlotImpl plot)

Constructor.

Parameters:

heightM - the height of the tree (m) or -1 if it was not observed

dbhCm - the diameter at breast height (cm)

gOther - the basal area of other trees (m2/ha)

speciesName - a String that corresponds to a FrenchHd2018Species enum

plot - a FrenchHDRelationship2018StandImpl instance that hosts the tree

FrenchHDRelationship2018TreeImpl

public FrenchHDRelationship2018TreeImpl(int id,
                                        double heightM,
                                        double dbhCm,
                                        java.lang.String speciesName,
                                        FrenchHDRelationship2018PlotImpl plot)

Constructor for NFI data. The basal area of other trees is calculated using the plot basal area.

Parameters:

id - an integer

heightM - the height of the tree (m) or -1 if it was not observed

dbhCm - the diameter at breast height (cm)

speciesName - a String that corresponds to a FrenchHd2018Species enum

plot - a FrenchHDRelationship2018StandImpl instance that hosts the tree

FrenchHDRelationship2018TreeImpl

public FrenchHDRelationship2018TreeImpl(double dbhCm,
                                        java.lang.String speciesName,
                                        FrenchHDRelationship2018PlotImpl plot)

Constructor for NFI data. The basal area of other trees is calculated using the plot basal area. The model is used in a deterministic manner. Tree heights are assumed to be all unobserved.

Parameters:

dbhCm - the diameter at breast height (cm)

speciesName - a String that corresponds to a FrenchHd2018Species enum

plot - a FrenchHDRelationship2018StandImpl instance that hosts the tree

Method Detail

getErrorTermIndex

public int getErrorTermIndex()

Description copied from interface: GaussianErrorTermList.IndexableErrorTerm

This method returns the index of the error term. Typically, this value is the time and it serves to calculate the distance between two observations when computing the variance-covariance matrix.

Specified by:

getErrorTermIndex in interface GaussianErrorTermList.IndexableErrorTerm

Returns:

an Integer

getHDRelationshipTreeErrorGroup

public java.lang.Enum<?> getHDRelationshipTreeErrorGroup()

Description copied from interface: HDRelationshipTree

This method returns the error group in case of different error correlation structure. For instance, if coniferous species have a correlation structure that differs from that of broadleaved species.

Specified by:

getHDRelationshipTreeErrorGroup in interface HDRelationshipTree

Returns:

an Enum that defines the group

getSubjectId

public java.lang.String getSubjectId()

Description copied from interface: MonteCarloSimulationCompliantObject

This method returns an object that makes it possible to identify the subject that implements this interface. This id remains constant throughout the Monte Carlo iterations in case of stochastic implementation.

Specified by:

getSubjectId in interface MonteCarloSimulationCompliantObject

Returns:

a String that defines the subject id and that remains constant throughout the simulation

getMonteCarloRealizationId

public int getMonteCarloRealizationId()

Description copied from interface: MonteCarloSimulationCompliantObject

This method returns the id of the Monte Carlo realization. It is necessary for the implementation of the random deviates on the parameter estimates. These deviates remain constant for a particular Monte Carlo iteration, regardless of the plot.

Specified by:

getMonteCarloRealizationId in interface MonteCarloSimulationCompliantObject

Returns:

an integer

getHeightM

public double getHeightM()

Description copied from interface: HeightMProvider

This method returns the tree height in m.

Specified by:

getHeightM in interface HeightMProvider

Returns:

the height in m (double)

getDbhCm

public double getDbhCm()

Description copied from interface: DbhCmProvider

This method returns the diameter at breast height of the tree.

Specified by:

getDbhCm in interface DbhCmProvider

Returns:

the dbh in cm (double)

getLnDbhCmPlus1

public double getLnDbhCmPlus1()

Description copied from interface: LnDbhCmPlus1Provider

This method returns ln(dbh + 1) with the dbh in cm.

Specified by:

getLnDbhCmPlus1 in interface LnDbhCmPlus1Provider

Returns:

a double

getSquaredLnDbhCmPlus1

public double getSquaredLnDbhCmPlus1()

Description copied from interface: SquaredLnDbhCmPlus1Provider

This method returns (ln(dbh + 1))^2 with the dbh in cm.

Specified by:

getSquaredLnDbhCmPlus1 in interface SquaredLnDbhCmPlus1Provider

Returns:

a double

getFrenchHDTreeSpecies

public FrenchHDRelationshipTree.FrenchHdSpecies getFrenchHDTreeSpecies()

Description copied from interface: FrenchHDRelationship2018Tree

This method ensures the species compatibility with the hd relationship.

Specified by:

getFrenchHDTreeSpecies in interface FrenchHDRelationship2018Tree

Returns:

a FrenchHdSpecies enum instance

getGOther

protected double getGOther()

getBasalAreaM2

protected double getBasalAreaM2()

getSquaredDbhCm

public double getSquaredDbhCm()

Description copied from interface: SquaredDbhCmProvider

This method returns the square of dbh.

Specified by:

getSquaredDbhCm in interface SquaredDbhCmProvider

Returns:

the square of dbh in cm2 (double)

getHierarchicalLevel

public HierarchicalLevel getHierarchicalLevel()

Description copied from interface: MonteCarloSimulationCompliantObject

This method returns the hierarchical levels of the object.

Specified by:

getHierarchicalLevel in interface FrenchCommercialVolume2014Tree

Specified by:

getHierarchicalLevel in interface HDRelationshipTree

Specified by:

getHierarchicalLevel in interface MonteCarloSimulationCompliantObject

Returns:

a HierarchicalLevel instance

getFrenchCommercialVolume2014TreeSpecies

public FrenchCommercialVolume2014Tree.FrenchCommercialVolume2014TreeSpecies getFrenchCommercialVolume2014TreeSpecies()

Description copied from interface: FrenchCommercialVolume2014Tree

This method returns the species of the tree instance.

Specified by:

getFrenchCommercialVolume2014TreeSpecies in interface FrenchCommercialVolume2014Tree

Returns:

a FrenchCommercialVolume2014TreeSpecies enum instance