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
|
"""
***************************************************************************
proximity.py
---------------------
Date : August 2012
Copyright : (C) 2012 by Victor Olaya
Email : volayaf 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__ = "Victor Olaya"
__date__ = "August 2012"
__copyright__ = "(C) 2012, Victor Olaya"
import os
from qgis.PyQt.QtGui import QIcon
from qgis.core import (
QgsRasterFileWriter,
QgsProcessingException,
QgsProcessingParameterDefinition,
QgsProcessingParameterRasterLayer,
QgsProcessingParameterBand,
QgsProcessingParameterEnum,
QgsProcessingParameterString,
QgsProcessingParameterNumber,
QgsProcessingParameterRasterDestination,
)
from processing.algs.gdal.GdalAlgorithm import GdalAlgorithm
from processing.algs.gdal.GdalUtils import GdalUtils
from processing.tools.system import isWindows
pluginPath = os.path.split(os.path.split(os.path.dirname(__file__))[0])[0]
class proximity(GdalAlgorithm):
INPUT = "INPUT"
BAND = "BAND"
VALUES = "VALUES"
MAX_DISTANCE = "MAX_DISTANCE"
REPLACE = "REPLACE"
UNITS = "UNITS"
NODATA = "NODATA"
OPTIONS = "OPTIONS"
CREATION_OPTIONS = "CREATION_OPTIONS"
EXTRA = "EXTRA"
DATA_TYPE = "DATA_TYPE"
OUTPUT = "OUTPUT"
TYPES = [
"Byte",
"Int16",
"UInt16",
"UInt32",
"Int32",
"Float32",
"Float64",
"CInt16",
"CInt32",
"CFloat32",
"CFloat64",
"Int8",
]
def icon(self):
return QIcon(os.path.join(pluginPath, "images", "gdaltools", "proximity.png"))
def __init__(self):
super().__init__()
def initAlgorithm(self, config=None):
self.distanceUnits = (
(self.tr("Georeferenced coordinates"), "GEO"),
(self.tr("Pixel coordinates"), "PIXEL"),
)
self.addParameter(
QgsProcessingParameterRasterLayer(self.INPUT, self.tr("Input layer"))
)
self.addParameter(
QgsProcessingParameterBand(
self.BAND,
self.tr("Band number"),
1,
parentLayerParameterName=self.INPUT,
)
)
values_param = QgsProcessingParameterString(
self.VALUES,
self.tr("List of target pixels"),
optional=True,
)
values_param.setHelp(
self.tr(
"Comma-separated list of pixel values in the source image to consider as target pixels. If not specified, all non-zero pixels will be considered target pixels."
)
)
self.addParameter(values_param)
self.addParameter(
QgsProcessingParameterEnum(
self.UNITS,
self.tr("Distance units"),
options=[i[0] for i in self.distanceUnits],
allowMultiple=False,
defaultValue=1,
)
)
self.addParameter(
QgsProcessingParameterNumber(
self.MAX_DISTANCE,
self.tr("The maximum distance to generate"),
type=QgsProcessingParameterNumber.Type.Double,
minValue=0.0,
defaultValue=0.0,
optional=True,
)
)
replace_param = QgsProcessingParameterNumber(
self.REPLACE,
self.tr(
"Value to apply to pixels within the maximum distance of target pixels"
),
type=QgsProcessingParameterNumber.Type.Double,
defaultValue=0.0,
optional=True,
)
replace_param.setHelp(
self.tr(
"Value to apply to all pixels within the maximum distance of target pixels (including the target pixels) instead of a distance value"
)
)
self.addParameter(replace_param)
nodata_param = QgsProcessingParameterNumber(
self.NODATA,
self.tr("Nodata value to use for the destination proximity raster"),
type=QgsProcessingParameterNumber.Type.Double,
defaultValue=0.0,
optional=True,
)
nodata_param.setHelp(
self.tr(
"NoData value to use for the pixels beyond the maximum distance. "
"If not provided, it will be set to the one from the output band, or ultimately to 65535."
)
)
self.addParameter(nodata_param)
# backwards compatibility parameter
# TODO QGIS 4: remove parameter and related logic
options_param = QgsProcessingParameterString(
self.OPTIONS,
self.tr("Additional creation options"),
defaultValue="",
optional=True,
)
options_param.setFlags(
options_param.flags() | QgsProcessingParameterDefinition.Flag.Hidden
)
options_param.setMetadata({"widget_wrapper": {"widget_type": "rasteroptions"}})
self.addParameter(options_param)
creation_options_param = QgsProcessingParameterString(
self.CREATION_OPTIONS,
self.tr("Additional creation options"),
defaultValue="",
optional=True,
)
creation_options_param.setFlags(
creation_options_param.flags()
| QgsProcessingParameterDefinition.Flag.FlagAdvanced
)
creation_options_param.setMetadata(
{"widget_wrapper": {"widget_type": "rasteroptions"}}
)
self.addParameter(creation_options_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)
dataType_param = QgsProcessingParameterEnum(
self.DATA_TYPE,
self.tr("Output data type"),
self.TYPES,
allowMultiple=False,
defaultValue=5,
)
dataType_param.setFlags(
dataType_param.flags() | QgsProcessingParameterDefinition.Flag.FlagAdvanced
)
self.addParameter(dataType_param)
self.addParameter(
QgsProcessingParameterRasterDestination(
self.OUTPUT, self.tr("Proximity map")
)
)
def name(self):
return "proximity"
def displayName(self):
return self.tr("Proximity (raster distance)")
def group(self):
return self.tr("Raster analysis")
def groupId(self):
return "rasteranalysis"
def commandName(self):
return "gdal_proximity"
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)
distance = self.parameterAsDouble(parameters, self.MAX_DISTANCE, context)
replaceValue = self.parameterAsDouble(parameters, self.REPLACE, 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 = [
"-srcband",
str(self.parameterAsInt(parameters, self.BAND, context)),
"-distunits",
self.distanceUnits[self.parameterAsEnum(parameters, self.UNITS, context)][
1
],
]
values = self.parameterAsString(parameters, self.VALUES, context)
if values:
arguments.append("-values")
arguments.append(values)
if distance:
arguments.append("-maxdist")
arguments.append(str(distance))
if nodata is not None:
arguments.append("-nodata")
arguments.append(str(nodata))
if replaceValue:
arguments.append("-fixed-buf-val")
arguments.append(str(replaceValue))
data_type = self.parameterAsEnum(parameters, self.DATA_TYPE, context)
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)
options = self.parameterAsString(parameters, self.CREATION_OPTIONS, context)
# handle backwards compatibility parameter OPTIONS
if self.OPTIONS in parameters and parameters[self.OPTIONS] not in (None, ""):
options = self.parameterAsString(parameters, self.OPTIONS, context)
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.credential_options:
arguments.extend(input_details.credential_options_as_arguments())
return [
self.commandName() + (".bat" if isWindows() else ".py"),
GdalUtils.escapeAndJoin(arguments),
]
|
