|
SORTIE Core C++ Documentation
|
GLI Light - Version 1.0. More...
#include <GLILight.h>
Public Member Functions | |
| clGliLight (clSimManager *p_oSimManager) | |
| Constructor. | |
| void | DoShellSetup (xercesc::DOMDocument *p_oDoc) |
| Reads some extra parameters from the parameter file. | |
| float | CalcLightValue (clTree *p_oTree, clTreePopulation *p_oPop) |
| Calculates a GLI value. | |
Public Member Functions inherited from clGLIBase | |
| clGLIBase (clSimManager *p_oSimManager) | |
| Constructor. | |
| virtual | ~clGLIBase () |
| Destructor. | |
Public Member Functions inherited from clLightBase | |
| clLightBase (clSimManager *p_oSimManager) | |
| Constructor. | |
| virtual | ~clLightBase () |
| Destructor. | |
| void | Action () |
| Performs all light calculations. | |
| void | RegisterTreeDataMembers () |
| Performs data member registrations for "Light". | |
| clLightOrg * | GetLightOrg () |
| Gets the light org object. | |
Public Member Functions inherited from clBehaviorBase | |
| 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 | 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. | |
Public Member Functions inherited from clWorkerBase | |
| 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. | |
Public Attributes | |
| clLightOrg::fotocrowndpth | m_iPhotoDepth |
| Depth of fisheye photo in tree. | |
Additional Inherited Members | |
Protected Member Functions inherited from clGLIBase | |
| void | AddTreeToGliFishEye (const float &fTargetX, const float &fTargetY, const float &fTargetHeight, clTree *p_oNeighbor, clPlot *p_oPlot, clTreePopulation *p_oPop, clAllometry *p_oAllom) |
| Adds one shading neighbor to the fisheye photo array for a GLI calculation. | |
| void | GLIFisheyeNoCanopyIntersect (const float &fTargetX, const float &fTargetY, const float &fNeighX, const float &fNeighY, const float &fNeighCanrad, const float &fNeighHeight, const short int &iNeighSpecies, const float &fTargetHeight, const float &fDistToNearEdge, clTree *p_oNeighbor, clPlot *p_oPlot, clAllometry *p_oAllom) |
| Adds one shading neighbor to the fisheye photo array for a GLI calculation when the canopies of the two trees do not overlap. | |
| void | GLIFisheyeCanopyIntersect (const float &fTargetX, const float &fTargetY, const float &fNeighX, const float &fNeighY, const float &fNeighCanrad, const float &fNeighHeight, const short int &iNeighSpecies, const float &fTargetHeight, clTree *p_oNeighbor, clPlot *p_oPlot, clAllometry *p_oAllom) |
| Adds one shading neighbor to the fisheye photo array for a GLI calculation when the canopies of the two trees overlap. | |
Protected Attributes inherited from clGLIBase | |
| float | m_fSinMinSunAng |
| Sin of the min sun angle. | |
| float | m_fAziChunkConverter |
| Reciprocal of the size of a single azimuth sky grid division, in degrees. | |
| float | m_fRcpTanMinAng |
| 1/tan (m_fMinSunAngle). | |
| float * | mp_fAziSlope |
| For each azimuth chunk of sky, this holds the slope of the line to the middle of the chunk. | |
Static Protected Attributes inherited from clLightBase | |
| static clLightOrg * | mp_oLightOrg |
| clLightOrg object - this pointer is held in common by all shells | |
GLI Light - Version 1.0.
This calculates a GLI (global light index) for a tree. The namestring for this behavior is "glilightshell". The parameter file call string is "GLILight".
The sky brightness array used by this behavior is potentially identical to that for quadrat-based GLI light - class name clQuadratGliLight, namestring "quadratglilightshell". Before committing to the calculation of a brightness array, this behavior will ask that behavior if it's already done it and this behavior can just copy.
Copyright 2011 Charles D. Canham.
Edit history:
--------------—
October 20, 2011 - Wiped the slate clean for SORTIE 7.0 (LEM)
| clGliLight::clGliLight | ( | clSimManager * | p_oSimManager | ) |
Constructor.
The constructor will set the namestring.
| p_oSimManager | Sim manager. |
|
virtual |
Calculates a GLI value.
| p_oTree | Tree for which to calculate GLI. |
| p_oPop | Pointer to the tree population object. |
Implements clLightBase.
|
virtual |
Reads some extra parameters from the parameter file.
Number of azimuth angles and number of altitude angles are required to be present in the "glilight" tag.
| p_oDoc | DOM tree of parsed parameter file. |
Reimplemented from clLightBase.
| clLightOrg::fotocrowndpth clGliLight::m_iPhotoDepth |
Depth of fisheye photo in tree.
Defaults to top of crown, and thus is not required in the parameter file. Old parameter fotodepth
1.8.2