QGIS API Documentation  2.11.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsRasterCalcNode Class Reference

#include <qgsrastercalcnode.h>

Public Types

enum  Operator {
  opPLUS, opMINUS, opMUL, opDIV,
  opPOW, opSQRT, opSIN, opCOS,
  opTAN, opASIN, opACOS, opATAN,
  opEQ, opNE, opGT, opLT,
  opGE, opLE, opAND, opOR,
  opSIGN, opLOG, opLOG10, opNONE
}
 possible operators More...
 
enum  Type { tOperator = 1, tNumber, tRasterRef, tMatrix }
 defines possible types of node More...
 

Public Member Functions

 QgsRasterCalcNode ()
 
 QgsRasterCalcNode (double number)
 
 QgsRasterCalcNode (QgsRasterMatrix *matrix)
 
 QgsRasterCalcNode (Operator op, QgsRasterCalcNode *left, QgsRasterCalcNode *right)
 
 QgsRasterCalcNode (const QString &rasterName)
 
 ~QgsRasterCalcNode ()
 
bool calculate (QMap< QString, QgsRasterBlock * > &rasterData, QgsRasterMatrix &result, int row=-1) const
 Calculates result of raster calculation (might be real matrix or single number). More...
 
Q_DECL_DEPRECATED bool calculate (QMap< QString, QgsRasterMatrix * > &rasterData, QgsRasterMatrix &result) const
 
void setLeft (QgsRasterCalcNode *left)
 
void setRight (QgsRasterCalcNode *right)
 
Type type () const
 

Static Public Member Functions

static QgsRasterCalcNodeparseRasterCalcString (const QString &str, QString &parserErrorMsg)
 

Detailed Description

Definition at line 28 of file qgsrastercalcnode.h.

Member Enumeration Documentation

possible operators

Enumerator
opPLUS 
opMINUS 
opMUL 
opDIV 
opPOW 
opSQRT 
opSIN 
opCOS 
opTAN 
opASIN 
opACOS 
opATAN 
opEQ 
opNE 
opGT 

=

opLT 
opGE 
opLE 
opAND 
opOR 
opSIGN 
opLOG 
opLOG10 
opNONE 

Definition at line 41 of file qgsrastercalcnode.h.

defines possible types of node

Enumerator
tOperator 
tNumber 
tRasterRef 
tMatrix 

Definition at line 32 of file qgsrastercalcnode.h.

Constructor & Destructor Documentation

QgsRasterCalcNode::QgsRasterCalcNode ( )

Definition at line 19 of file qgsrastercalcnode.cpp.

QgsRasterCalcNode::QgsRasterCalcNode ( double  number)

Definition at line 29 of file qgsrastercalcnode.cpp.

QgsRasterCalcNode::QgsRasterCalcNode ( QgsRasterMatrix matrix)

Definition at line 39 of file qgsrastercalcnode.cpp.

QgsRasterCalcNode::QgsRasterCalcNode ( Operator  op,
QgsRasterCalcNode left,
QgsRasterCalcNode right 
)

Definition at line 50 of file qgsrastercalcnode.cpp.

QgsRasterCalcNode::QgsRasterCalcNode ( const QString rasterName)

Definition at line 60 of file qgsrastercalcnode.cpp.

QgsRasterCalcNode::~QgsRasterCalcNode ( )

Definition at line 73 of file qgsrastercalcnode.cpp.

Member Function Documentation

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

Calculates result of raster calculation (might be real matrix or single number).

Parameters
rasterDatainput raster data references, map of raster name to raster data block
resultdestination raster matrix for calculation results
rowoptional row number to calculate for calculating result by rows, or -1 to calculate entire result
Note
added in QGIS 2.10
not available in Python bindings

Definition at line 107 of file qgsrastercalcnode.cpp.

bool QgsRasterCalcNode::calculate ( QMap< QString, QgsRasterMatrix * > &  rasterData,
QgsRasterMatrix result 
) const
Deprecated:
use method which accepts QgsRasterBlocks instead

Definition at line 85 of file qgsrastercalcnode.cpp.

QgsRasterCalcNode * QgsRasterCalcNode::parseRasterCalcString ( const QString str,
QString parserErrorMsg 
)
static

Definition at line 255 of file qgsrastercalcnode.cpp.

void QgsRasterCalcNode::setLeft ( QgsRasterCalcNode left)
inline

Definition at line 79 of file qgsrastercalcnode.h.

void QgsRasterCalcNode::setRight ( QgsRasterCalcNode right)
inline

Definition at line 80 of file qgsrastercalcnode.h.

Type QgsRasterCalcNode::type ( ) const
inline

Definition at line 76 of file qgsrastercalcnode.h.


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