Performs raster layer calculations. More...

#include <qgsrastercalculator.h>

Public Types
enum	Result { Success = 0 , CreateOutputError = 1 , InputLayerError = 2 , Canceled = 3 , ParserError = 4 , MemoryError = 5 , BandError = 6 , CalculationError = 7 }
	Result of the calculation. More...

Public Member Functions
Q_DECL_DEPRECATED	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...

	QgsRasterCalculator (const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &outputCrs, int nOutputColumns, int nOutputRows, const QVector< QgsRasterCalculatorEntry > &rasterEntries, const QgsCoordinateTransformContext &transformContext)
	QgsRasterCalculator constructor. More...

Q_DECL_DEPRECATED	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, int nOutputColumns, int nOutputRows, const QVector< QgsRasterCalculatorEntry > &rasterEntries, const QgsCoordinateTransformContext &transformContext)
	QgsRasterCalculator constructor. More...

QString	lastError () const
	Returns a description of the last error encountered. More...

Result	processCalculation (QgsFeedback *feedback=nullptr)
	Starts the calculation and writes a new raster. More...

Detailed Description

Performs raster layer calculations.

Definition at line 76 of file qgsrastercalculator.h.

Member Enumeration Documentation

◆ Result

enum QgsRasterCalculator::Result

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.
BandError	Invalid band number for input.
CalculationError	Error occurred while performing calculation.

Definition at line 81 of file qgsrastercalculator.h.

Constructor & Destructor Documentation

◆ QgsRasterCalculator() [1/4]

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

QgsRasterCalculator constructor.

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
transformContext	coordinate transformation context

Since: QGIS 3.8

Definition at line 39 of file qgsrastercalculator.cpp.

◆ QgsRasterCalculator() [2/4]

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,
		const QgsCoordinateTransformContext &	transformContext
	)

QgsRasterCalculator constructor.

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
transformContext	coordinate transformation context

Since: QGIS 3.8

Definition at line 52 of file qgsrastercalculator.cpp.

◆ QgsRasterCalculator() [3/4]

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

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

Deprecated:: since QGIS 3.8, use the version with transformContext instead

Definition at line 69 of file qgsrastercalculator.cpp.

◆ QgsRasterCalculator() [4/4]

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

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

Deprecated:: since QGIS 3.8, use the version with transformContext instead

Since: QGIS 2.10

Definition at line 86 of file qgsrastercalculator.cpp.

Member Function Documentation

◆ lastError()

QString QgsRasterCalculator::lastError ( ) const

Returns a description of the last error encountered.

Since: QGIS 3.4

Definition at line 688 of file qgsrastercalculator.cpp.

◆ processCalculation()

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

Starts the calculation and writes a new raster.

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

Returns: QgsRasterCalculator::Success in case of success. If an error is encountered then a description of the error can be obtained by calling lastError().

Definition at line 100 of file qgsrastercalculator.cpp.

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

/build/qgis-3.18.1+99unstable/src/analysis/raster/qgsrastercalculator.h
/build/qgis-3.18.1+99unstable/src/analysis/raster/qgsrastercalculator.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Result

Constructor & Destructor Documentation

◆ QgsRasterCalculator() [1/4]

◆ QgsRasterCalculator() [2/4]

◆ QgsRasterCalculator() [3/4]

◆ QgsRasterCalculator() [4/4]

Member Function Documentation

◆ lastError()

◆ processCalculation()