lerfob.predictor.hdrelationships.frenchgeneralhdrelationship2018

Class FrenchHDRelationship2018PlotImpl

java.lang.Object

lerfob.predictor.hdrelationships.frenchgeneralhdrelationship2018.FrenchHDRelationship2018PlotImpl

All Implemented Interfaces:

FrenchHDRelationship2018Plot, DateYrProvider, ElevationMProvider, GeographicalCoordinatesProvider, InterventionResultProvider, MeanQuadraticDiameterCmProvider, SlopeInclinationPercentProvider, HDRelationshipStand, MonteCarloSimulationCompliantObject

public class FrenchHDRelationship2018PlotImpl
extends java.lang.Object
implements FrenchHDRelationship2018Plot

The FrenchHDRelationship2018PlotImpl class is a basic implementation of the FrenchHDRelationship2018Plot.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	dateYr
protected java.lang.String	id
protected double	pent2
protected java.util.List<FrenchHDRelationship2018Tree>	treeList
protected double	xCoord
protected double	yCoord

Constructor Summary

Constructors

Constructor and Description
FrenchHDRelationship2018PlotImpl(java.lang.String id, double pentInc, double xCoord, double yCoord, boolean hasBeenHarvestedInLast5Years, double basalAreaM2Ha, double mqdCm, int dateYr) Constructor for French NFI.
FrenchHDRelationship2018PlotImpl(java.lang.String id, double pentInc, double xCoord, double yCoord, boolean hasBeenHarvestedInLast5Years, int monteCarloId, double mqdCm, int dateYr) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addTree(FrenchHDRelationship2018TreeImpl tree)
double	getBasalAreaM2HaMinusThisSubject(HDRelationshipTree tree) This method returns the basal area per hectare minus the basal area of the tree.
int	getDateYr() This method returns the current date in years.
double	getElevationM() This method returns the elevation above sea level (m).
double	getLatitudeDeg() This method returns the latitude of the plot in degrees.
double	getLongitudeDeg() This method returns the longitude of the plot in degrees.
double	getMeanQuadraticDiameterCm() This method returns the mean quadratic diameter of the living trees (cm).
int	getMonteCarloRealizationId() This method returns the id of the Monte Carlo realization.
double	getSlopeInclinationPercent() This method returns the slope inclination in percentage.
java.lang.String	getSubjectId() This method returns an object that makes it possible to identify the subject that implements this interface.
java.util.Collection<HDRelationshipTree>	getTreesForFrenchHDRelationship() This method returns the trees that are available in the stand for height prediction.
boolean	isInterventionResult() This method returns true if the stand has just been harvested or thinned.
void	setDateYr(int dateYr) Sets the date of the measurement.

Methods inherited from class java.lang.Object

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

Methods inherited from interface repicea.simulation.hdrelationships.HDRelationshipStand

getHierarchicalLevel

Field Detail

id

protected final java.lang.String id

pent2

protected final double pent2

xCoord

protected final double xCoord

yCoord

protected final double yCoord

treeList

protected final java.util.List<FrenchHDRelationship2018Tree> treeList

dateYr

protected int dateYr

Constructor Detail

FrenchHDRelationship2018PlotImpl

public FrenchHDRelationship2018PlotImpl(java.lang.String id,
                                        double pentInc,
                                        double xCoord,
                                        double yCoord,
                                        boolean hasBeenHarvestedInLast5Years,
                                        int monteCarloId,
                                        double mqdCm,
                                        int dateYr)

Constructor.

Parameters:

id - the id of the plot

pentInc - the inclination of the slope in % (for 1% it is 1 and not .01)

xCoord - the latitude in geographic coordinates

yCoord - the longitude in geographic coordinates

hasBeenHarvestedInLast5Years - a boolean that takes the value of true if the plot was managed in the last five years

monteCarloId - the Monte Carlo id if needed

mqdCm - the mean quadratic diameter of the plot (cm)

dateYr - the current date in years

FrenchHDRelationship2018PlotImpl

public FrenchHDRelationship2018PlotImpl(java.lang.String id,
                                        double pentInc,
                                        double xCoord,
                                        double yCoord,
                                        boolean hasBeenHarvestedInLast5Years,
                                        double basalAreaM2Ha,
                                        double mqdCm,
                                        int dateYr)

Constructor for French NFI.

Parameters:

id - the id of the plot

pentInc - the inclination of the slope in % (for 1% it is 1 and not .01)

xCoord - the latitude in geographic coordinates

yCoord - the longitude in geographic coordinates

hasBeenHarvestedInLast5Years - a boolean that takes the value of true if the plot was managed in the last five years

basalAreaM2Ha - plot basal area (m2/ha)

mqdCm - plot mean quadratic diameter (cm)

dateYr - the current date in years

Method Detail

setDateYr

public void setDateYr(int dateYr)

Sets the date of the measurement.

Parameters:

dateYr - the date (yr)

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

getMeanQuadraticDiameterCm

public double getMeanQuadraticDiameterCm()

Description copied from interface: MeanQuadraticDiameterCmProvider

This method returns the mean quadratic diameter of the living trees (cm).

Specified by:

getMeanQuadraticDiameterCm in interface MeanQuadraticDiameterCmProvider

Returns:

a double

isInterventionResult

public boolean isInterventionResult()

Description copied from interface: InterventionResultProvider

This method returns true if the stand has just been harvested or thinned.

Specified by:

isInterventionResult in interface InterventionResultProvider

Returns:

a boolean

getSlopeInclinationPercent

public double getSlopeInclinationPercent()

Description copied from interface: SlopeInclinationPercentProvider

This method returns the slope inclination in percentage.

Specified by:

getSlopeInclinationPercent in interface SlopeInclinationPercentProvider

Returns:

the slope inclination in percentage, i.e. a value of 100 means 100%

getLatitudeDeg

public double getLatitudeDeg()

Description copied from interface: GeographicalCoordinatesProvider

This method returns the latitude of the plot in degrees.

Specified by:

getLatitudeDeg in interface GeographicalCoordinatesProvider

Returns:

a double

getLongitudeDeg

public double getLongitudeDeg()

Description copied from interface: GeographicalCoordinatesProvider

This method returns the longitude of the plot in degrees.

Specified by:

getLongitudeDeg in interface GeographicalCoordinatesProvider

Returns:

a double

getElevationM

public double getElevationM()

Description copied from interface: ElevationMProvider

This method returns the elevation above sea level (m).

Specified by:

getElevationM in interface ElevationMProvider

Returns:

a double

getBasalAreaM2HaMinusThisSubject

public double getBasalAreaM2HaMinusThisSubject(HDRelationshipTree tree)

Description copied from interface: FrenchHDRelationship2018Plot

This method returns the basal area per hectare minus the basal area of the tree.

Specified by:

getBasalAreaM2HaMinusThisSubject in interface FrenchHDRelationship2018Plot

Parameters:

tree - a FrenchHDRelationship2014Tree instance

Returns:

the basal area (m2/ha)

getTreesForFrenchHDRelationship

public java.util.Collection<HDRelationshipTree> getTreesForFrenchHDRelationship()

Description copied from interface: FrenchHDRelationship2018Plot

This method returns the trees that are available in the stand for height prediction. This method is called when the blups of the random effects are initially estimated:

Specified by:

getTreesForFrenchHDRelationship in interface FrenchHDRelationship2018Plot

Returns:

A collection of FrenchHDRelationship2014Tree instances

addTree

protected void addTree(FrenchHDRelationship2018TreeImpl tree)

getDateYr

public int getDateYr()

Description copied from interface: DateYrProvider

This method returns the current date in years.

Specified by:

getDateYr in interface DateYrProvider

Returns:

an integer