iLand
Public Member Functions | Public Attributes | List of all members
HeightGridValue Struct Reference

#include <model.h>

Public Member Functions

int count () const
 get count of trees on pixel More...
 
void increaseCount ()
 increase the number of trees on pixel More...
 
void resetCount ()
 set the count to 0 More...
 
bool isValid () const
 a value of 1: not valid (returns false). More...
 
void setValid (const bool valid)
 set bit to 1: pixel is not valid More...
 
void setForestOutside (const bool is_outside)
 
bool isForestOutside () const
 true if a pixel is outside of the project area but considered as forested More...
 
void setIsRadiating ()
 bit 18: if set, the pixel is actively radiating influence on the LIF (such pixels are on the edge of "forestOutside") More...
 
bool isRadiating () const
 
float stemHeight () const
 get the (coarse, 1m classes) local height (only trees with the stem on the cell are counted here) More...
 
void clearStemHeight ()
 reset the stem height More...
 
void setStemHeight (float h)
 set the height of the tree local (i.e. the stem of the tree is on the pixel); compare to the 'height': here also crowns can spread to neighboring cells. More...
 
void init (const float aheight, const int acount)
 set values for height and count (this overwrites all the flags!) More...
 

Public Attributes

float height
 dominant tree height (m) More...
 

Member Function Documentation

◆ clearStemHeight()

void HeightGridValue::clearStemHeight ( )
inline

reset the stem height

◆ count()

int HeightGridValue::count ( ) const
inline

get count of trees on pixel

◆ increaseCount()

void HeightGridValue::increaseCount ( )
inline

increase the number of trees on pixel

◆ init()

void HeightGridValue::init ( const float  aheight,
const int  acount 
)
inline

set values for height and count (this overwrites all the flags!)

◆ isForestOutside()

bool HeightGridValue::isForestOutside ( ) const
inline

true if a pixel is outside of the project area but considered as forested

◆ isRadiating()

bool HeightGridValue::isRadiating ( ) const
inline

◆ isValid()

bool HeightGridValue::isValid ( ) const
inline

a value of 1: not valid (returns false).

true: pixel is stockable and within the project area. false: pixel is not stockable (outside of the project area or a non-stockable pixel within the project area)

◆ resetCount()

void HeightGridValue::resetCount ( )
inline

set the count to 0

◆ setForestOutside()

void HeightGridValue::setForestOutside ( const bool  is_outside)
inline

◆ setIsRadiating()

void HeightGridValue::setIsRadiating ( )
inline

bit 18: if set, the pixel is actively radiating influence on the LIF (such pixels are on the edge of "forestOutside")

◆ setStemHeight()

void HeightGridValue::setStemHeight ( float  h)
inline

set the height of the tree local (i.e. the stem of the tree is on the pixel); compare to the 'height': here also crowns can spread to neighboring cells.

◆ setValid()

void HeightGridValue::setValid ( const bool  valid)
inline

set bit to 1: pixel is not valid

◆ stemHeight()

float HeightGridValue::stemHeight ( ) const
inline

get the (coarse, 1m classes) local height (only trees with the stem on the cell are counted here)

Member Data Documentation

◆ height

float HeightGridValue::height

dominant tree height (m)


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