mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-06 00:05:02 -05:00
1e13d733c2
initAlgorithm() method This allows 2 benefits: - algorithms can be subclassed and have subclasses add additional parameters/outputs to the algorithm. With the previous approach of declaring parameters/outputs in the constructor, it's not possible to call virtual methods to add additional parameters/ outputs (since you can't call virtual methods from a constructor). - initAlgorithm takes a variant map argument, allowing the algorithm to dynamically adjust its declared parameters and outputs according to this configuration map. This potentially allows model algorithms which can be configured to have variable numbers of parameters and outputs at run time. E.g. a "router" algorithm which directs features to one of any number of output sinks depending on some user configured criteria.
198 lines
8.3 KiB
Python
198 lines
8.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
CheckValidity.py
|
|
---------------------
|
|
Date : May 2015
|
|
Copyright : (C) 2015 by Arnaud Morvan
|
|
Email : arnaud dot morvan at camptocamp 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__ = 'Arnaud Morvan'
|
|
__date__ = 'May 2015'
|
|
__copyright__ = '(C) 2015, Arnaud Morvan'
|
|
|
|
# This will get replaced with a git SHA1 when you do a git archive323
|
|
|
|
__revision__ = '$Format:%H$'
|
|
|
|
import os
|
|
|
|
from qgis.PyQt.QtGui import QIcon
|
|
from qgis.PyQt.QtCore import QVariant
|
|
|
|
from qgis.core import (QgsSettings,
|
|
QgsGeometry,
|
|
QgsFeature,
|
|
QgsField,
|
|
QgsFeatureRequest,
|
|
QgsFeatureSink,
|
|
QgsWkbTypes,
|
|
QgsProcessingUtils,
|
|
QgsFields,
|
|
QgsProcessing,
|
|
QgsProcessingFeatureSource,
|
|
QgsProcessingParameterFeatureSource,
|
|
QgsProcessingParameterEnum,
|
|
QgsProcessingParameterFeatureSink,
|
|
QgsProcessingOutputVectorLayer,
|
|
QgsProcessingParameterDefinition,
|
|
QgsProcessingOutputNumber
|
|
)
|
|
from processing.algs.qgis.QgisAlgorithm import QgisAlgorithm
|
|
|
|
settings_method_key = "/qgis/digitizing/validate_geometries"
|
|
pluginPath = os.path.split(os.path.split(os.path.dirname(__file__))[0])[0]
|
|
|
|
|
|
class CheckValidity(QgisAlgorithm):
|
|
|
|
INPUT_LAYER = 'INPUT_LAYER'
|
|
METHOD = 'METHOD'
|
|
VALID_OUTPUT = 'VALID_OUTPUT'
|
|
VALID_COUNT = 'VALID_COUNT'
|
|
INVALID_OUTPUT = 'INVALID_OUTPUT'
|
|
INVALID_COUNT = 'INVALID_COUNT'
|
|
ERROR_OUTPUT = 'ERROR_OUTPUT'
|
|
ERROR_COUNT = 'ERROR_COUNT'
|
|
|
|
def icon(self):
|
|
return QIcon(os.path.join(pluginPath, 'images', 'ftools', 'check_geometry.png'))
|
|
|
|
def group(self):
|
|
return self.tr('Vector geometry tools')
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
def initAlgorithm(self, config=None):
|
|
self.methods = [self.tr('The one selected in digitizing settings'),
|
|
'QGIS',
|
|
'GEOS']
|
|
|
|
self.addParameter(QgsProcessingParameterFeatureSource(self.INPUT_LAYER,
|
|
self.tr('Input layer')))
|
|
self.addParameter(QgsProcessingParameterEnum(self.METHOD,
|
|
self.tr('Method'), self.methods))
|
|
|
|
self.addParameter(QgsProcessingParameterFeatureSink(self.VALID_OUTPUT, self.tr('Valid output'), QgsProcessing.TypeVectorAny, '', True))
|
|
self.addOutput(QgsProcessingOutputVectorLayer(self.VALID_OUTPUT, self.tr('Valid output')))
|
|
self.addOutput(QgsProcessingOutputNumber(self.VALID_COUNT, self.tr('Count of valid features')))
|
|
|
|
self.addParameter(QgsProcessingParameterFeatureSink(self.INVALID_OUTPUT, self.tr('Invalid output'), QgsProcessing.TypeVectorAny, '', True))
|
|
self.addOutput(QgsProcessingOutputVectorLayer(self.INVALID_OUTPUT, self.tr('Invalid output')))
|
|
self.addOutput(QgsProcessingOutputNumber(self.INVALID_COUNT, self.tr('Count of invalid features')))
|
|
|
|
self.addParameter(QgsProcessingParameterFeatureSink(self.ERROR_OUTPUT, self.tr('Error output'), QgsProcessing.TypeVectorAny, '', True))
|
|
self.addOutput(QgsProcessingOutputVectorLayer(self.ERROR_OUTPUT, self.tr('Error output')))
|
|
self.addOutput(QgsProcessingOutputNumber(self.ERROR_COUNT, self.tr('Count of errors')))
|
|
|
|
def name(self):
|
|
return 'checkvalidity'
|
|
|
|
def displayName(self):
|
|
return self.tr('Check validity')
|
|
|
|
def processAlgorithm(self, parameters, context, feedback):
|
|
method_param = self.parameterAsEnum(parameters, self.METHOD, context)
|
|
if method_param == 0:
|
|
settings = QgsSettings()
|
|
method = int(settings.value(settings_method_key, 0)) - 1
|
|
if method < 0:
|
|
method = 0
|
|
else:
|
|
method = method_param - 1
|
|
|
|
results = self.doCheck(method, parameters, context, feedback)
|
|
return results
|
|
|
|
def doCheck(self, method, parameters, context, feedback):
|
|
source = self.parameterAsSource(parameters, self.INPUT_LAYER, context)
|
|
|
|
(valid_output_sink, valid_output_dest_id) = self.parameterAsSink(parameters, self.VALID_OUTPUT, context,
|
|
source.fields(), source.wkbType(), source.sourceCrs())
|
|
valid_count = 0
|
|
|
|
invalid_fields = source.fields()
|
|
invalid_fields.append(QgsField('_errors', QVariant.String, 'string', 255))
|
|
(invalid_output_sink, invalid_output_dest_id) = self.parameterAsSink(parameters, self.INVALID_OUTPUT, context,
|
|
invalid_fields, source.wkbType(), source.sourceCrs())
|
|
invalid_count = 0
|
|
|
|
error_fields = QgsFields()
|
|
error_fields.append(QgsField('message', QVariant.String, 'string', 255))
|
|
(error_output_sink, error_output_dest_id) = self.parameterAsSink(parameters, self.ERROR_OUTPUT, context,
|
|
error_fields, QgsWkbTypes.Point, source.sourceCrs())
|
|
error_count = 0
|
|
|
|
features = source.getFeatures(QgsFeatureRequest(), QgsProcessingFeatureSource.FlagSkipGeometryValidityChecks)
|
|
total = 100.0 / source.featureCount() if source.featureCount() else 0
|
|
for current, inFeat in enumerate(features):
|
|
if feedback.isCanceled():
|
|
break
|
|
geom = inFeat.geometry()
|
|
attrs = inFeat.attributes()
|
|
|
|
valid = True
|
|
if not geom.isNull() and not geom.isEmpty():
|
|
errors = list(geom.validateGeometry(method))
|
|
if errors:
|
|
# QGIS method return a summary at the end
|
|
if method == 1:
|
|
errors.pop()
|
|
valid = False
|
|
reasons = []
|
|
for error in errors:
|
|
errFeat = QgsFeature()
|
|
error_geom = QgsGeometry.fromPoint(error.where())
|
|
errFeat.setGeometry(error_geom)
|
|
errFeat.setAttributes([error.what()])
|
|
if error_output_sink:
|
|
error_output_sink.addFeature(errFeat, QgsFeatureSink.FastInsert)
|
|
error_count += 1
|
|
|
|
reasons.append(error.what())
|
|
|
|
reason = "\n".join(reasons)
|
|
if len(reason) > 255:
|
|
reason = reason[:252] + '...'
|
|
attrs.append(reason)
|
|
|
|
outFeat = QgsFeature()
|
|
outFeat.setGeometry(geom)
|
|
outFeat.setAttributes(attrs)
|
|
|
|
if valid:
|
|
if valid_output_sink:
|
|
valid_output_sink.addFeature(outFeat, QgsFeatureSink.FastInsert)
|
|
valid_count += 1
|
|
|
|
else:
|
|
if invalid_output_sink:
|
|
invalid_output_sink.addFeature(outFeat, QgsFeatureSink.FastInsert)
|
|
invalid_count += 1
|
|
|
|
feedback.setProgress(int(current * total))
|
|
|
|
results = {
|
|
self.VALID_COUNT: valid_count,
|
|
self.INVALID_COUNT: invalid_count,
|
|
self.ERROR_COUNT: error_count
|
|
}
|
|
if valid_output_sink:
|
|
results[self.VALID_OUTPUT] = valid_output_dest_id
|
|
if invalid_output_sink:
|
|
results[self.INVALID_OUTPUT] = invalid_output_dest_id
|
|
if error_output_sink:
|
|
results[self.ERROR_OUTPUT] = error_output_dest_id
|
|
return results
|