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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
|
"""
***************************************************************************
ClipRasterByMask.py
---------------------
Date : September 2013
Copyright : (C) 2013 by Alexander Bruy
Email : alexander bruy at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************
"""
__author__ = "Alexander Bruy"
__date__ = "September 2013"
__copyright__ = "(C) 2013, Alexander Bruy"
import os
from qgis.PyQt.QtGui import QIcon
from qgis.core import (
QgsRasterFileWriter,
QgsProcessing,
QgsProcessingException,
QgsProcessingParameterDefinition,
QgsProcessingParameterFeatureSource,
QgsProcessingParameterRasterLayer,
QgsProcessingParameterCrs,
QgsProcessingParameterEnum,
QgsProcessingParameterExtent,
QgsProcessingParameterString,
QgsProcessingParameterNumber,
QgsProcessingParameterBoolean,
QgsProcessingParameterRasterDestination,
)
from processing.algs.gdal.GdalAlgorithm import GdalAlgorithm
from processing.algs.gdal.GdalUtils import GdalUtils
pluginPath = os.path.split(os.path.split(os.path.dirname(__file__))[0])[0]
class ClipRasterByMask(GdalAlgorithm):
INPUT = "INPUT"
MASK = "MASK"
SOURCE_CRS = "SOURCE_CRS"
TARGET_CRS = "TARGET_CRS"
EXTENT = "TARGET_EXTENT"
NODATA = "NODATA"
ALPHA_BAND = "ALPHA_BAND"
CROP_TO_CUTLINE = "CROP_TO_CUTLINE"
KEEP_RESOLUTION = "KEEP_RESOLUTION"
SET_RESOLUTION = "SET_RESOLUTION"
X_RESOLUTION = "X_RESOLUTION"
Y_RESOLUTION = "Y_RESOLUTION"
OPTIONS = "OPTIONS"
DATA_TYPE = "DATA_TYPE"
MULTITHREADING = "MULTITHREADING"
EXTRA = "EXTRA"
OUTPUT = "OUTPUT"
def __init__(self):
super().__init__()
def initAlgorithm(self, config=None):
self.TYPES = [
self.tr("Use Input Layer Data Type"),
"Byte",
"Int16",
"UInt16",
"UInt32",
"Int32",
"Float32",
"Float64",
"CInt16",
"CInt32",
"CFloat32",
"CFloat64",
"Int8",
]
self.addParameter(
QgsProcessingParameterRasterLayer(self.INPUT, self.tr("Input layer"))
)
self.addParameter(
QgsProcessingParameterFeatureSource(
self.MASK,
self.tr("Mask layer"),
[QgsProcessing.SourceType.TypeVectorPolygon],
)
)
self.addParameter(
QgsProcessingParameterCrs(
self.SOURCE_CRS, self.tr("Source CRS"), optional=True
)
)
self.addParameter(
QgsProcessingParameterCrs(
self.TARGET_CRS, self.tr("Target CRS"), optional=True
)
)
self.addParameter(
QgsProcessingParameterExtent(
self.EXTENT, self.tr("Target extent"), optional=True
)
)
self.addParameter(
QgsProcessingParameterNumber(
self.NODATA,
self.tr("Assign a specified NoData value to output bands"),
type=QgsProcessingParameterNumber.Type.Double,
defaultValue=None,
optional=True,
)
)
self.addParameter(
QgsProcessingParameterBoolean(
self.ALPHA_BAND,
self.tr("Create an output alpha band"),
defaultValue=False,
)
)
self.addParameter(
QgsProcessingParameterBoolean(
self.CROP_TO_CUTLINE,
self.tr(
"Match the extent of the clipped raster to the extent of the mask layer"
),
defaultValue=True,
)
)
self.addParameter(
QgsProcessingParameterBoolean(
self.KEEP_RESOLUTION,
self.tr("Keep resolution of input raster"),
defaultValue=False,
)
)
self.addParameter(
QgsProcessingParameterBoolean(
self.SET_RESOLUTION,
self.tr("Set output file resolution"),
defaultValue=False,
)
)
self.addParameter(
QgsProcessingParameterNumber(
self.X_RESOLUTION,
self.tr("X Resolution to output bands"),
type=QgsProcessingParameterNumber.Type.Double,
defaultValue=None,
optional=True,
)
)
self.addParameter(
QgsProcessingParameterNumber(
self.Y_RESOLUTION,
self.tr("Y Resolution to output bands"),
type=QgsProcessingParameterNumber.Type.Double,
defaultValue=None,
optional=True,
)
)
multithreading_param = QgsProcessingParameterBoolean(
self.MULTITHREADING,
self.tr("Use multithreaded warping implementation"),
defaultValue=False,
)
multithreading_param.setFlags(
multithreading_param.flags()
| QgsProcessingParameterDefinition.Flag.FlagAdvanced
)
self.addParameter(multithreading_param)
options_param = QgsProcessingParameterString(
self.OPTIONS,
self.tr("Additional creation options"),
defaultValue="",
optional=True,
)
options_param.setFlags(
options_param.flags() | QgsProcessingParameterDefinition.Flag.FlagAdvanced
)
options_param.setMetadata({"widget_wrapper": {"widget_type": "rasteroptions"}})
self.addParameter(options_param)
dataType_param = QgsProcessingParameterEnum(
self.DATA_TYPE,
self.tr("Output data type"),
self.TYPES,
allowMultiple=False,
defaultValue=0,
)
dataType_param.setFlags(
dataType_param.flags() | QgsProcessingParameterDefinition.Flag.FlagAdvanced
)
self.addParameter(dataType_param)
extra_param = QgsProcessingParameterString(
self.EXTRA,
self.tr("Additional command-line parameters"),
defaultValue=None,
optional=True,
)
extra_param.setFlags(
extra_param.flags() | QgsProcessingParameterDefinition.Flag.FlagAdvanced
)
self.addParameter(extra_param)
self.addParameter(
QgsProcessingParameterRasterDestination(
self.OUTPUT, self.tr("Clipped (mask)")
)
)
def name(self):
return "cliprasterbymasklayer"
def displayName(self):
return self.tr("Clip raster by mask layer")
def icon(self):
return QIcon(os.path.join(pluginPath, "images", "gdaltools", "raster-clip.png"))
def group(self):
return self.tr("Raster extraction")
def groupId(self):
return "rasterextraction"
def commandName(self):
return "gdalwarp"
def getConsoleCommands(self, parameters, context, feedback, executing=True):
inLayer = self.parameterAsRasterLayer(parameters, self.INPUT, context)
if inLayer is None:
raise QgsProcessingException(
self.invalidRasterError(parameters, self.INPUT)
)
input_details = GdalUtils.gdal_connection_details_from_layer(inLayer)
mask_details = self.getOgrCompatibleSource(
self.MASK, parameters, context, feedback, executing
)
sourceCrs = self.parameterAsCrs(parameters, self.SOURCE_CRS, context)
targetCrs = self.parameterAsCrs(parameters, self.TARGET_CRS, context)
bbox = self.parameterAsExtent(parameters, self.EXTENT, context)
bboxCrs = self.parameterAsExtentCrs(parameters, self.EXTENT, context)
if self.NODATA in parameters and parameters[self.NODATA] is not None:
nodata = self.parameterAsDouble(parameters, self.NODATA, context)
else:
nodata = None
options = self.parameterAsString(parameters, self.OPTIONS, context)
out = self.parameterAsOutputLayer(parameters, self.OUTPUT, context)
self.setOutputValue(self.OUTPUT, out)
arguments = ["-overwrite"]
if sourceCrs.isValid():
arguments.append("-s_srs")
arguments.append(GdalUtils.gdal_crs_string(sourceCrs))
if targetCrs.isValid():
arguments.append("-t_srs")
arguments.append(GdalUtils.gdal_crs_string(targetCrs))
if not bbox.isNull():
arguments.append("-te")
arguments.append(str(bbox.xMinimum()))
arguments.append(str(bbox.yMinimum()))
arguments.append(str(bbox.xMaximum()))
arguments.append(str(bbox.yMaximum()))
arguments.append("-te_srs")
arguments.append(GdalUtils.gdal_crs_string(bboxCrs))
data_type = self.parameterAsEnum(parameters, self.DATA_TYPE, context)
if data_type:
if self.TYPES[data_type] == "Int8" and GdalUtils.version() < 3070000:
raise QgsProcessingException(
self.tr("Int8 data type requires GDAL version 3.7 or later")
)
arguments.append("-ot " + self.TYPES[data_type])
output_format = QgsRasterFileWriter.driverForExtension(os.path.splitext(out)[1])
if not output_format:
raise QgsProcessingException(self.tr("Output format is invalid"))
arguments.append("-of")
arguments.append(output_format)
if self.parameterAsBoolean(parameters, self.KEEP_RESOLUTION, context):
arguments.append("-tr")
arguments.append(str(inLayer.rasterUnitsPerPixelX()))
arguments.append(str(-inLayer.rasterUnitsPerPixelY()))
arguments.append("-tap")
if self.parameterAsBoolean(parameters, self.SET_RESOLUTION, context):
arguments.append("-tr")
if (
self.X_RESOLUTION in parameters
and parameters[self.X_RESOLUTION] is not None
):
xres = self.parameterAsDouble(parameters, self.X_RESOLUTION, context)
arguments.append(f"{xres}")
else:
arguments.append(str(inLayer.rasterUnitsPerPixelX()))
if (
self.Y_RESOLUTION in parameters
and parameters[self.Y_RESOLUTION] is not None
):
yres = self.parameterAsDouble(parameters, self.Y_RESOLUTION, context)
arguments.append(f"{yres}")
else:
arguments.append(str(-inLayer.rasterUnitsPerPixelY()))
arguments.append("-tap")
arguments.append("-cutline")
arguments.append(mask_details.connection_string)
arguments.append("-cl")
arguments.append(mask_details.layer_name)
if self.parameterAsBoolean(parameters, self.CROP_TO_CUTLINE, context):
arguments.append("-crop_to_cutline")
if self.parameterAsBoolean(parameters, self.ALPHA_BAND, context):
arguments.append("-dstalpha")
if nodata is not None:
arguments.append(f"-dstnodata {nodata}")
if self.parameterAsBoolean(parameters, self.MULTITHREADING, context):
arguments.append("-multi")
if options:
arguments.extend(GdalUtils.parseCreationOptions(options))
if self.EXTRA in parameters and parameters[self.EXTRA] not in (None, ""):
extra = self.parameterAsString(parameters, self.EXTRA, context)
arguments.append(extra)
arguments.append(input_details.connection_string)
arguments.append(out)
if input_details.open_options:
arguments.extend(input_details.open_options_as_arguments())
if input_details.credential_options:
arguments.extend(input_details.credential_options_as_arguments())
return [self.commandName(), GdalUtils.escapeAndJoin(arguments)]
|
