grasscover.h

Go to the documentation of this file.

/********************************************************************************************
**    iLand - an individual based forest landscape and disturbance model
**    http://iland-model.org
**    Copyright (C) 2009-  Werner Rammer, Rupert Seidl
**
**    This program is free software: you can redistribute it and/or modify
**    it under the terms of the GNU General Public License as published by
**    the Free Software Foundation, either version 3 of the License, or
**    (at your option) any later version.
**
**    This program is distributed in the hope that it will be useful,
**    but WITHOUT ANY WARRANTY; without even the implied warranty of
**    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**    GNU General Public License for more details.
**
**    You should have received a copy of the GNU General Public License
**    along with this program.  If not, see <http://www.gnu.org/licenses/>.
********************************************************************************************/
#ifndef GRASSCOVER_H
#define GRASSCOVER_H
 
#include "expression.h"
#include "grid.h"
#include "layeredgrid.h"
#include "random.h"
 
class GrassCoverLayers; // forwared
 
// define the data type that is used to store the grass-levels
// use unsigned char for 1 byte (or quint8), unsigned short int (quint16) for two bytes per pixel
#define grass_grid_type qint16
 
class GrassCover
{
public:
    GrassCover();
    ~GrassCover();
    void setup();
    // the number of steps used internally
    static const int GRASSCOVERSTEPS = 32000;
 
    void setInitialValues(const QVector<float*> &LIFpixels, const int percent);
 
    void execute();
    void executeAfterRegeneration();
 
    // access
    bool enabled() const { return mEnabled; }
 
    enum GrassAlgorithmType { Invalid, Continuous, Pixel, Simplified };
    GrassAlgorithmType mode() const { return mType; }
 
 
    float lifThreshold() const { return mGrassLIFThreshold; }
    // access values of the underlying grid (for visualization)
    double effect(grass_grid_type level) const { return mEffect[level]; }
    double cover(const grass_grid_type &data) const  {return mType == Pixel? data : data/double(GRASSCOVERSTEPS-1);  }
    // access value for simplified mode
 
 
    double regenerationInhibition(QPoint &lif_index) const {
 
        if (mType==Pixel)
            // -1: off, out of project area, 0: off, ready to get grassy again, 1: off (waiting for LIF threshold), >1 on, counting down
            return mGrid.constValueAtIndex(lif_index)>1 ? 1. : 0.;
 
        // type continuous
        return mEnabled?effect(mGrid.constValueAtIndex(lif_index)) : 0.;
    }
 
    const Grid<grass_grid_type> &grid() { return mGrid; }
private:
 
    GrassAlgorithmType mType;
    bool mEnabled; 
    Expression mGrassPotential; 
    Expression mGrassEffect; 
    int mMaxTimeLag; 
    double mEffect[GRASSCOVERSTEPS]; 
    Grid<grass_grid_type> mGrid; 
    int mGrowthRate; 
    grass_grid_type mMaxState; 
 
    RandomCustomPDF mPDF; 
    float mGrassLIFThreshold; 
    GrassCoverLayers *mLayers; // visualization
};
 
class GrassCoverLayers: public LayeredGrid<grass_grid_type> {
  public:
    void setGrid(const Grid<grass_grid_type> &grid, const GrassCover *gc) { mGrid = &grid; mGrassCover=gc; }
    double value(const grass_grid_type &data, const int index) const;
    const QVector<LayeredGridBase::LayerElement> &names();
private:
    QVector<LayeredGridBase::LayerElement> mNames;
    const GrassCover *mGrassCover;
};
 
#endif // GRASSCOVER_H