Merge pull request #61317 from Djedouas/checker_check_overlap

Processing: Add Check Geometry Algorithm and test: Overlap
This commit is contained in:
Loïc Bartoletti 2025-04-17 16:35:03 +02:00 committed by GitHub
commit 2f659e466c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 318 additions and 1 deletions

View File

@ -70,6 +70,7 @@ set(QGIS_ANALYSIS_SRCS
processing/qgsalgorithmfixgeometrymissingvertex.cpp
processing/qgsalgorithmcheckgeometryarea.cpp
processing/qgsalgorithmfixgeometryarea.cpp
processing/qgsalgorithmcheckgeometryoverlap.cpp
processing/qgsalgorithmcheckgeometryfollowboundaries.cpp
processing/qgsalgorithmcheckgeometryduplicatenodes.cpp
processing/qgsalgorithmcheckgeometrydangle.cpp

View File

@ -0,0 +1,229 @@
/***************************************************************************
qgsalgorithmcheckgeometryoverlap.cpp
---------------------
begin : April 2025
copyright : (C) 2025 by Jacky Volpes
email : jacky dot volpes at oslandia 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. *
* *
***************************************************************************/
#include "qgsalgorithmcheckgeometryoverlap.h"
#include "qgsgeometrycheckcontext.h"
#include "qgsgeometrycheckerror.h"
#include "qgsgeometryoverlapcheck.h"
#include "qgspoint.h"
#include "qgsvectorlayer.h"
#include "qgsvectordataproviderfeaturepool.h"
///@cond PRIVATE
QString QgsGeometryCheckOverlapAlgorithm::name() const
{
return QStringLiteral( "checkgeometryoverlap" );
}
QString QgsGeometryCheckOverlapAlgorithm::displayName() const
{
return QObject::tr( "Check Geometry (Overlap)" );
}
QStringList QgsGeometryCheckOverlapAlgorithm::tags() const
{
return QObject::tr( "check,geometry,overlap" ).split( ',' );
}
QString QgsGeometryCheckOverlapAlgorithm::group() const
{
return QObject::tr( "Check geometry" );
}
QString QgsGeometryCheckOverlapAlgorithm::groupId() const
{
return QStringLiteral( "checkgeometry" );
}
QString QgsGeometryCheckOverlapAlgorithm::shortHelpString() const
{
return QObject::tr( "This algorithm checks the overlapping areas.\n"
"Overlapping areas smaller than the minimum overlapping area are errors." );
}
Qgis::ProcessingAlgorithmFlags QgsGeometryCheckOverlapAlgorithm::flags() const
{
return QgsProcessingAlgorithm::flags() | Qgis::ProcessingAlgorithmFlag::NoThreading;
}
QgsGeometryCheckOverlapAlgorithm *QgsGeometryCheckOverlapAlgorithm::createInstance() const
{
return new QgsGeometryCheckOverlapAlgorithm();
}
void QgsGeometryCheckOverlapAlgorithm::initAlgorithm( const QVariantMap &configuration )
{
Q_UNUSED( configuration )
addParameter( new QgsProcessingParameterFeatureSource(
QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ), QList<int>() << static_cast<int>( Qgis::ProcessingSourceType::VectorPolygon )
) );
addParameter( new QgsProcessingParameterField(
QStringLiteral( "UNIQUE_ID" ), QObject::tr( "Unique feature identifier" ), QString(), QStringLiteral( "INPUT" )
) );
addParameter( new QgsProcessingParameterFeatureSink(
QStringLiteral( "ERRORS" ), QObject::tr( "Errors layer" ), Qgis::ProcessingSourceType::VectorPoint
) );
addParameter( new QgsProcessingParameterFeatureSink(
QStringLiteral( "OUTPUT" ), QObject::tr( "Output layer" ), Qgis::ProcessingSourceType::VectorPolygon
) );
addParameter( new QgsProcessingParameterNumber(
QStringLiteral( "MIN_OVERLAP_AREA" ), QObject::tr( "min overlap area" ), Qgis::ProcessingNumberParameterType::Double, 0, false, 0.0, 180.0
) );
std::unique_ptr<QgsProcessingParameterNumber> tolerance = std::make_unique<QgsProcessingParameterNumber>(
QStringLiteral( "TOLERANCE" ), QObject::tr( "Tolerance" ), Qgis::ProcessingNumberParameterType::Integer, 8, false, 1, 13
);
tolerance->setFlags( tolerance->flags() | Qgis::ProcessingParameterFlag::Advanced );
addParameter( tolerance.release() );
}
bool QgsGeometryCheckOverlapAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
{
mTolerance = parameterAsInt( parameters, QStringLiteral( "TOLERANCE" ), context );
return true;
}
QgsFields QgsGeometryCheckOverlapAlgorithm::outputFields()
{
QgsFields fields;
fields.append( QgsField( QStringLiteral( "gc_layerid" ), QMetaType::QString ) );
fields.append( QgsField( QStringLiteral( "gc_layername" ), QMetaType::QString ) );
fields.append( QgsField( QStringLiteral( "gc_errorx" ), QMetaType::Double ) );
fields.append( QgsField( QStringLiteral( "gc_errory" ), QMetaType::Double ) );
fields.append( QgsField( QStringLiteral( "gc_error" ), QMetaType::Double ) );
return fields;
}
QVariantMap QgsGeometryCheckOverlapAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
{
QString dest_output;
QString dest_errors;
const std::unique_ptr<QgsProcessingFeatureSource> input( parameterAsSource( parameters, QStringLiteral( "INPUT" ), context ) );
if ( !input )
throw QgsProcessingException( invalidSourceError( parameters, QStringLiteral( "INPUT" ) ) );
QString uniqueIdFieldName( parameterAsString( parameters, QStringLiteral( "UNIQUE_ID" ), context ) );
int uniqueIdFieldIdx = input->fields().indexFromName( uniqueIdFieldName );
if ( uniqueIdFieldIdx == -1 )
throw QgsProcessingException( QObject::tr( "Missing field %1 in input layer" ).arg( uniqueIdFieldName ) );
const QgsField uniqueIdField = input->fields().at( uniqueIdFieldIdx );
QgsField overlapFeatureUniqueIdField = input->fields().at( uniqueIdFieldIdx );
overlapFeatureUniqueIdField.setName( "gc_overlap_feature_" + uniqueIdField.name() );
QgsFields fields = outputFields();
fields.append( uniqueIdField );
fields.append( overlapFeatureUniqueIdField );
const std::unique_ptr<QgsFeatureSink> sink_output( parameterAsSink(
parameters, QStringLiteral( "OUTPUT" ), context, dest_output, fields, input->wkbType(), input->sourceCrs()
) );
if ( !sink_output )
throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "OUTPUT" ) ) );
const std::unique_ptr<QgsFeatureSink> sink_errors( parameterAsSink(
parameters, QStringLiteral( "ERRORS" ), context, dest_errors, fields, Qgis::WkbType::Point, input->sourceCrs()
) );
if ( !sink_errors )
throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "ERRORS" ) ) );
QgsProcessingMultiStepFeedback multiStepFeedback( 3, feedback );
const QgsProject *project = QgsProject::instance();
QgsGeometryCheckContext checkContext = QgsGeometryCheckContext( mTolerance, input->sourceCrs(), project->transformContext(), project );
// Test detection
QList<QgsGeometryCheckError *> checkErrors;
QStringList messages;
const double minOverlapArea = parameterAsDouble( parameters, QStringLiteral( "MIN_OVERLAP_AREA" ), context );
QVariantMap configurationCheck;
configurationCheck.insert( "maxOverlapArea", minOverlapArea );
const QgsGeometryOverlapCheck check( &checkContext, configurationCheck );
multiStepFeedback.setCurrentStep( 1 );
feedback->setProgressText( QObject::tr( "Preparing features…" ) );
QMap<QString, QgsFeaturePool *> checkerFeaturePools;
std::unique_ptr<QgsVectorLayer> inputLayer( input->materialize( QgsFeatureRequest() ) );
QgsVectorDataProviderFeaturePool featurePool = QgsVectorDataProviderFeaturePool( inputLayer.get() );
checkerFeaturePools.insert( inputLayer->id(), &featurePool );
multiStepFeedback.setCurrentStep( 2 );
feedback->setProgressText( QObject::tr( "Collecting errors…" ) );
check.collectErrors( checkerFeaturePools, checkErrors, messages, feedback );
multiStepFeedback.setCurrentStep( 3 );
feedback->setProgressText( QObject::tr( "Exporting errors…" ) );
const double step { checkErrors.size() > 0 ? 100.0 / checkErrors.size() : 1 };
long i = 0;
feedback->setProgress( 0.0 );
for ( const QgsGeometryCheckError *error : checkErrors )
{
const QgsGeometryOverlapCheckError *overlapError = dynamic_cast<const QgsGeometryOverlapCheckError *>( error );
if ( !overlapError )
break;
if ( feedback->isCanceled() )
break;
QgsFeature f;
QgsAttributes attrs = f.attributes();
attrs << error->layerId()
<< inputLayer->name()
<< error->location().x()
<< error->location().y()
<< error->value().toDouble()
<< inputLayer->getFeature( error->featureId() ).attribute( uniqueIdField.name() )
<< inputLayer->getFeature( overlapError->overlappedFeature().featureId() ).attribute( uniqueIdField.name() );
f.setAttributes( attrs );
f.setGeometry( error->geometry() );
if ( !sink_output->addFeature( f, QgsFeatureSink::FastInsert ) )
throw QgsProcessingException( writeFeatureError( sink_output.get(), parameters, QStringLiteral( "OUTPUT" ) ) );
f.setGeometry( QgsGeometry::fromPoint( QgsPoint( error->location().x(), error->location().y() ) ) );
if ( !sink_errors->addFeature( f, QgsFeatureSink::FastInsert ) )
throw QgsProcessingException( writeFeatureError( sink_errors.get(), parameters, QStringLiteral( "ERRORS" ) ) );
i++;
feedback->setProgress( 100.0 * step * static_cast<double>( i ) );
}
// Place the point layer above the polygon layer
if ( context.willLoadLayerOnCompletion( dest_output ) && context.willLoadLayerOnCompletion( dest_errors ) )
{
context.layerToLoadOnCompletionDetails( dest_errors ).layerSortKey = 0;
context.layerToLoadOnCompletionDetails( dest_output ).layerSortKey = 1;
}
QVariantMap outputs;
outputs.insert( QStringLiteral( "OUTPUT" ), dest_output );
outputs.insert( QStringLiteral( "ERRORS" ), dest_errors );
return outputs;
}
///@endcond

View File

@ -0,0 +1,53 @@
/***************************************************************************
qgsalgorithmcheckgeometryoverlap.h
---------------------
begin : April 2025
copyright : (C) 2025 by Jacky Volpes
email : jacky dot volpes at oslandia 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. *
* *
***************************************************************************/
#ifndef QGSALGORITHMCHECKGEOMETRYOVERLAP_H
#define QGSALGORITHMCHECKGEOMETRYOVERLAP_H
#define SIP_NO_FILE
#include "qgis_sip.h"
#include "qgsprocessingalgorithm.h"
///@cond PRIVATE
class QgsGeometryCheckOverlapAlgorithm : public QgsProcessingAlgorithm
{
public:
QgsGeometryCheckOverlapAlgorithm() = default;
void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
QString name() const override;
QString displayName() const override;
QStringList tags() const override;
QString group() const override;
QString groupId() const override;
QString shortHelpString() const override;
Qgis::ProcessingAlgorithmFlags flags() const override;
QgsGeometryCheckOverlapAlgorithm *createInstance() const override SIP_FACTORY;
protected:
bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
private:
static QgsFields outputFields();
int mTolerance { 8 };
};
///@endcond PRIVATE
#endif // QGSALGORITHMCHECKGEOMETRYOVERLAP_H

View File

@ -51,6 +51,7 @@
#include "qgsalgorithmfixgeometrymissingvertex.h"
#include "qgsalgorithmcheckgeometryhole.h"
#include "qgsalgorithmcheckgeometrymissingvertex.h"
#include "qgsalgorithmcheckgeometryoverlap.h"
#include "qgsalgorithmcheckgeometryfollowboundaries.h"
#include "qgsalgorithmcheckgeometryduplicatenodes.h"
#include "qgsalgorithmcheckgeometrydangle.h"
@ -348,6 +349,7 @@ void QgsNativeAlgorithms::loadAlgorithms()
addAlgorithm( new QgsGeometryCheckAreaAlgorithm() );
addAlgorithm( new QgsGeometryCheckHoleAlgorithm() );
addAlgorithm( new QgsGeometryCheckMissingVertexAlgorithm() );
addAlgorithm( new QgsGeometryCheckOverlapAlgorithm() );
addAlgorithm( new QgsGeometryCheckFollowBoundariesAlgorithm() );
addAlgorithm( new QgsGeometryCheckDuplicateNodesAlgorithm() );
addAlgorithm( new QgsGeometryCheckDangleAlgorithm() );

View File

@ -55,6 +55,8 @@ class TestQgsProcessingCheckGeometry : public QgsTest
void followBoundariesAlg();
void overlapAlg();
void areaAlg();
void holeAlg();
void missingVertexAlg();
@ -498,5 +500,35 @@ void TestQgsProcessingCheckGeometry::followBoundariesAlg()
QCOMPARE( errorsLayer->featureCount(), 2 );
}
void TestQgsProcessingCheckGeometry::overlapAlg()
{
std::unique_ptr< QgsProcessingAlgorithm > alg(
QgsApplication::processingRegistry()->createAlgorithmById( QStringLiteral( "native:checkgeometryoverlap" ) )
);
QVERIFY( alg != nullptr );
QVariantMap parameters;
parameters.insert( QStringLiteral( "INPUT" ), QVariant::fromValue( mPolygonLayer ) );
parameters.insert( QStringLiteral( "UNIQUE_ID" ), "id" );
parameters.insert( QStringLiteral( "MIN_OVERLAP_AREA" ), 0.01 );
parameters.insert( QStringLiteral( "OUTPUT" ), QgsProcessing::TEMPORARY_OUTPUT );
parameters.insert( QStringLiteral( "ERRORS" ), QgsProcessing::TEMPORARY_OUTPUT );
bool ok = false;
QgsProcessingFeedback feedback;
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
QVariantMap results;
results = alg->run( parameters, *context, &feedback, &ok );
QVERIFY( ok );
std::unique_ptr<QgsVectorLayer> outputLayer( qobject_cast< QgsVectorLayer * >( context->getMapLayer( results.value( QStringLiteral( "OUTPUT" ) ).toString() ) ) );
std::unique_ptr<QgsVectorLayer> errorsLayer( qobject_cast< QgsVectorLayer * >( context->getMapLayer( results.value( QStringLiteral( "ERRORS" ) ).toString() ) ) );
QVERIFY( outputLayer->isValid() );
QVERIFY( errorsLayer->isValid() );
QCOMPARE( outputLayer->featureCount(), 2 );
QCOMPARE( errorsLayer->featureCount(), 2 );
}
QGSTEST_MAIN( TestQgsProcessingCheckGeometry )
#include "testqgsprocessingcheckgeometry.moc"
#include "testqgsprocessingcheckgeometry.moc"