Raster calculator class. More...

Public Types
enum	Result { Success = 0, CreateOutputError = 1, InputLayerError = 2, Canceled = 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 (QgsFeedback *feedback=nullptr)
	Starts the calculation and writes a new raster. More...

Detailed Description

Raster calculator class.

Definition at line 49 of file qgsrastercalculator.h.

Member Enumeration Documentation

Result of the calculation.

Enumerator
Success	Calculation successful.
CreateOutputError	Error creating output data file.
InputLayerError	Error reading input layer.
Canceled	User canceled calculation.
ParserError	Error parsing formula.
MemoryError	Error allocating memory for result.

Definition at line 54 of file qgsrastercalculator.h.

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

Parameters

formulaString	formula for raster calculation
outputFile	output file path
outputFormat	output file format
outputExtent	output extent. CRS for output is taken from first entry in rasterEntries.
nOutputColumns	number of columns in output raster
nOutputRows	number of rows in output raster
rasterEntries	list of referenced raster layers

Definition at line 33 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
	)

Parameters

formulaString	formula for raster calculation
outputFile	output file path
outputFormat	output file format
outputExtent	output extent, CRS is specified by outputCrs parameter
outputCrs	destination CRS for output raster
nOutputColumns	number of columns in output raster
nOutputRows	number of rows in output raster
rasterEntries	list of referenced raster layers

Definition at line 47 of file qgsrastercalculator.cpp.

int QgsRasterCalculator::processCalculation ( QgsFeedback * feedback = nullptr )

Starts the calculation and writes a new raster.

The optional feedback argument can be used for progress reporting and cancelation support.

Definition at line 60 of file qgsrastercalculator.cpp.

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