1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/analysis/raster/qgsrastercalculator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsRasterCalculatorEntry
{
%Docstring(signature="appended")
Represents an individual raster layer/band number entry within a raster calculation.
.. versionadded:: 2.18
%End
%TypeHeaderCode
#include "qgsrastercalculator.h"
%End
public:
static QVector<QgsRasterCalculatorEntry> rasterEntries();
%Docstring
Creates a list of raster entries from the current project.
If there is more than one layer with the same data source
only one of them is added to the list, duplicate names are
also handled by appending an _n integer to the base name.
:return: the list of raster entries form the current project
.. versionadded:: 3.6
%End
QString ref;
QgsRasterLayer *raster;
int bandNumber;
};
class QgsRasterCalculator
{
%Docstring(signature="appended")
Performs raster layer calculations.
%End
%TypeHeaderCode
#include "qgsrastercalculator.h"
%End
public:
enum Result
{
Success,
CreateOutputError,
InputLayerError,
Canceled,
ParserError,
MemoryError,
BandError,
CalculationError,
};
QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat,
const QgsRectangle &outputExtent, int nOutputColumns, int nOutputRows,
const QVector<QgsRasterCalculatorEntry> &rasterEntries,
const QgsCoordinateTransformContext &transformContext );
%Docstring
QgsRasterCalculator constructor.
:param formulaString: formula for raster calculation
:param outputFile: output file path
:param outputFormat: output file format
:param outputExtent: output extent. CRS for output is taken from first entry in rasterEntries.
:param nOutputColumns: number of columns in output raster
:param nOutputRows: number of rows in output raster
:param rasterEntries: list of referenced raster layers
:param transformContext: coordinate transformation context
.. versionadded:: 3.8
%End
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 );
%Docstring
QgsRasterCalculator constructor.
:param formulaString: formula for raster calculation
:param outputFile: output file path
:param outputFormat: output file format
:param outputExtent: output extent, CRS is specified by outputCrs parameter
:param outputCrs: destination CRS for output raster
:param nOutputColumns: number of columns in output raster
:param nOutputRows: number of rows in output raster
:param rasterEntries: list of referenced raster layers
:param transformContext: coordinate transformation context
.. versionadded:: 3.8
%End
QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat,
const QgsRectangle &outputExtent, int nOutputColumns, int nOutputRows, const QVector<QgsRasterCalculatorEntry> &rasterEntries ) /Deprecated/;
%Docstring
QgsRasterCalculator constructor.
:param formulaString: formula for raster calculation
:param outputFile: output file path
:param outputFormat: output file format
:param outputExtent: output extent. CRS for output is taken from first entry in rasterEntries.
:param nOutputColumns: number of columns in output raster
:param nOutputRows: number of rows in output raster
:param rasterEntries: list of referenced raster layers
.. deprecated:: QGIS 3.8
use the version with transformContext instead
%End
QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat,
const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &outputCrs, int nOutputColumns, int nOutputRows, const QVector<QgsRasterCalculatorEntry> &rasterEntries ) /Deprecated/;
%Docstring
QgsRasterCalculator constructor.
:param formulaString: formula for raster calculation
:param outputFile: output file path
:param outputFormat: output file format
:param outputExtent: output extent, CRS is specified by outputCrs parameter
:param outputCrs: destination CRS for output raster
:param nOutputColumns: number of columns in output raster
:param nOutputRows: number of rows in output raster
:param rasterEntries: list of referenced raster layers
.. deprecated:: QGIS 3.8
use the version with transformContext instead
.. versionadded:: 2.10
%End
Result processCalculation( QgsFeedback *feedback = 0 );
%Docstring
Starts the calculation and writes a new raster.
The optional ``feedback`` argument can be used for progress reporting and cancellation support.
:return: QgsRasterCalculator.Success in case of success. If an error is encountered then
a description of the error can be obtained by calling :py:func:`~QgsRasterCalculator.lastError`.
%End
QString lastError() const;
%Docstring
Returns a description of the last error encountered.
.. versionadded:: 3.4
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/analysis/raster/qgsrastercalculator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|
