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
|
"""
***************************************************************************
ClipVectorByMask.py
---------------------
Date : November 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__ = "November 2012"
__copyright__ = "(C) 2012, Victor Olaya"
from qgis.core import (
QgsProcessing,
QgsProcessingAlgorithm,
QgsProcessingParameterDefinition,
QgsProcessingParameterString,
QgsProcessingParameterFeatureSource,
QgsProcessingParameterVectorDestination,
)
from processing.algs.gdal.GdalAlgorithm import GdalAlgorithm
from processing.algs.gdal.GdalUtils import GdalUtils
class ClipVectorByMask(GdalAlgorithm):
INPUT = "INPUT"
MASK = "MASK"
OPTIONS = "OPTIONS"
OUTPUT = "OUTPUT"
def __init__(self):
super().__init__()
def flags(self):
return (
QgsProcessingAlgorithm.Flag.FlagSupportsBatch
| QgsProcessingAlgorithm.Flag.FlagRequiresMatchingCrs
) # cannot cancel!
def initAlgorithm(self, config=None):
self.addParameter(
QgsProcessingParameterFeatureSource(self.INPUT, self.tr("Input layer"))
)
self.addParameter(
QgsProcessingParameterFeatureSource(
self.MASK,
self.tr("Mask layer"),
[QgsProcessing.SourceType.TypeVectorPolygon],
)
)
options_param = QgsProcessingParameterString(
self.OPTIONS,
self.tr("Additional creation options"),
defaultValue="",
optional=True,
)
options_param.setFlags(
options_param.flags() | QgsProcessingParameterDefinition.Flag.FlagAdvanced
)
self.addParameter(options_param)
self.addParameter(
QgsProcessingParameterVectorDestination(
self.OUTPUT, self.tr("Clipped (mask)")
)
)
def name(self):
return "clipvectorbypolygon"
def displayName(self):
return self.tr("Clip vector by mask layer")
def group(self):
return self.tr("Vector geoprocessing")
def groupId(self):
return "vectorgeoprocessing"
def commandName(self):
return "ogr2ogr"
def getConsoleCommands(self, parameters, context, feedback, executing=True):
input_details = self.getOgrCompatibleSource(
self.INPUT, parameters, context, feedback, executing
)
mask_details = self.getOgrCompatibleSource(
self.MASK, parameters, context, feedback, executing
)
options = self.parameterAsString(parameters, self.OPTIONS, context)
outFile = self.parameterAsOutputLayer(parameters, self.OUTPUT, context)
self.setOutputValue(self.OUTPUT, outFile)
output_details = GdalUtils.gdal_connection_details_from_uri(outFile, context)
arguments = [
"-clipsrc",
mask_details.connection_string,
"-clipsrclayer",
mask_details.layer_name,
output_details.connection_string,
input_details.connection_string,
input_details.layer_name,
]
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())
if options:
arguments.append(options)
if output_details.format:
arguments.append(f"-f {output_details.format}")
return [self.commandName(), GdalUtils.escapeAndJoin(arguments)]
|
