28QString QgsGeometryCheckGapAlgorithm::name()
const
30 return QStringLiteral(
"checkgeometrygap" );
33QString QgsGeometryCheckGapAlgorithm::displayName()
const
35 return QObject::tr(
"Small gaps" );
38QString QgsGeometryCheckGapAlgorithm::shortDescription()
const
40 return QObject::tr(
"Detects gaps between polygons smaller than a given area." );
43QStringList QgsGeometryCheckGapAlgorithm::tags()
const
45 return QObject::tr(
"check,geometry,gap" ).split(
',' );
48QString QgsGeometryCheckGapAlgorithm::group()
const
50 return QObject::tr(
"Check geometry" );
53QString QgsGeometryCheckGapAlgorithm::groupId()
const
55 return QStringLiteral(
"checkgeometry" );
58QString QgsGeometryCheckGapAlgorithm::shortHelpString()
const
60 return QObject::tr(
"This algorithm checks the gaps between polygons.\n"
61 "Gaps with an area smaller than the gap threshold are errors.\n\n"
62 "If an allowed gaps layer is given, the gaps contained in polygons from this layer will be ignored.\n"
63 "An optional buffer can be applied to the allowed gaps.\n\n"
64 "The neighbors output layer is needed for the fix geometry (gaps) algorithm. It is a 1-N "
65 "relational table for correspondance between a gap and the unique id of its neighbor features." );
73QgsGeometryCheckGapAlgorithm *QgsGeometryCheckGapAlgorithm::createInstance()
const
75 return new QgsGeometryCheckGapAlgorithm();
78void QgsGeometryCheckGapAlgorithm::initAlgorithm(
const QVariantMap &configuration )
80 Q_UNUSED( configuration )
86 QStringLiteral(
"UNIQUE_ID" ), QObject::tr(
"Unique feature identifier" ), QString(), QStringLiteral(
"INPUT" )
94 QStringLiteral(
"ALLOWED_GAPS_LAYER" ), QObject::tr(
"Allowed gaps layer" ),
98 QStringLiteral(
"ALLOWED_GAPS_BUFFER" ), QObject::tr(
"Allowed gaps buffer" ), QVariant(), QStringLiteral(
"ALLOWED_GAPS_LAYER" ),
true, 0.0
111 std::unique_ptr<QgsProcessingParameterNumber> tolerance = std::make_unique<QgsProcessingParameterNumber>(
115 tolerance->setHelp( QObject::tr(
"The \"Tolerance\" advanced parameter defines the numerical precision of geometric operations, "
116 "given as an integer n, meaning that any difference smaller than 10⁻ⁿ (in map units) is considered zero." ) );
117 addParameter( tolerance.release() );
122 mTolerance = parameterAsInt( parameters, QStringLiteral(
"TOLERANCE" ), context );
127QgsFields QgsGeometryCheckGapAlgorithm::outputFields()
130 fields.
append(
QgsField( QStringLiteral(
"gc_layerid" ), QMetaType::QString ) );
131 fields.
append(
QgsField( QStringLiteral(
"gc_layername" ), QMetaType::QString ) );
132 fields.
append(
QgsField( QStringLiteral(
"gc_partidx" ), QMetaType::Int ) );
133 fields.
append(
QgsField( QStringLiteral(
"gc_ringidx" ), QMetaType::Int ) );
134 fields.
append(
QgsField( QStringLiteral(
"gc_vertidx" ), QMetaType::Int ) );
135 fields.
append(
QgsField( QStringLiteral(
"gc_errorx" ), QMetaType::Double ) );
136 fields.
append(
QgsField( QStringLiteral(
"gc_errory" ), QMetaType::Double ) );
137 fields.
append(
QgsField( QStringLiteral(
"gc_error" ), QMetaType::QString ) );
138 fields.
append(
QgsField( QStringLiteral(
"gc_errorid" ), QMetaType::LongLong ) );
147 QString dest_neighbors;
148 const std::unique_ptr<QgsProcessingFeatureSource> input( parameterAsSource( parameters, QStringLiteral(
"INPUT" ), context ) );
152 QgsVectorLayer *allowedGapsLayer = parameterAsVectorLayer( parameters, QStringLiteral(
"ALLOWED_GAPS_LAYER" ), context );
154 const double allowedGapsBuffer = parameterAsDouble( parameters, QStringLiteral(
"ALLOWED_GAPS_BUFFER" ), context );
155 const double gapThreshold = parameterAsDouble( parameters, QStringLiteral(
"GAP_THRESHOLD" ), context );
159 const std::unique_ptr<QgsFeatureSink> sink_output( parameterAsSink(
160 parameters, QStringLiteral(
"OUTPUT" ), context, dest_output, fields, input->wkbType(), input->sourceCrs()
163 const std::unique_ptr<QgsFeatureSink> sink_errors( parameterAsSink(
164 parameters, QStringLiteral(
"ERRORS" ), context, dest_errors, fields,
Qgis::WkbType::Point, input->sourceCrs()
169 QString uniqueIdFieldName( parameterAsString( parameters, QStringLiteral(
"UNIQUE_ID" ), context ) );
170 int uniqueIdFieldIdx = input->fields().indexFromName( uniqueIdFieldName );
171 if ( uniqueIdFieldIdx == -1 )
172 throw QgsProcessingException( QObject::tr(
"Missing field %1 in input layer" ).arg( uniqueIdFieldName ) );
175 neighborsFields.
append(
QgsField(
"gc_errorid", QMetaType::LongLong ) );
176 neighborsFields.
append( input->fields().at( uniqueIdFieldIdx ) );
177 const std::unique_ptr<QgsFeatureSink> sink_neighbors( parameterAsSink(
180 if ( !sink_neighbors )
190 QList<QgsGeometryCheckError *> checkErrors;
191 QStringList messages;
193 QVariantMap configurationCheck;
194 configurationCheck.insert(
"gapThreshold", gapThreshold );
195 configurationCheck.insert(
"allowedGapsEnabled", allowedGapsLayer !=
nullptr );
196 if ( allowedGapsLayer )
198 configurationCheck.insert(
"allowedGapsLayer", allowedGapsLayer->
id() );
199 configurationCheck.insert(
"allowedGapsBuffer", allowedGapsBuffer );
202 check.prepare( &checkContext, configurationCheck );
204 multiStepFeedback.setCurrentStep( 1 );
206 QMap<QString, QgsFeaturePool *> checkerFeaturePools;
208 std::unique_ptr<QgsVectorLayer> inputLayer( input->materialize(
QgsFeatureRequest() ) );
210 checkerFeaturePools.insert( inputLayer->id(), &featurePool );
212 multiStepFeedback.setCurrentStep( 2 );
214 check.collectErrors( checkerFeaturePools, checkErrors, messages, feedback );
216 multiStepFeedback.setCurrentStep( 3 );
218 double step { checkErrors.size() > 0 ? 100.0 / checkErrors.size() : 1 };
237 << inputLayer->getFeature( neighborId ).attribute( uniqueIdFieldIdx )
240 throw QgsProcessingException( writeFeatureError( sink_neighbors.get(), parameters, QStringLiteral(
"NEIGHBORS" ) ) );
247 << inputLayer->name()
248 << error->vidx().part
249 << error->vidx().ring
250 << error->vidx().vertex
251 << error->location().x()
252 << error->location().y()
253 << error->value().toString()
259 throw QgsProcessingException( writeFeatureError( sink_output.get(), parameters, QStringLiteral(
"OUTPUT" ) ) );
263 throw QgsProcessingException( writeFeatureError( sink_errors.get(), parameters, QStringLiteral(
"ERRORS" ) ) );
266 feedback->
setProgress( 100.0 * step *
static_cast<double>( i ) );
283 outputs.insert( QStringLiteral(
"NEIGHBORS" ), dest_neighbors );
285 outputs.insert( QStringLiteral(
"OUTPUT" ), dest_output );
286 outputs.insert( QStringLiteral(
"ERRORS" ), dest_errors );
@ Vector
Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink ha...
@ 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.
@ 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.
@ Double
Double/float values.
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...
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.
void setProgress(double progress)
Sets the current progress for the feedback object.
Encapsulate a field in an attribute table or data source.
Container of fields for a vector layer.
bool append(const QgsField &field, Qgis::FieldOrigin origin=Qgis::FieldOrigin::Provider, int originIndex=-1)
Appends a field.
Base configuration for geometry checks.
This represents an error reported by a geometry check.
An error produced by a QgsGeometryGapCheck.
const QMap< QString, QgsFeatureIds > & neighbors() const
A map of layers and feature ids of the neighbors of the gap.
Checks for gaps between neighbouring polygons.
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.
virtual Qgis::ProcessingAlgorithmFlags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
int layerSortKey
Optional sorting key for sorting output layers when loading them into a project.
Contains information about the context in which a processing algorithm is executed.
QgsProcessingContext::LayerDetails & layerToLoadOnCompletionDetails(const QString &layer)
Returns a reference to the details for a given layer which is loaded on completion of the algorithm o...
bool willLoadLayerOnCompletion(const QString &layer) const
Returns true if the given layer (by ID or datasource) will be loaded into the current project upon co...
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 double numeric parameter for distance values.
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.
A numeric parameter for processing algorithms.
A vector layer (with or without geometry) parameter for processing algorithms.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
static QgsProject * instance()
Returns the QgsProject singleton instance.
QgsCoordinateTransformContext transformContext
A feature pool based on a vector data provider.
Represents a vector layer which manages a vector based dataset.
QSet< QgsFeatureId > QgsFeatureIds
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features