repicea.simulation.allometrycalculator

Class AllometryCalculator

java.lang.Object

repicea.simulation.allometrycalculator.AllometryCalculator

public class AllometryCalculator
extends java.lang.Object

This calculator provides the basic allometric features, such as the basal area, the mean quadratic diameter, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static double	NumberOfTreesHaForDominantFeatures

Constructor Summary

Constructors

Constructor and Description
AllometryCalculator()

Method Summary

Modifier and Type	Method and Description
double	getBasalAreaM2(java.util.Collection<? extends LightAllometryCalculableTree> trees) This method computes the basal area of a collection of trees.
double	getCommercialVolumeM3(java.util.Collection<? extends AllometryCalculableTree> trees) This method computes the commercial volume for a collection of commercial trees.
double	getDominantDiameterCM(java.util.Collection<? extends AllometryCalculableTree> trees, double plotAreaHa, boolean weighted) This method returns the dominant diameter for the trees contained in the trees collection.
double	getDominantHeightM(java.util.Collection<? extends AllometryCalculableTree> trees, double plotAreaHa, boolean weighted) This method returns the dominant height for the trees contained in the trees collection.
double	getMeanQuadraticDiameterCm(java.util.Collection<? extends LightAllometryCalculableTree> trees) This method returns the mean quadratic diameter for a collection of trees.
double	getNumberOfTrees(java.util.Collection<? extends LightAllometryCalculableTree> trees) This method returns the number of trees for a collection of trees.
double	getTotalVolumeM3(java.util.Collection<? extends AllometryCalculableTree> trees) This method computes the above ground volume for a collection of trees.
java.util.Collection<LightAllometryCalculableTree>	getTreesLarger(java.util.Collection<? extends LightAllometryCalculableTree> trees, double threshold) This method returns a collection of CalculableTree objects that have a dbh greater than a particular threshold.

Methods inherited from class java.lang.Object

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

Field Detail

NumberOfTreesHaForDominantFeatures

public static final double NumberOfTreesHaForDominantFeatures

See Also:

Constant Field Values

Constructor Detail

AllometryCalculator

public AllometryCalculator()

Method Detail

getMeanQuadraticDiameterCm

public double getMeanQuadraticDiameterCm(java.util.Collection<? extends LightAllometryCalculableTree> trees)

This method returns the mean quadratic diameter for a collection of trees.

Parameters:

trees - a Collection object that should contain instances of LightAllometryCalculableTree

Returns:

the mean quadratic diameter in cm

getBasalAreaM2

public double getBasalAreaM2(java.util.Collection<? extends LightAllometryCalculableTree> trees)

This method computes the basal area of a collection of trees.

Parameters:

trees - a Collection object that should contain instances of LightAllometryCalculableTree

Returns:

the basal area in m2 (double)

getNumberOfTrees

public double getNumberOfTrees(java.util.Collection<? extends LightAllometryCalculableTree> trees)

This method returns the number of trees for a collection of trees.

Parameters:

trees - a Collection object that should contain instances of LightAllometryCalculableTree

Returns:

the number of trees (double)

getTreesLarger

public java.util.Collection<LightAllometryCalculableTree> getTreesLarger(java.util.Collection<? extends LightAllometryCalculableTree> trees,
                                                                         double threshold)

This method returns a collection of CalculableTree objects that have a dbh greater than a particular threshold.

Parameters:

trees - a Collection object that should contain instances of AllometryCalculableTree

threshold - the dbh threshold in cm (double)

Returns:

a Collection object

getCommercialVolumeM3

public double getCommercialVolumeM3(java.util.Collection<? extends AllometryCalculableTree> trees)

This method computes the commercial volume for a collection of commercial trees. NOTE: The commercial volume is defined as the volume for trees that are equal to or greater than a particular dbh (e.g. 9.1 cm in dbh for Quebec).

Parameters:

trees - a Collection object that should contains AllometryCalculableTree instances

Returns:

the commercial volume in m3 (double)

getTotalVolumeM3

public double getTotalVolumeM3(java.util.Collection<? extends AllometryCalculableTree> trees)

This method computes the above ground volume for a collection of trees.

Parameters:

trees - a Collection object that should contains AllometryCalculableTree instances

Returns:

the total volume in m3 (double)

getDominantHeightM

public double getDominantHeightM(java.util.Collection<? extends AllometryCalculableTree> trees,
                                 double plotAreaHa,
                                 boolean weighted)

This method returns the dominant height for the trees contained in the trees collection.

Parameters:

trees - the Collection object that contains instances of AllometryCalculableTree

plotAreaHa - the area over which the trees were measured in ha (double)

weighted - true to enable the plot weighting or false otherwise

Returns:

the dominant height in m (double)

getDominantDiameterCM

public double getDominantDiameterCM(java.util.Collection<? extends AllometryCalculableTree> trees,
                                    double plotAreaHa,
                                    boolean weighted)

This method returns the dominant diameter for the trees contained in the trees collection.

Parameters:

trees - the Collection object that contains instances of AllometryCalculableTree

plotAreaHa - the area over which the trees were measured in ha (double)

weighted - true to enable the plot weighting or false otherwise

Returns:

the dominant diameter in cm (double)