lerfob.predictor.thinners.frenchnfithinner2018

Class FrenchNFIThinnerPlotImpl

java.lang.Object

lerfob.predictor.thinners.frenchnfithinner2018.FrenchNFIThinnerPlotImpl

All Implemented Interfaces:

FrenchNFIThinnerPlot, FrenchRegion2016Provider, BasalAreaM2HaProvider, SlopeInclinationPercentProvider, StemDensityHaProvider, MonteCarloSimulationCompliantObject

public class FrenchNFIThinnerPlotImpl
extends java.lang.Object
implements FrenchNFIThinnerPlot

Basic implementation of the FrenchNFIThinnerPlot interface.

Nested Class Summary

Nested classes/interfaces inherited from interface lerfob.simulation.covariateproviders.plotlevel.FrenchRegion2016Provider

FrenchRegion2016Provider.FrenchRegion2016

Constructor Summary

Constructors

Constructor and Description
FrenchNFIThinnerPlotImpl(java.lang.String plotId, java.lang.String regionName, double basalAreaM2Ha, double nbStemsHa, double slopeInclinationPercent, boolean wasThereAnySiliviculturalTreatmentInTheLast5Years, double probabilityOfBeingOnPrivateLand) Constructor.

Method Summary

Modifier and Type	Method and Description
double	getBasalAreaM2Ha() This method returns the basal area of the stand in m2/ha.
FrenchRegion2016Provider.FrenchRegion2016	getFrenchRegion2016() This method returns the region (version 2016) the plot is located in.
int	getMonteCarloRealizationId() This method returns the id of the Monte Carlo realization.
double	getNumberOfStemsHa() This method returns the stem density per hectare.
java.util.Map<FrenchNFIThinnerPredictor.FrenchNFIThinnerSpecies,java.lang.Double>	getOverbarkVolumeM3BySpecies() This method returns a Map with the species as keys and the volumes (m3) as values.
double	getProbabilityOfBeingOnPrivateLand() This method returns the probability that the plot is located on private land.
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.
void	setVolumeForThisSpecies(java.lang.String speciesName, double volumeHa) This method sets the volume of the difference species that compose the plot.
boolean	wasThereAnySiliviculturalTreatmentInTheLast5Years() This method returns true if any silvicultural treatment was carried out in the plot during the last five years.

Methods inherited from class java.lang.Object

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

Methods inherited from interface lerfob.predictor.thinners.frenchnfithinner2018.FrenchNFIThinnerPlot

getHierarchicalLevel

Methods inherited from interface lerfob.simulation.covariateproviders.plotlevel.FrenchRegion2016Provider

getFrenchRegion2016FromThisString

Constructor Detail

FrenchNFIThinnerPlotImpl

public FrenchNFIThinnerPlotImpl(java.lang.String plotId,
                                java.lang.String regionName,
                                double basalAreaM2Ha,
                                double nbStemsHa,
                                double slopeInclinationPercent,
                                boolean wasThereAnySiliviculturalTreatmentInTheLast5Years,
                                double probabilityOfBeingOnPrivateLand)

Constructor.

Parameters:

plotId -

regionName -

basalAreaM2Ha -

nbStemsHa -

slopeInclinationPercent -

wasThereAnySiliviculturalTreatmentInTheLast5Years -

probabilityOfBeingOnPrivateLand -

Method Detail

setVolumeForThisSpecies

public void setVolumeForThisSpecies(java.lang.String speciesName,
                                    double volumeHa)

This method sets the volume of the difference species that compose the plot.

Parameters:

speciesName - a String that represents the species name

volumeHa - a double (volume per hectare)

getFrenchRegion2016

public FrenchRegion2016Provider.FrenchRegion2016 getFrenchRegion2016()

Description copied from interface: FrenchRegion2016Provider

This method returns the region (version 2016) the plot is located in.

Specified by:

getFrenchRegion2016 in interface FrenchRegion2016Provider

Returns:

a FrenchRegion2016 enum

getBasalAreaM2Ha

public double getBasalAreaM2Ha()

Description copied from interface: BasalAreaM2HaProvider

This method returns the basal area of the stand in m2/ha.

Specified by:

getBasalAreaM2Ha in interface BasalAreaM2HaProvider

Returns:

a double

getNumberOfStemsHa

public double getNumberOfStemsHa()

Description copied from interface: StemDensityHaProvider

This method returns the stem density per hectare.

Specified by:

getNumberOfStemsHa in interface StemDensityHaProvider

Returns:

a double

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%

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

wasThereAnySiliviculturalTreatmentInTheLast5Years

public boolean wasThereAnySiliviculturalTreatmentInTheLast5Years()

Description copied from interface: FrenchNFIThinnerPlot

This method returns true if any silvicultural treatment was carried out in the plot during the last five years.

Specified by:

wasThereAnySiliviculturalTreatmentInTheLast5Years in interface FrenchNFIThinnerPlot

Returns:

a boolean

getProbabilityOfBeingOnPrivateLand

public double getProbabilityOfBeingOnPrivateLand()

Description copied from interface: FrenchNFIThinnerPlot

This method returns the probability that the plot is located on private land. This method reflects the uncertainty around the location of the plot in the French NFI. In case the model is used with other data, the value of 1 should be returned when the plot is located on private land or 0 if it is on public land. If the plot instance implements the LandOwnershipProvider interface available in repicea.jar, the interface is used in priority over the current method.

Specified by:

getProbabilityOfBeingOnPrivateLand in interface FrenchNFIThinnerPlot

Returns:

a double (a probability)

getOverbarkVolumeM3BySpecies

public java.util.Map<FrenchNFIThinnerPredictor.FrenchNFIThinnerSpecies,java.lang.Double> getOverbarkVolumeM3BySpecies()

Description copied from interface: FrenchNFIThinnerPlot

This method returns a Map with the species as keys and the volumes (m3) as values. It is required to identify the target species.

Specified by:

getOverbarkVolumeM3BySpecies in interface FrenchNFIThinnerPlot

Returns:

a Map instance