QGIS API Documentation  2.15.0-Master (94d88e6)
Public Types | Public Member Functions | List of all members
QgsRasterCalculator Class Reference

Raster calculator class. More...

#include <qgsrastercalculator.h>

Public Types

enum  Result {
  Success = 0, CreateOutputError = 1, InputLayerError = 2, Cancelled = 3,
  ParserError = 4, MemoryError = 5
}
 Result of the calculation. More...
 

Public Member Functions

 QgsRasterCalculator (const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, int nOutputColumns, int nOutputRows, const QVector< QgsRasterCalculatorEntry > &rasterEntries)
 QgsRasterCalculator constructor. More...
 
 QgsRasterCalculator (const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &outputCrs, int nOutputColumns, int nOutputRows, const QVector< QgsRasterCalculatorEntry > &rasterEntries)
 QgsRasterCalculator constructor. More...
 
int processCalculation (QProgressDialog *p=nullptr)
 Starts the calculation and writes new raster. More...
 

Detailed Description

Raster calculator class.

Definition at line 40 of file qgsrastercalculator.h.

Member Enumeration Documentation

Result of the calculation.

Enumerator
Success 

Calculation sucessful

CreateOutputError 

Error creating output data file

InputLayerError 

Error reading input layer

Cancelled 

User cancelled calculation

ParserError 

Error parsing formula

MemoryError 

Error allocating memory for result

Definition at line 45 of file qgsrastercalculator.h.

Constructor & Destructor Documentation

QgsRasterCalculator::QgsRasterCalculator ( const QString formulaString,
const QString outputFile,
const QString outputFormat,
const QgsRectangle outputExtent,
int  nOutputColumns,
int  nOutputRows,
const QVector< QgsRasterCalculatorEntry > &  rasterEntries 
)

QgsRasterCalculator constructor.

Parameters
formulaStringformula for raster calculation
outputFileoutput file path
outputFormatoutput file format
outputExtentoutput extent. CRS for output is taken from first entry in rasterEntries.
nOutputColumnsnumber of columns in output raster
nOutputRowsnumber of rows in output raster
rasterEntrieslist of referenced raster layers

Definition at line 37 of file qgsrastercalculator.cpp.

QgsRasterCalculator::QgsRasterCalculator ( const QString formulaString,
const QString outputFile,
const QString outputFormat,
const QgsRectangle outputExtent,
const QgsCoordinateReferenceSystem outputCrs,
int  nOutputColumns,
int  nOutputRows,
const QVector< QgsRasterCalculatorEntry > &  rasterEntries 
)

QgsRasterCalculator constructor.

Parameters
formulaStringformula for raster calculation
outputFileoutput file path
outputFormatoutput file format
outputExtentoutput extent, CRS is specified by outputCrs parameter
outputCrsdestination CRS for output raster
nOutputColumnsnumber of columns in output raster
nOutputRowsnumber of rows in output raster
rasterEntrieslist of referenced raster layers
Note
added in QGIS 2.10

Definition at line 51 of file qgsrastercalculator.cpp.

Member Function Documentation

int QgsRasterCalculator::processCalculation ( QProgressDialog p = nullptr)

Starts the calculation and writes new raster.

Parameters
pprogress bar (or 0 if called from non-gui code)
Returns
0 in case of success

Definition at line 64 of file qgsrastercalculator.cpp.


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