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.
137 lines
5.5 KiB
Python
137 lines
5.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
GeometryByExpression.py
|
|
-----------------------
|
|
Date : October 2016
|
|
Copyright : (C) 2016 by Nyall Dawson
|
|
Email : nyall dot dawson 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__ = 'Nyall Dawson'
|
|
__date__ = 'October 2016'
|
|
__copyright__ = '(C) 2016, Nyall Dawson'
|
|
|
|
# This will get replaced with a git SHA1 when you do a git archive323
|
|
|
|
__revision__ = '$Format:%H$'
|
|
|
|
from qgis.core import (QgsWkbTypes,
|
|
QgsExpression,
|
|
QgsFeatureSink,
|
|
QgsExpressionContext,
|
|
QgsExpressionContextUtils,
|
|
QgsGeometry,
|
|
QgsApplication,
|
|
QgsProcessingUtils)
|
|
|
|
from processing.algs.qgis.QgisAlgorithm import QgisAlgorithm
|
|
from processing.core.GeoAlgorithmExecutionException import GeoAlgorithmExecutionException
|
|
from processing.core.parameters import ParameterVector, ParameterSelection, ParameterBoolean, ParameterExpression
|
|
from processing.core.outputs import OutputVector
|
|
|
|
|
|
class GeometryByExpression(QgisAlgorithm):
|
|
|
|
INPUT_LAYER = 'INPUT_LAYER'
|
|
OUTPUT_LAYER = 'OUTPUT_LAYER'
|
|
OUTPUT_GEOMETRY = 'OUTPUT_GEOMETRY'
|
|
WITH_Z = 'WITH_Z'
|
|
WITH_M = 'WITH_M'
|
|
EXPRESSION = 'EXPRESSION'
|
|
|
|
def group(self):
|
|
return self.tr('Vector geometry tools')
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
def initAlgorithm(self, config=None):
|
|
self.addParameter(ParameterVector(self.INPUT_LAYER,
|
|
self.tr('Input layer')))
|
|
|
|
self.geometry_types = [self.tr('Polygon'),
|
|
'Line',
|
|
'Point']
|
|
self.addParameter(ParameterSelection(
|
|
self.OUTPUT_GEOMETRY,
|
|
self.tr('Output geometry type'),
|
|
self.geometry_types, default=0))
|
|
self.addParameter(ParameterBoolean(self.WITH_Z,
|
|
self.tr('Output geometry has z dimension'), False))
|
|
self.addParameter(ParameterBoolean(self.WITH_M,
|
|
self.tr('Output geometry has m values'), False))
|
|
|
|
self.addParameter(ParameterExpression(self.EXPRESSION,
|
|
self.tr("Geometry expression"), '$geometry', parent_layer=self.INPUT_LAYER))
|
|
|
|
self.addOutput(OutputVector(self.OUTPUT_LAYER, self.tr('Modified geometry')))
|
|
|
|
def name(self):
|
|
return 'geometrybyexpression'
|
|
|
|
def displayName(self):
|
|
return self.tr('Geometry by expression')
|
|
|
|
def processAlgorithm(self, parameters, context, feedback):
|
|
layer = QgsProcessingUtils.mapLayerFromString(self.getParameterValue(self.INPUT_LAYER), context)
|
|
|
|
geometry_type = self.getParameterValue(self.OUTPUT_GEOMETRY)
|
|
wkb_type = None
|
|
if geometry_type == 0:
|
|
wkb_type = QgsWkbTypes.Polygon
|
|
elif geometry_type == 1:
|
|
wkb_type = QgsWkbTypes.LineString
|
|
else:
|
|
wkb_type = QgsWkbTypes.Point
|
|
if self.getParameterValue(self.WITH_Z):
|
|
wkb_type = QgsWkbTypes.addZ(wkb_type)
|
|
if self.getParameterValue(self.WITH_M):
|
|
wkb_type = QgsWkbTypes.addM(wkb_type)
|
|
|
|
writer = self.getOutputFromName(
|
|
self.OUTPUT_LAYER).getVectorWriter(layer.fields(), wkb_type, layer.crs(), context)
|
|
|
|
expression = QgsExpression(self.getParameterValue(self.EXPRESSION))
|
|
if expression.hasParserError():
|
|
raise GeoAlgorithmExecutionException(expression.parserErrorString())
|
|
|
|
exp_context = QgsExpressionContext(QgsExpressionContextUtils.globalProjectLayerScopes(layer))
|
|
|
|
if not expression.prepare(exp_context):
|
|
raise GeoAlgorithmExecutionException(
|
|
self.tr('Evaluation error: {0}').format(expression.evalErrorString()))
|
|
|
|
features = QgsProcessingUtils.getFeatures(layer, context)
|
|
total = 100.0 / layer.featureCount() if layer.featureCount() else 0
|
|
for current, input_feature in enumerate(features):
|
|
output_feature = input_feature
|
|
|
|
exp_context.setFeature(input_feature)
|
|
value = expression.evaluate(exp_context)
|
|
if expression.hasEvalError():
|
|
raise GeoAlgorithmExecutionException(
|
|
self.tr('Evaluation error: {0}').format(expression.evalErrorString()))
|
|
|
|
if not value:
|
|
output_feature.setGeometry(QgsGeometry())
|
|
else:
|
|
if not isinstance(value, QgsGeometry):
|
|
raise GeoAlgorithmExecutionException(
|
|
self.tr('{} is not a geometry').format(value))
|
|
output_feature.setGeometry(value)
|
|
|
|
writer.addFeature(output_feature, QgsFeatureSink.FastInsert)
|
|
feedback.setProgress(int(current * total))
|
|
|
|
del writer
|