scriptgrid.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 SCRIPTGRID_H
#define SCRIPTGRID_H
 
 
#include <QObject>
#include <QJSValue>
 
#include "grid.h"
 
class ScriptGrid : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString name READ name WRITE setName)
    Q_PROPERTY(int width READ width)
    Q_PROPERTY(int height READ height)
    Q_PROPERTY(int count READ count)
    Q_PROPERTY(int cellsize READ cellsize)
    Q_PROPERTY(bool isValid READ isValid)
public:
    Q_INVOKABLE ScriptGrid(QObject *parent = nullptr);
    Q_INVOKABLE ScriptGrid(QString fileName): ScriptGrid() {  load(fileName); }
 
    explicit ScriptGrid(Grid<double> *grid) { mVariableName="x"; mGrid = grid; mCreated++; mOwner=true; }
 
    void setGrid(Grid<double> *grid) { mGrid = grid; mOwner=true; }
    void setOwnership(bool should_delete) { mOwner = should_delete; }
    ~ScriptGrid();
    static QJSValue createGrid(Grid<double> *grid, QString name=QString());
 
    QString name() const {return mVariableName;}
    Grid<double> *grid() { return mGrid; }
 
    int width() const { return mGrid?mGrid->sizeX():-1; }
    int height() const { return mGrid?mGrid->sizeY():-1; }
    int count() const { return mGrid?mGrid->count():-1; }
    int cellsize() const { return mGrid?mGrid->cellsize():-1; }
    bool isValid() const { return mGrid?!mGrid->isEmpty():false; }
 
    static void addToScriptEngine(QJSEngine *engine);
signals:
 
public slots:
    bool create(int awidth, int aheight, int acellsize);
 
    void setName(QString arg) { mVariableName = arg; }
    void setOrigin(double x, double y);
    QJSValue copy();
    void clear();
 
    void paint(double min_val, double max_val);
 
    QString info();
 
    void save(QString fileName);
 
    bool load(QString fileName);
 
    void apply(QString expression);
 
    void combine(QString expression, QJSValue grid_object);
 
    QJSValue resample(QJSValue grid_object);
 
    void aggregate(int factor);
 
 
    double sum(QString expression);
 
    void sumTrees(QString expression, QString filter);
 
    double value(int x, int y) const {return (isValid() && mGrid->isIndexValid(x,y)) ? mGrid->valueAtIndex(x,y) : -1.;}
    void setValue(int x, int y, double value) const { if(isValid() && mGrid->isIndexValid(x,y)) mGrid->valueAtIndex(x,y)=value;}
 
    double valueAt(double x, double y) const { return (isValid() && mGrid->coordValid(x,y)) ? mGrid->valueAt(x,y) : -1; }
    void setValueAt(double x, double y, double value) const { if (isValid() && mGrid->coordValid(x,y))  mGrid->valueAt(x,y)=value; }
 
    // coordinate functions
    double metricX(int indexx) const { return isValid() ?  mGrid->cellCenterPoint(QPoint(indexx, 0)).x() : 0.; }
    double metricY(int indexy) const { return isValid() ?  mGrid->cellCenterPoint(QPoint(0, indexy)).y() : 0.; }
    int indexX(double meterx) const { return isValid() ? mGrid->indexAt(QPointF(meterx, 0)).x() : -1; }
    int indexY(double metery) const { return isValid() ? mGrid->indexAt(QPointF(0., metery)).y() : -1; }
    bool isIndexValid(int x, int y) const {return isValid() ? mGrid->isIndexValid(x,y): false; }
    bool isCoordValid(double x, double y) const {return isValid() ? mGrid->coordValid(x, y) : false; }
 
private:
    Grid<double> *mGrid;
    QString mVariableName;
    bool mOwner; // true if grid should be deleted
    static int mCreated;
    static int mDeleted;
};
 
#endif // SCRIPTGRID_H