QgsRasterCalculator Class Reference

Performs raster layer calculations. More...

#include <qgsrastercalculator.h>

Public Types
enum class	Result : int {   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.
	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.
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.
	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.
QStringList	creationOptions () const
	Returns the list of data source creation options which will be used when creating the output raster file.
QString	lastError () const
	Returns a description of the last error encountered.
double	noDataValue () const
	Returns no data value used for output file.
Result	processCalculation (QgsFeedback *feedback=nullptr)
	Starts the calculation and writes a new raster.
void	setCreationOptions (const QStringList &options)
	Sets a list of data source creation options to use when creating the output raster file.
void	setNoDataValue (double noDataValue)
	Set no data value for output file.

Detailed Description

Performs raster layer calculations.

Definition at line 74 of file qgsrastercalculator.h.

Member Enumeration Documentation

Result

enum class QgsRasterCalculator::Result : int

strong

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 78 of file qgsrastercalculator.h.

Constructor & Destructor Documentation

QgsRasterCalculator() [1/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 89 of file qgsrastercalculator.cpp.

QgsRasterCalculator() [2/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 72 of file qgsrastercalculator.cpp.

QgsRasterCalculator() [3/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:

QGIS 3.8. Use the version with transformContext instead.

Definition at line 122 of file qgsrastercalculator.cpp.

QgsRasterCalculator() [4/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:

QGIS 3.8. Use the version with transformContext instead.

Definition at line 103 of file qgsrastercalculator.cpp.

Member Function Documentation

creationOptions()

QStringList QgsRasterCalculator::creationOptions ( ) const

inline

Returns the list of data source creation options which will be used when creating the output raster file.

See also

setCreationOptions()

Since

QGIS 3.44

Definition at line 177 of file qgsrastercalculator.h.

lastError()

QString QgsRasterCalculator::lastError

(

)

const

Returns a description of the last error encountered.

Since

QGIS 3.4

Definition at line 724 of file qgsrastercalculator.cpp.

noDataValue()

double QgsRasterCalculator::noDataValue ( ) const

inline

Returns no data value used for output file.

See also

setNoDataValue()

Since

QGIS 3.44

Definition at line 193 of file qgsrastercalculator.h.

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::Result::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 135 of file qgsrastercalculator.cpp.

setCreationOptions()

void QgsRasterCalculator::setCreationOptions ( const QStringList &  options )

inline

Sets a list of data source creation options to use when creating the output raster file.

See also

creationOptions()

Since

QGIS 3.44

Definition at line 169 of file qgsrastercalculator.h.

setNoDataValue()

void QgsRasterCalculator::setNoDataValue ( double  noDataValue )

inline

Set no data value for output file.

See also

noDataValue()

Since

QGIS 3.44

Definition at line 185 of file qgsrastercalculator.h.

---

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

• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/analysis/raster/qgsrastercalculator.h
• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/analysis/raster/qgsrastercalculator.cpp