iLand
Public Types | Public Member Functions | Static Public Attributes | List of all members
GrassCover Class Reference

The GrassCover class specifies the limiting effect of ground vegetation (grasses, herbs) on the regeneration success of the tree species. More...

#include <grasscover.h>

Public Types

enum  GrassAlgorithmType { Invalid , Continuous , Pixel , Simplified }
 used algorithm More...
 

Public Member Functions

 GrassCover ()
 
 ~GrassCover ()
 
void setup ()
 
void setInitialValues (const QVector< float * > &LIFpixels, const int percent)
 set for all the pixels (LIFPixels) the corresponding grass value (in percent: 0-100) More...
 
void execute ()
 main function (growth/die-off of grass cover) More...
 
void executeAfterRegeneration ()
 function called after the regeneration module More...
 
bool enabled () const
 returns 'true' if the module is enabled More...
 
GrassAlgorithmType mode () const
 
float lifThreshold () const
 
double effect (grass_grid_type level) const
 
double cover (const grass_grid_type &data) const
 
double regenerationInhibition (QPoint &lif_index) const
 main function More...
 
const Grid< grass_grid_type > & grid ()
 retrieve the grid of current grass cover More...
 

Static Public Attributes

static const int GRASSCOVERSTEPS = 32000
 

Detailed Description

The GrassCover class specifies the limiting effect of ground vegetation (grasses, herbs) on the regeneration success of the tree species.

The GrassCover model is very simple and operates on a 2x2m grain.

Member Enumeration Documentation

◆ GrassAlgorithmType

used algorithm

Enumerator
Invalid 
Continuous 
Pixel 
Simplified 

Constructor & Destructor Documentation

◆ GrassCover()

GrassCover::GrassCover ( )

◆ ~GrassCover()

GrassCover::~GrassCover ( )

Member Function Documentation

◆ cover()

double GrassCover::cover ( const grass_grid_type data) const
inline

◆ effect()

double GrassCover::effect ( grass_grid_type  level) const
inline

◆ enabled()

bool GrassCover::enabled ( ) const
inline

returns 'true' if the module is enabled

◆ execute()

void GrassCover::execute ( )

main function (growth/die-off of grass cover)

◆ executeAfterRegeneration()

void GrassCover::executeAfterRegeneration ( )

function called after the regeneration module

◆ grid()

const Grid< grass_grid_type > & GrassCover::grid ( )
inline

retrieve the grid of current grass cover

◆ lifThreshold()

float GrassCover::lifThreshold ( ) const
inline

◆ mode()

GrassAlgorithmType GrassCover::mode ( ) const
inline

◆ regenerationInhibition()

double GrassCover::regenerationInhibition ( QPoint &  lif_index) const
inline

main function

◆ setInitialValues()

void GrassCover::setInitialValues ( const QVector< float * > &  LIFpixels,
const int  percent 
)

set for all the pixels (LIFPixels) the corresponding grass value (in percent: 0-100)

◆ setup()

void GrassCover::setup ( )

Member Data Documentation

◆ GRASSCOVERSTEPS

const int GrassCover::GRASSCOVERSTEPS = 32000
static

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