|
| clRipleysKCalculator (clSimManager *p_oSimManager) |
| Constructor.
|
|
| ~clRipleysKCalculator () |
| Destructor.
|
|
void | Action () |
| Calculates Ripley's K.
|
|
void | GetData (xercesc::DOMDocument *p_oDoc) |
| Does setup for this behavior.
|
|
virtual float | GetBehaviorVersion () |
| Gets the behavior version number.
|
|
| clBehaviorBase (clSimManager *p_oSimManager) |
| Constructor.
|
|
virtual | ~clBehaviorBase () |
| Destructor.
|
|
virtual short int | ValidateVersionNumber (float fTestVersion) |
| Makes sure that the version number of a file passed is between the minimum and current version numbers.
|
|
virtual void | RegisterTreeDataMembers () |
| Registers tree data members.
|
|
virtual void | SetSpeciesTypeCombos (short int iNumCombos, stcSpeciesTypeCombo *p_whatCombos) |
| Sets the species/type combos for a behavior.
|
|
virtual void | SetNameData (char *cNameString) |
| Sets the string for the parameter file behavior.
|
|
virtual short int | GetNewTreeInts () |
| Gets the number of new tree integer data members this behavior wants to register.
|
|
virtual short int | GetNewTreeFloats () |
| Gets the number of new tree float data members this behavior wants to register.
|
|
virtual short int | GetNewTreeChars () |
| Gets the number of new tree character data members this behavior wants to register.
|
|
virtual short int | GetNewTreeBools () |
| Gets the number of new tree bool data members this behavior wants to register.
|
|
virtual short int | GetNumSpeciesTypeCombos () |
| Gets the number of species/type combos to which this behavior applies.
|
|
virtual short int | GetNumBehaviorSpecies () |
| Gets the number of unique tree species to which this behavior applies.
|
|
struct stcSpeciesTypeCombo | GetSpeciesTypeCombo (short int iIndex) |
| Gets one of this behavior's type/species combos.
|
|
virtual short int | GetBehaviorSpecies (short int iIndex) |
| Gets one of the behavior's species.
|
|
short int | GetBehaviorListNumber () |
| Gets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list.
|
|
void | SetBehaviorListNumber (short int iNumber) |
| Sets the behavior list number for this behavior, which differentiates between multiple copies of the behavior in the behavior list.
|
|
virtual DOMElement * | GetParentParametersElement (xercesc::DOMDocument *p_oDoc) |
| Formats the string for species/types query.
|
|
| clWorkerBase (clSimManager *p_oSimManager) |
| Constructor.
|
|
virtual | ~clWorkerBase () |
| Destructor.
|
|
char * | GetName () |
| Gets the object's namestring.
|
|
void | DoObjectSetup (xercesc::DOMDocument *p_oDoc, fileType iFileType) |
| Triggers the setup process.
|
|
virtual void | TimestepCleanup () |
| Performs any necessary cleanup operations at the end of a timestep.
|
|
virtual void | EndOfRunCleanup () |
| Performs any necessary cleanup operations at the end of a run.
|
|
virtual void | DoCommand (char *cCommand, char *cArguments) |
| If a behavior has registered a command line command with the sim manager, this allows it to be called.
|
|
|
void | GetParameterFileData (xercesc::DOMDocument *p_oDoc) |
| Reads values from the parameter file and performs setup related to the parameters.
|
|
void | SetupGrid () |
| Sets up the "Ripley's K" grid and registers the data members.
|
|
void | GetTreeCodes (clTreePopulation *p_oPop) |
| Gets the X and Y tree data codes.
|
|
void | SetUpSearching (clTreePopulation *p_oPop) |
| Sets up the structures for searching controls.
|
|
void | ProcessCell (clTreePopulation *p_oPop, clTree *p_oFirstTree, const int &iX, const int &iY, const int &iNeighX, const int &iNeighY) |
| Processes a neighboring cell's trees to find distance pairs.
|
|
void | ProcessOwnCell (clTree *p_oFirstTree, float *p_fNumTrees, const int &iX, const int &iY) |
| Processes a single cell's trees to find distance pairs.
|
|
|
clGrid * | mp_oGrid |
| Grid holding Ripley's K values for the plot plus each species.
|
|
float ** | mp_fKValues |
| Values holding Ripley's K for each timestep.
|
|
short int ** | mp_iGridCodes |
| Holds the codes for the "Ripley's K" grid.
|
|
short int ** | mp_iXCodes |
| Holds codes for X data member.
|
|
short int ** | mp_iYCodes |
| Holds codes for Y data member.
|
|
bool ** | mp_bCellsSearched |
| Which cells have already been paired the current timestep.
|
|
float * | mp_fIncs |
| Distance increment values - array size is m_iNumIncs.
|
|
float | m_fMaxDistance |
| The max distance to which to calculate Ripley's K.
|
|
float | m_fIncrement |
| The distance increment used to step out to the max distance.
|
|
int | m_iNumIncs |
| Number of increments for which to calculate Ripley's K.
|
|
int | m_iNumXToSearch |
| The number of cells to search in the X direction - if the plot is a rectangle and the search distance is long the distances along the two axes may be different.
|
|
int | m_iNumYToSearch |
| The number of cells to search in the Y direction - if the plot is a rectangle and the search distance is long the distances along the two axes may be different.
|
|
int | m_iNumXCells |
| Number of tree population grid cells in X direction.
|
|
int | m_iNumYCells |
| Number of tree population grid cells in Y direction.
|
|
short int | m_iNumTotalSpecies |
| Total number of species.
|
|
short int | m_iNumSpeciesTypeCombos |
| How many type/species combos a behavior will act on.
|
|
short int | m_iNumBehaviorSpecies |
| How many distinct species are in the combo list - important for filling species-specific values from parameter file.
|
|
short int * | mp_iWhatSpecies |
| List of distinct species - for filling species-specific values from parameter file.
|
|
stcSpeciesTypeCombo * | mp_whatSpeciesTypeCombos |
| Array of species/type combos that the behavior will act on.
|
|
short int | m_iNewTreeInts |
| The number of new tree integer data members this behavior wants to add.
|
|
short int | m_iNewTreeFloats |
| The number of new tree float data members this behavior wants to add.
|
|
short int | m_iNewTreeChars |
| The number of new tree character data members this behavior wants to add.
|
|
short int | m_iNewTreeBools |
| The number of new tree boolean data members this behavior wants to add.
|
|
short int | m_iBehaviorListNumber |
| The number of this behavior in the behavior list, to differentiate between possible multiple copies of this behavior.
|
|
float | m_fVersionNumber |
| Version number - this will be rounded to 2 digits after the decimal place.
|
|
std::string | m_sXMLRoot |
| XML root that encloses the parameters for this behavior.
|
|
float | m_fMinimumVersionNumber |
| Minimum version number - this behavior will run parameter data for a file marked between this number and the current version number, inclusive.
|
|
char | m_cNameString [MAX_NAMESTRING_SIZE] |
| Object's identifying namestring.
|
|
int * | mp_iAllowedFileTypes |
| List of the input file types this object can handle.
|
|
int | m_iNumAllowedTypes |
| Number of input file types this object can handle.
|
|
Ripley's K Calculator Version 1.0.
This behavior calculates Ripley's K. Ripley's K is calculated for successive distances out to a maximum. The user sets the maximum distance and the increment. Ripley's K for a given distance t is calculated as:
K(t) = AX / n
2where A is the area of the plot in square meters, X is the number of pairs of trees <= t meters apart, and n is the total number of trees in the plot. All saplings and adults are counted. All other types are ignored.
When searching for tree pairs it is important to make sure we only find each pair a single time. So the search proceeds by tree population grid cell. For each cell, a square of cells around it is searched. A matrix is used to keep track of which cells have already been paired so they are not paired again.
The statistic is calculated both for all trees and for individual species.
The values are collected into a grid called "Ripley's K".
This class's namestring and parameter file call string are "RipleysK". Any tree type/species assignments are ignored.
Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)
clGrid* clRipleysKCalculator::mp_oGrid |
|
protected |
Grid holding Ripley's K values for the plot plus each species.
The grid name is "Ripley's K". It has one data member for each increment step out to the max for each species, plus one more set for the all-species values. For example, if the max distance is 50 meters and the increment is 1 meter, it will have 50 * (X + 1) data members, where X is the number of species. The names are X_Y, where X is the increment step number (starting at zero) and Y is the species number (starting at zero). It also has two more for the length of distance increment ("inc") and the max distance ("dist"), to make output display easier.
This grid is always one cell per plot. Changes to grid cell resolution are ignored.