-
Notifications
You must be signed in to change notification settings - Fork 4
/
wnt_validate.py
286 lines (238 loc) · 8.81 KB
/
wnt_validate.py
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
# -*- coding: utf-8 -*-
"""
/***************************************************************************
WaterNetworkTools
A QGIS plugin
Water Network Modelling Utilities
-------------------
begin : 2019-07-19
copyright : (C) 2019 by Andrés García Martínez
email : [email protected]
***************************************************************************/
/***************************************************************************
* *
* 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__ = 'Andrés García Martínez'
__date__ = '2019-07-19'
__copyright__ = '(C) 2019 by Andrés García Martínez'
# This will get replaced with a git SHA1 when you do a git archive
__revision__ = '$Format:%H$'
from PyQt5.QtCore import QCoreApplication, QVariant
from qgis.core import (QgsField,
QgsWkbTypes,
QgsProcessing,
QgsProcessingAlgorithm,
QgsProcessingParameterFeatureSink,
QgsProcessingParameterFeatureSource
)
from . import utils_core as tools
class ValidateAlgorithm(QgsProcessingAlgorithm):
"""
Validate a network.
"""
# DEFINE CONSTANTS
NODE_INPUT = 'NODE_INPUT'
LINK_INPUT = 'LINK_INPUT'
NODE_OUTPUT = 'NODE_OUTPUT'
LINK_OUTPUT = 'LINK_OUTPUT'
def tr(self, string):
"""
Returns a translatable string with the self.tr() function.
"""
return QCoreApplication.translate('Processing', string)
def createInstance(self):
"""
Create a instance and return a new copy of algorithm.
"""
return ValidateAlgorithm()
def name(self):
"""
Returns the unique algorithm name, used for identifying the algorithm.
"""
return 'validate'
def displayName(self):
"""
Returns the translated algorithm name, which should be used for any
user-visible display of the algorithm name.
"""
return self.tr('Validate')
def group(self):
"""
Returns the name of the group this algorithm belongs to.
"""
return self.tr('Graph')
def groupId(self):
"""
Returns the unique ID of the group this algorithm belongs to.
"""
return 'graph'
def shortHelpString(self):
"""
Returns a localised short helper string for the algorithm.
"""
return self.tr('''Analyse the network graph, verifying:
- Orphan nodes
- Duplicate nodes
- Lines with undefined ends
- Duplicate lines
- Loops (lines with the same start and end node)
The problems detected are stored in the field: *problems
===
Analiza el grafo de red, verificando:
- Nodos huérfanos
- Nodos duplicados
- Líneas con extremos no definidos
- Líneas duplicadas
- Bucles (líneas con igual nodo de inicio y final)
Los problemas detectados se almacenan en el campo: *problems.
''')
def initAlgorithm(self, config=None):
"""
Define the inputs and outputs of the algorithm.
"""
# ADD THE INPUT
self.addParameter(
QgsProcessingParameterFeatureSource(
self.NODE_INPUT,
self.tr('Input nodes layer'),
[QgsProcessing.TypeVectorPoint]
)
)
self.addParameter(
QgsProcessingParameterFeatureSource(
self.LINK_INPUT,
self.tr('Input links layer'),
[QgsProcessing.TypeVectorLine]
)
)
# ADD NODE AND LINK FEATURE SINK
self.addParameter(
QgsProcessingParameterFeatureSink(
self.NODE_OUTPUT,
self.tr('Audited node layer')
)
)
self.addParameter(
QgsProcessingParameterFeatureSink(
self.LINK_OUTPUT,
self.tr('Audited Link layer')
)
)
def processAlgorithm(self, parameters, context, feedback):
"""
RUN PROCESS
"""
# INPUT
nodelay = self.parameterAsSource(parameters, self.NODE_INPUT, context)
linklay = self.parameterAsSource(parameters, self.LINK_INPUT, context)
# OUTPUT
newfields = nodelay.fields()
newfields.append(QgsField("problems", QVariant.String))
(node_sink, node_id) = self.parameterAsSink(
parameters,
self.NODE_OUTPUT,
context,
newfields,
QgsWkbTypes.Point,
nodelay.sourceCrs()
)
newfields = linklay.fields()
newfields.append(QgsField("problems", QVariant.String))
(link_sink, link_id) = self.parameterAsSink(
parameters,
self.LINK_OUTPUT,
context,
newfields,
QgsWkbTypes.LineString,
linklay.sourceCrs()
)
# DEFINE NETWORK
net = tools.WntNetwork()
# LOAD NODES
ncnt = 0
for f in nodelay.getFeatures():
ncnt += 1
net.add_node(tools.WntNode(f['id']))
# SHOW PROGRESS
if ncnt % 100 == 0:
feedback.setProgress(25*ncnt/nodelay.featureCount())
# lOAD LINKS
lcnt = 0
for f in linklay.getFeatures():
lcnt += 1
net.add_link(tools.WntLink(f['id'], f['start'], f['end']))
# SHOW POROGRESS
if lcnt % 100 == 0:
feedback.setProgress(25+25*lcnt/linklay.featureCount())
# VALIDATE
problems = net.validate()
# WRITE OUTPUT
feedback.pushInfo('='*40)
# WRITE NODE PROBLEMS
ncnt = 0
for f in nodelay.getFeatures():
ncnt += 1
msg = ''
# ORPHAN NODE
if f['id'] in problems['orphan nodes']:
msg = 'Orphan.'
# DUPLICATED NODE ID
if f['id'] in problems['duplicate nodes']:
msg += ' ' if msg else ''
msg += 'Duplicated.'
# ADD FEATURE
attrib = f.attributes()
attrib.extend([msg])
f.setAttributes(attrib)
node_sink.addFeature(f)
# SHOW PROGRESS
if ncnt % 100 == 0:
feedback.setProgress(50+25*ncnt/nodelay.featureCount())
# WRITE LINK PROBLEMS
lcnt = 0
for f in linklay.getFeatures():
lcnt += 1
msg = ''
# UNDEFINED START OR END
if f['id'] in problems['undefined node links']:
msg = 'Undefined node links.'
# DUPLICATED ID
if f['id'] in problems['duplicate links']:
msg += ' ' if msg else ''
msg += 'Duplicate link.'
# LOOP. START NODE ID = END NODE ID
if f['id'] in problems['loops']:
msg += ' ' if msg else ''
msg += 'Loop.'
# ADD FEATURE
attrib = f.attributes()
attrib.extend([msg])
f.setAttributes(attrib)
link_sink.addFeature(f)
# SHOW PROGRESS
if lcnt % 100 == 0:
feedback.setProgress(75+25*lcnt/linklay.featureCount())
# SHOW INFO
msg = 'Analyzed: {} nodes and {} links'.format(ncnt, lcnt)
feedback.pushInfo(msg)
pcnt = 0
for k, v in problems.items():
pcnt += len(v)
feedback.pushInfo("{} : {}".format(k, len(v)))
if pcnt:
msg = '{} problems detected! Check the network.'.format(pcnt)
else:
msg = "Network is valid."
feedback.pushInfo(msg)
feedback.pushInfo('='*40)
# PROCCES CANCELED
if feedback.isCanceled():
return {}
# OUTPUT
return {self.NODE_OUTPUT: node_id, self.LINK_OUTPUT: link_id}