qgsrastercalcnode.h

Go to the documentation of this file.

/***************************************************************************
                          qgsrastercalcnode.h
            Node for raster calculator tree
                          --------------------
    begin                : 2010-10-23
    copyright            : (C) 20010 by Marco Hugentobler
    email                : marco dot hugentobler at sourcepole dot ch
***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSRASTERCALCNODE_H
#define QGSRASTERCALCNODE_H
 
#include "qgis.h"
#include "qgis_analysis.h"
#include "qgis_sip.h"
 
#include <QMap>
#include <QString>
#include <QVector>
 
class QgsRasterBlock;
class QgsRasterMatrix;

class ANALYSIS_EXPORT QgsRasterCalcNode
{
  public:
    enum Type
    {
      tOperator = 1,
      tNumber,
      tRasterRef,
      tMatrix,
      tFunction
    };

    enum Operator
    {
      opPLUS,
      opMINUS,
      opMUL,
      opDIV,
      opPOW,
      opSQRT,
      opSIN,
      opCOS,
      opTAN,
      opASIN,
      opACOS,
      opATAN,
      opEQ, // =
      opNE, // !=
      opGT, // >
      opLT, // <
      opGE, // >=
      opLE, // <=
      opAND,
      opOR,
      opSIGN, // change sign
      opLOG,
      opLOG10,
      opABS,
      opMAX,
      opMIN,
      opNONE,
    };
 
    QgsRasterCalcNode() = default;
 
    QgsRasterCalcNode( double number );
    QgsRasterCalcNode( QgsRasterMatrix *matrix );
    QgsRasterCalcNode( Operator op, QgsRasterCalcNode *left, QgsRasterCalcNode *right );
    QgsRasterCalcNode( QString functionName, QVector<QgsRasterCalcNode *> functionArgs );
    QgsRasterCalcNode( const QString &rasterName );
    ~QgsRasterCalcNode();
 
    QgsRasterCalcNode( const QgsRasterCalcNode &rh ) = delete;
    QgsRasterCalcNode &operator=( const QgsRasterCalcNode &rh ) = delete;
 
    Type type() const { return mType; }
 
    //set left node
    void setLeft( QgsRasterCalcNode *left SIP_TRANSFER ) { mLeft.reset( left ); }
    void setRight( QgsRasterCalcNode *right SIP_TRANSFER ) { mRight.reset( right ); }

    bool calculate( QMap<QString, QgsRasterBlock *> &rasterData, QgsRasterMatrix &result, int row = -1 ) const SIP_SKIP;

    QString toString( bool cStyle = false ) const;

    QList<const QgsRasterCalcNode *> findNodes( const QgsRasterCalcNode::Type type ) const;
 
    static QgsRasterCalcNode *parseRasterCalcString( const QString &str, QString &parserErrorMsg ) SIP_FACTORY;

    QStringList referencedLayerNames() const;

    QStringList cleanRasterReferences() const;
 
  private:
#ifdef SIP_RUN
    QgsRasterCalcNode( const QgsRasterCalcNode &rh );
#endif

    QgsRasterMatrix evaluateFunction( const std::vector<std::unique_ptr<QgsRasterMatrix>> &matrixVector, QgsRasterMatrix &result ) const;
 
    Type mType = tNumber;
    std::unique_ptr<QgsRasterCalcNode> mLeft;
    std::unique_ptr<QgsRasterCalcNode> mRight;
    double mNumber = 0;
    QString mRasterName;
    QgsRasterMatrix *mMatrix = nullptr;
    Operator mOperator = opNONE;
    //added for the conditional statement
    QString mFunctionName;
    QVector<QgsRasterCalcNode *> mFunctionArgs;
};
 
 
#endif // QGSRASTERCALCNODE_H