clNCINeighborBA Class Reference

This calculates an NCI term which is the sum of BA of neighbors. More...

#include <NCINeighborBA.h>

Inheritance diagram for clNCINeighborBA:

Public Member Functions
	clNCINeighborBA ()
	Constructor. More...
ncivals	CalculateNCITerm (clTree *p_oTree, clTreePopulation *p_oPop, clPlot *p_oPlot, const float &fX, const float &fY, const int &iSpecies)
	Calculates NCI term. More...
void	DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)
	Does any desired setup. More...
	~clNCINeighborBA ()
Public Member Functions inherited from clNCITermBase
	clNCITermBase ()
	Constructor. More...
int	GetNumberNCIs ()
virtual void	PreCalcs (clTreePopulation *p_oPop)
	Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More...
virtual	~clNCITermBase ()
	Destructor. More...
bool	DoesRequireTargetDiam ()

Protected Attributes
double *	mp_fMaxCrowdingRadius
	Maximum search radius, in meters, in which to look for crowding neighbors. More...
double *	mp_fMinimumNeighborDBH
	The minimum DBH, in cm, of neighbors to be included in the neighbor count. More...
float	m_fMinSaplingHeight
	Minimum sapling height. More...
double	m_fBADivisor
	Divisor for neighbor BA. More...
bool	m_bUseOnlyLargerNeighbors
	Whether to use all trees larger than the minimum (false) or only neighbors larger than the target (true) More...
Protected Attributes inherited from clNCITermBase
bool	bRequiresTargetDiam
	Whether or not this effect depends on a target diameter being available. More...
int	iNumNCIs
	Number of NCI values calculated and populated into ncivals. More...

Detailed Description

This calculates an NCI term which is the sum of BA of neighbors.

The candidate neighbors are those within a certain radius and above a minimum DBH. Optionally, this can sum only those neighbors larger than the target. Seedlings do not compete.

This can be applied to seedlings but only if the "larger neighbors only" flag is false.

BA is reported in cm2, but there is a divisor term which can be used to adjust units if desired.

This returns 1 value for NCI.

Constructor & Destructor Documentation

clNCINeighborBA()

clNCINeighborBA::clNCINeighborBA

(

)

Constructor.

~clNCINeighborBA()

clNCINeighborBA::~clNCINeighborBA

(

)

Member Function Documentation

CalculateNCITerm()

ncivals clNCINeighborBA::CalculateNCITerm ( clTree *  p_oTree, clTreePopulation *  p_oPop, clPlot *  p_oPlot, const float &  fX, const float &  fY, const int &  iSpecies  )

virtual

Calculates NCI term.

Parameters

p_oTree	Tree for which to calculate NCI.
p_oPop	Tree population.
p_oPlot	Plot object.
fX	X coordinate for which to calculate NCI.
fY	Y coordinate for which to calculate NCI.
iSpecies	Species for which to calculate NCI.

Implements clNCITermBase.

DoSetup()

void clNCINeighborBA::DoSetup ( clTreePopulation *  p_oPop, clBehaviorBase *  p_oNCI, xercesc::DOMElement *  p_oElement  )

virtual

Does any desired setup.

Parameters

p_oPop	Tree population.
p_oNCI	NCI behavior object.
p_oElement	Root element of the behavior.

Exceptions

ModelException

if m_bUseOnlyLargerNeighbors is true and the parent NCI behavior is applied to seedlings (as targets).

Implements clNCITermBase.

Member Data Documentation

m_bUseOnlyLargerNeighbors

bool clNCINeighborBA::m_bUseOnlyLargerNeighbors

protected

Whether to use all trees larger than the minimum (false) or only neighbors larger than the target (true)

m_fBADivisor

double clNCINeighborBA::m_fBADivisor

protected

Divisor for neighbor BA.

m_fMinSaplingHeight

float clNCINeighborBA::m_fMinSaplingHeight

protected

Minimum sapling height.

For doing neighbor searches.

mp_fMaxCrowdingRadius

double* clNCINeighborBA::mp_fMaxCrowdingRadius

protected

Maximum search radius, in meters, in which to look for crowding neighbors.

Array is sized number of species.

mp_fMinimumNeighborDBH

double* clNCINeighborBA::mp_fMinimumNeighborDBH

protected

The minimum DBH, in cm, of neighbors to be included in the neighbor count.

Array is sized number of species.

---

The documentation for this class was generated from the following file:

• NCINeighborBA.h