clNCILargerNeighbors Class Reference

The NCI term is simply a count of sapling and adult neighbors with a larger DBH than the target within a certain radius, subject to a minimum value. More...

#include <NCILargerNeighbors.h>

Inheritance diagram for clNCILargerNeighbors:

Public Member Functions
	clNCILargerNeighbors ()
	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...
	~clNCILargerNeighbors ()
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...
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

The NCI term is simply a count of sapling and adult neighbors with a larger DBH than the target within a certain radius, subject to a minimum value.

If there is no target, then all greater than the minimum DBH are used.

This returns 1 value for NCI.

Constructor & Destructor Documentation

clNCILargerNeighbors()

clNCILargerNeighbors::clNCILargerNeighbors

(

)

Constructor.

~clNCILargerNeighbors()

clNCILargerNeighbors::~clNCILargerNeighbors

(

)

Member Function Documentation

CalculateNCITerm()

ncivals clNCILargerNeighbors::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 clNCILargerNeighbors::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.

Implements clNCITermBase.

Member Data Documentation

m_fMinSaplingHeight

float clNCILargerNeighbors::m_fMinSaplingHeight

protected

Minimum sapling height.

For doing neighbor searches.

mp_fMaxCrowdingRadius

double* clNCILargerNeighbors::mp_fMaxCrowdingRadius

protected

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

Array is sized number of species.

mp_fMinimumNeighborDBH

double* clNCILargerNeighbors::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:

• NCILargerNeighbors.h