clSailLight Class Reference

Sail Light - Version 1.0. More...

#include <SailLight.h>

Inheritance diagram for clSailLight:

clLightBase clBehaviorBase clWorkerBase

List of all members.

Public Member Functions

 clSailLight (clSimManager *p_oSimManager)
 Constructor.
 ~clSailLight ()
 Destructor.
void DoShellSetup (xercesc::DOMDocument *p_oDoc)
 Reads some extra parameters from the parameter file and does setup.
float CalcLightValue (clTree *p_oTree, clTreePopulation *p_oPop)
 Calculates a fraction shade value.

Protected Types

enum  crowndpthequalsheight { yes, no }
 The fraction of shading neighbor height which is assumed to be crown. More...

Protected Member Functions

void AddTreeToSailFishEye (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 sail light calculation.

Protected Attributes

float m_fMaxShadingRadius
 Maximum radius at which trees can shade, in meters.
float * mp_fAltTans
 Tangent of each altitude angle.
enum
clSailLight::crowndpthequalsheight 
m_iCrownDepthEqualsHeight
 The fraction of shading neighbor height which is assumed to be crown.


Detailed Description

Sail Light - Version 1.0.

This calculates the percent shade for a tree using the sail light method. The namestring for this behavior is "saillightshell". The parameter file call string is "saillight".

Copyright 2003 Charles D. Canham.

Author:
Lora E. Murphy

Edit history:
-----------------
April 28, 2004 - Submitted as beta (LEM)

Member Enumeration Documentation

The fraction of shading neighbor height which is assumed to be crown.

Enumerator:
yes  The crown extends the full length of the trunk.
no  The crown has a bottom according to normal allometry equations.


Constructor & Destructor Documentation

clSailLight::clSailLight ( clSimManager p_oSimManager  ) 

Constructor.

Parameters:
p_oSimManager Sim Manager object.

clSailLight::~clSailLight (  )  [inline]

Destructor.


Member Function Documentation

void clSailLight::DoShellSetup ( xercesc::DOMDocument *  p_oDoc  )  [virtual]

Reads some extra parameters from the parameter file and does setup.

Number of azimuth angles and number of altitude angles are required to be present in the "sailLight" tag. The sky brightness array is populated for sail light.

Parameters:
p_oDoc DOM tree of parsed input file.

Reimplemented from clLightBase.

float clSailLight::CalcLightValue ( clTree p_oTree,
clTreePopulation p_oPop 
) [virtual]

Calculates a fraction shade value.

Parameters:
p_oTree Tree for which to calculate the fraction shade.
p_oPop Tree population object.
Returns:
Fraction of shade between 0 and 1.

Implements clLightBase.

void clSailLight::AddTreeToSailFishEye ( const float &  fTargetX,
const float &  fTargetY,
const float &  fTargetHeight,
clTree p_oNeighbor,
clPlot p_oPlot,
clTreePopulation p_oPop,
clAllometry p_oAllom 
) [protected]

Adds one shading neighbor to the fisheye photo array for a sail light calculation.

Parameters:
fTargetX X coordinate of target tree
fTargetY Y coordinate of target tree
fTargetHeight Height of target tree, in meters
p_oNeighbor The neighbor to be added
p_oPlot Pointer to the plot object
p_oPop Pointer to the tree population object
p_oAllom Pointer to an allometry object


Member Data Documentation

Maximum radius at which trees can shade, in meters.

float* clSailLight::mp_fAltTans [protected]

Tangent of each altitude angle.

Array size is 90 (degrees)

The fraction of shading neighbor height which is assumed to be crown.

Crown depth from parameter file


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

Generated on Tue Apr 19 13:56:15 2011 for SORTIE Core C++ Documentation by  doxygen 1.5.6