QGIS API Documentation  3.0.2-Girona (307d082)
qgsalgorithmremoveduplicatevertices.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmremoveduplicatevertices.cpp
3  ---------------------
4  begin : November 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
19 
21 
22 QString QgsAlgorithmRemoveDuplicateVertices::name() const
23 {
24  return QStringLiteral( "removeduplicatevertices" );
25 }
26 
27 QString QgsAlgorithmRemoveDuplicateVertices::displayName() const
28 {
29  return QObject::tr( "Remove duplicate vertices" );
30 }
31 
32 QStringList QgsAlgorithmRemoveDuplicateVertices::tags() const
33 {
34  return QObject::tr( "points,valid,overlapping,vertex,nodes" ).split( ',' );
35 }
36 
37 QString QgsAlgorithmRemoveDuplicateVertices::group() const
38 {
39  return QObject::tr( "Vector geometry" );
40 }
41 
42 QString QgsAlgorithmRemoveDuplicateVertices::groupId() const
43 {
44  return QStringLiteral( "vectorgeometry" );
45 }
46 
47 QString QgsAlgorithmRemoveDuplicateVertices::outputName() const
48 {
49  return QObject::tr( "Cleaned" );
50 }
51 
52 QString QgsAlgorithmRemoveDuplicateVertices::shortHelpString() const
53 {
54  return QObject::tr( "This algorithm removes duplicate vertices from features, wherever removing the vertices does "
55  "not result in a degenerate geometry.\n\n"
56  "The tolerance parameter specifies the tolerance for coordinates when determining whether "
57  "vertices are identical.\n\n"
58  "By default, z values are not considered when detecting duplicate vertices. E.g. two vertices "
59  "with the same x and y coordinate but different z values will still be considered "
60  "duplicate and one will be removed. If the Use Z Value parameter is true, then the z values are "
61  "also tested and vertices with the same x and y but different z will be maintained.\n\n"
62  "Note that duplicate vertices are not tested between different parts of a multipart geometry. E.g. "
63  "a multipoint geometry with overlapping points will not be changed by this method." );
64 }
65 
66 QgsAlgorithmRemoveDuplicateVertices *QgsAlgorithmRemoveDuplicateVertices::createInstance() const
67 {
68  return new QgsAlgorithmRemoveDuplicateVertices();
69 }
70 
71 void QgsAlgorithmRemoveDuplicateVertices::initParameters( const QVariantMap & )
72 {
73  addParameter( new QgsProcessingParameterNumber( QStringLiteral( "TOLERANCE" ),
74  QObject::tr( "Tolerance" ), QgsProcessingParameterNumber::Double,
75  0.000001, false, 0, 10000000.0 ) );
76  addParameter( new QgsProcessingParameterBoolean( QStringLiteral( "USE_Z_VALUE" ),
77  QObject::tr( "Use Z Value" ), false ) );
78 }
79 
80 QgsProcessingFeatureSource::Flag QgsAlgorithmRemoveDuplicateVertices::sourceFlags() const
81 {
82  // skip geometry checks - this algorithm can be used to repair geometries
84 }
85 
86 bool QgsAlgorithmRemoveDuplicateVertices::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
87 {
88  mTolerance = parameterAsDouble( parameters, QStringLiteral( "TOLERANCE" ), context );
89  mUseZValues = parameterAsBool( parameters, QStringLiteral( "USE_Z_VALUE" ), context );
90  return true;
91 }
92 
93 QgsFeatureList QgsAlgorithmRemoveDuplicateVertices::processFeature( const QgsFeature &feature, QgsProcessingContext &, QgsProcessingFeedback * )
94 {
95  QgsFeature f = feature;
96  if ( f.hasGeometry() )
97  {
98  QgsGeometry geometry = f.geometry();
99  geometry.removeDuplicateNodes( mTolerance, mUseZValues );
100  f.setGeometry( geometry );
101  }
102  return QgsFeatureList() << f;
103 }
104 
106 
107 
A boolean parameter for processing algorithms.
Base class for providing feedback from a processing algorithm.
Invalid geometry checks should always be skipped. This flag can be useful for algorithms which always...
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:549
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:111
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:62
bool hasGeometry() const
Returns true if the feature has an associated geometry.
Definition: qgsfeature.cpp:190
QgsGeometry geometry() const
Returns the geometry associated with this feature.
Definition: qgsfeature.cpp:101
A numeric parameter for processing algorithms.
Flag
Flags controlling how QgsProcessingFeatureSource fetches features.
void setGeometry(const QgsGeometry &geometry)
Set the feature&#39;s geometry.
Definition: qgsfeature.cpp:137
Contains information about the context in which a processing algorithm is executed.
bool removeDuplicateNodes(double epsilon=4 *DBL_EPSILON, bool useZValues=false)
Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerat...