QGIS API Documentation 3.43.0-Master (e01d6d7c4c0)
qgsalgorithmcheckgeometryhole.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmcheckgeometryhole.cpp
3 ---------------------
4 begin : July 2024
5 copyright : (C) 2024 by Jacky Volpes
6 email : jacky dot volpes at oslandia 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
22#include "qgspoint.h"
23#include "qgsvectorlayer.h"
25
27
28QString QgsGeometryCheckHoleAlgorithm::name() const
29{
30 return QStringLiteral( "checkgeometryhole" );
31}
32
33QString QgsGeometryCheckHoleAlgorithm::displayName() const
34{
35 return QObject::tr( "Holes" );
36}
37
38QString QgsGeometryCheckHoleAlgorithm::shortDescription() const
39{
40 return QObject::tr( "Detects holes inside polygons." );
41}
42
43QStringList QgsGeometryCheckHoleAlgorithm::tags() const
44{
45 return QObject::tr( "check,geometry,hole" ).split( ',' );
46}
47
48QString QgsGeometryCheckHoleAlgorithm::group() const
49{
50 return QObject::tr( "Check geometry" );
51}
52
53QString QgsGeometryCheckHoleAlgorithm::groupId() const
54{
55 return QStringLiteral( "checkgeometry" );
56}
57
58QString QgsGeometryCheckHoleAlgorithm::shortHelpString() const
59{
60 return QObject::tr( "This algorithm checks the holes of polygon geometries.\n"
61 "Holes are errors." );
62}
63
64Qgis::ProcessingAlgorithmFlags QgsGeometryCheckHoleAlgorithm::flags() const
65{
67}
68
69QgsGeometryCheckHoleAlgorithm *QgsGeometryCheckHoleAlgorithm::createInstance() const
70{
71 return new QgsGeometryCheckHoleAlgorithm();
72}
73
74void QgsGeometryCheckHoleAlgorithm::initAlgorithm( const QVariantMap &configuration )
75{
76 Q_UNUSED( configuration )
77
78 // inputs
79 addParameter(
81 QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ),
82 QList<int>() << static_cast<int>( Qgis::ProcessingSourceType::VectorPolygon )
83 )
84 );
85 addParameter( new QgsProcessingParameterField(
86 QStringLiteral( "UNIQUE_ID" ), QObject::tr( "Unique feature identifier" ), QString(), QStringLiteral( "INPUT" )
87 ) );
88
89 // outputs
90 addParameter( new QgsProcessingParameterFeatureSink(
91 QStringLiteral( "ERRORS" ), QObject::tr( "Holes errors" ), Qgis::ProcessingSourceType::VectorPoint
92 ) );
93 addParameter( new QgsProcessingParameterFeatureSink(
94 QStringLiteral( "OUTPUT" ), QObject::tr( "Polygons with holes" ), Qgis::ProcessingSourceType::VectorPolygon, QVariant(), true, false
95 ) );
96
97 std::unique_ptr<QgsProcessingParameterNumber> tolerance = std::make_unique<QgsProcessingParameterNumber>(
98 QStringLiteral( "TOLERANCE" ), QObject::tr( "Tolerance" ), Qgis::ProcessingNumberParameterType::Integer, 8, false, 1, 13
99 );
100 tolerance->setFlags( tolerance->flags() | Qgis::ProcessingParameterFlag::Advanced );
101 tolerance->setHelp( QObject::tr( "The \"Tolerance\" advanced parameter defines the numerical precision of geometric operations, "
102 "given as an integer n, meaning that any difference smaller than 10⁻ⁿ (in map units) is considered zero." ) );
103 addParameter( tolerance.release() );
104}
105
106bool QgsGeometryCheckHoleAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
107{
108 mTolerance = parameterAsInt( parameters, QStringLiteral( "TOLERANCE" ), context );
109
110 return true;
111}
112
113QgsFields QgsGeometryCheckHoleAlgorithm::outputFields()
114{
115 QgsFields fields;
116 fields.append( QgsField( QStringLiteral( "gc_layerid" ), QMetaType::QString ) );
117 fields.append( QgsField( QStringLiteral( "gc_layername" ), QMetaType::QString ) );
118 fields.append( QgsField( QStringLiteral( "gc_partidx" ), QMetaType::Int ) );
119 fields.append( QgsField( QStringLiteral( "gc_ringidx" ), QMetaType::Int ) );
120 fields.append( QgsField( QStringLiteral( "gc_vertidx" ), QMetaType::Int ) );
121 fields.append( QgsField( QStringLiteral( "gc_errorx" ), QMetaType::Double ) );
122 fields.append( QgsField( QStringLiteral( "gc_errory" ), QMetaType::Double ) );
123 fields.append( QgsField( QStringLiteral( "gc_error" ), QMetaType::QString ) );
124 return fields;
125}
126
127QVariantMap QgsGeometryCheckHoleAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
128{
129 QString dest_output;
130 QString dest_errors;
131 const std::unique_ptr<QgsProcessingFeatureSource> input( parameterAsSource( parameters, QStringLiteral( "INPUT" ), context ) );
132 if ( !input )
133 throw QgsProcessingException( invalidSourceError( parameters, QStringLiteral( "INPUT" ) ) );
134
135 QString uniqueIdFieldName( parameterAsString( parameters, QStringLiteral( "UNIQUE_ID" ), context ) );
136 int uniqueIdFieldIdx = input->fields().indexFromName( uniqueIdFieldName );
137 if ( uniqueIdFieldIdx == -1 )
138 throw QgsProcessingException( QObject::tr( "Missing field %1 in input layer" ).arg( uniqueIdFieldName ) );
139
140 const QgsField uniqueIdField = input->fields().at( uniqueIdFieldIdx );
141
142 QgsFields fields = outputFields();
143 fields.append( uniqueIdField );
144
145 const std::unique_ptr<QgsFeatureSink> sink_output(
146 parameterAsSink( parameters, QStringLiteral( "OUTPUT" ), context, dest_output, fields, input->wkbType(), input->sourceCrs() )
147 );
148
149 const std::unique_ptr<QgsFeatureSink> sink_errors(
150 parameterAsSink( parameters, QStringLiteral( "ERRORS" ), context, dest_errors, fields, Qgis::WkbType::Point, input->sourceCrs() )
151 );
152 if ( !sink_errors )
153 throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "ERRORS" ) ) );
154
155 QgsProcessingMultiStepFeedback multiStepFeedback( 3, feedback );
156
157 QgsProject *project = QgsProject::instance();
158
159 QgsGeometryCheckContext checkContext = QgsGeometryCheckContext( mTolerance, input->sourceCrs(), project->transformContext(), project );
160
161 // Test detection
162 QList<QgsGeometryCheckError *> checkErrors;
163 QStringList messages;
164
165 const QgsGeometryHoleCheck check( &checkContext, QVariantMap() );
166
167 multiStepFeedback.setCurrentStep( 1 );
168 feedback->setProgressText( QObject::tr( "Preparing features…" ) );
169 QMap<QString, QgsFeaturePool *> featurePools;
170
171 std::unique_ptr<QgsVectorLayer> inputLayer( input->materialize( QgsFeatureRequest() ) );
173 featurePools.insert( inputLayer->id(), &featurePool );
174
175 multiStepFeedback.setCurrentStep( 2 );
176 feedback->setProgressText( QObject::tr( "Collecting errors…" ) );
177 check.collectErrors( featurePools, checkErrors, messages, feedback );
178
179 multiStepFeedback.setCurrentStep( 3 );
180 feedback->setProgressText( QObject::tr( "Exporting errors…" ) );
181 const double step { checkErrors.size() > 0 ? 100.0 / checkErrors.size() : 1 };
182 long i = 0;
183 feedback->setProgress( 0.0 );
184
185 for ( const QgsGeometryCheckError *error : checkErrors )
186 {
187 if ( feedback->isCanceled() )
188 {
189 break;
190 }
191 QgsFeature f;
192 QgsAttributes attrs = f.attributes();
193
194 attrs << error->layerId()
195 << error->featureId()
196 << error->vidx().part
197 << error->vidx().ring
198 << error->vidx().vertex
199 << error->location().x()
200 << error->location().y()
201 << error->value().toString()
202 << inputLayer->getFeature( error->featureId() ).attribute( uniqueIdField.name() );
203 f.setAttributes( attrs );
204
205 f.setGeometry( error->geometry() );
206 if ( sink_output && !sink_output->addFeature( f, QgsFeatureSink::FastInsert ) )
207 throw QgsProcessingException( writeFeatureError( sink_output.get(), parameters, QStringLiteral( "OUTPUT" ) ) );
208
209 f.setGeometry( QgsGeometry::fromPoint( QgsPoint( error->location().x(), error->location().y() ) ) );
210 if ( !sink_errors->addFeature( f, QgsFeatureSink::FastInsert ) )
211 throw QgsProcessingException( writeFeatureError( sink_errors.get(), parameters, QStringLiteral( "ERRORS" ) ) );
212
213 i++;
214 feedback->setProgress( 100.0 * step * static_cast<double>( i ) );
215 }
216
217 // cleanup memory of the pointed data
218 for ( const QgsGeometryCheckError *error : checkErrors )
219 {
220 delete error;
221 }
222
223 QVariantMap outputs;
224 if ( sink_output )
225 outputs.insert( QStringLiteral( "OUTPUT" ), dest_output );
226 outputs.insert( QStringLiteral( "ERRORS" ), dest_errors );
227
228 return outputs;
229}
230
@ VectorPoint
Vector point layers.
@ VectorPolygon
Vector polygon layers.
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3476
@ NoThreading
Algorithm is not thread safe and cannot be run in a background thread, e.g. for algorithms which mani...
@ Advanced
Parameter is an advanced parameter which should be hidden from users by default.
A vector of attributes.
Wraps a request for features to a vector layer (or directly its vector data provider).
@ FastInsert
Use faster inserts, at the cost of updating the passed features to reflect changes made at the provid...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
QgsAttributes attributes
Definition qgsfeature.h:67
void setAttributes(const QgsAttributes &attrs)
Sets the feature's attributes.
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
bool isCanceled() const
Tells whether the operation has been canceled already.
Definition qgsfeedback.h:53
void setProgress(double progress)
Sets the current progress for the feedback object.
Definition qgsfeedback.h:61
Encapsulate a field in an attribute table or data source.
Definition qgsfield.h:53
QString name
Definition qgsfield.h:62
Container of fields for a vector layer.
Definition qgsfields.h:46
bool append(const QgsField &field, Qgis::FieldOrigin origin=Qgis::FieldOrigin::Provider, int originIndex=-1)
Appends a field.
Definition qgsfields.cpp:70
Base configuration for geometry checks.
This represents an error reported by a geometry check.
static QgsGeometry fromPoint(const QgsPoint &point)
Creates a new geometry from a QgsPoint object.
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:49
virtual Qgis::ProcessingAlgorithmFlags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
Contains information about the context in which a processing algorithm is executed.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
virtual void setProgressText(const QString &text)
Sets a progress report text string.
Processing feedback object for multi-step operations.
A feature sink output for processing algorithms.
An input feature source (such as vector layers) parameter for processing algorithms.
A vector layer or feature source field parameter for processing algorithms.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:107
static QgsProject * instance()
Returns the QgsProject singleton instance.
QgsCoordinateTransformContext transformContext
Definition qgsproject.h:113
A feature pool based on a vector data provider.