From f1c365c14838b48223947df1d37cb07011219eb9 Mon Sep 17 00:00:00 2001 From: Jacky Volpes Date: Fri, 12 Jan 2024 12:32:12 +0100 Subject: [PATCH] Processing: Add Check Geometry algorithm and test: Degenerate polygon --- src/analysis/CMakeLists.txt | 1 + ...lgorithmcheckgeometrydegeneratepolygon.cpp | 197 ++++++++++++++++++ ...salgorithmcheckgeometrydegeneratepolygon.h | 59 ++++++ .../processing/qgsnativealgorithms.cpp | 2 + .../testqgsprocessingcheckgeometry.cpp | 30 +++ 5 files changed, 289 insertions(+) create mode 100644 src/analysis/processing/qgsalgorithmcheckgeometrydegeneratepolygon.cpp create mode 100644 src/analysis/processing/qgsalgorithmcheckgeometrydegeneratepolygon.h diff --git a/src/analysis/CMakeLists.txt b/src/analysis/CMakeLists.txt index ef969b6c931b..3f9818916c39 100644 --- a/src/analysis/CMakeLists.txt +++ b/src/analysis/CMakeLists.txt @@ -67,6 +67,7 @@ set(QGIS_ANALYSIS_SRCS processing/qgsalgorithmcheckgeometryangle.cpp processing/qgsalgorithmcheckgeometryselfintersection.cpp processing/qgsalgorithmcheckgeometrylinelayerintersection.cpp + processing/qgsalgorithmcheckgeometrydegeneratepolygon.cpp processing/qgsalgorithmclip.cpp processing/qgsalgorithmconcavehull.cpp processing/qgsalgorithmconditionalbranch.cpp diff --git a/src/analysis/processing/qgsalgorithmcheckgeometrydegeneratepolygon.cpp b/src/analysis/processing/qgsalgorithmcheckgeometrydegeneratepolygon.cpp new file mode 100644 index 000000000000..7bf47bf6ed36 --- /dev/null +++ b/src/analysis/processing/qgsalgorithmcheckgeometrydegeneratepolygon.cpp @@ -0,0 +1,197 @@ +/*************************************************************************** + qgsalgorithmcheckgeometrydegeneratepolygon.cpp + --------------------- + begin : January 2024 + copyright : (C) 2024 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 "qgsalgorithmcheckgeometrydegeneratepolygon.h" +#include "qgsgeometrycheckcontext.h" +#include "qgsgeometrycheckerror.h" +#include "qgsgeometrydegeneratepolygoncheck.h" +#include "qgspoint.h" +#include "qgsvectorlayer.h" +#include "qgsvectordataproviderfeaturepool.h" + +///@cond PRIVATE + +auto QgsGeometryCheckDegeneratePolygonAlgorithm::name() const -> QString +{ + return QStringLiteral( "checkgeometrydegeneratepolygon" ); +} + +auto QgsGeometryCheckDegeneratePolygonAlgorithm::displayName() const -> QString +{ + return QObject::tr( "Check Geometry (Degenerate polygon)" ); +} + +auto QgsGeometryCheckDegeneratePolygonAlgorithm::tags() const -> QStringList +{ + return QObject::tr( "check,geometry,degeneratepolygon" ).split( ',' ); +} + +auto QgsGeometryCheckDegeneratePolygonAlgorithm::group() const -> QString +{ + return QObject::tr( "Check geometry" ); +} + +auto QgsGeometryCheckDegeneratePolygonAlgorithm::groupId() const -> QString +{ + return QStringLiteral( "checkgeometry" ); +} + +auto QgsGeometryCheckDegeneratePolygonAlgorithm::shortHelpString() const -> QString +{ + return QObject::tr( "This algorithm check the degeneratepolygon of geometry." ); +} + +auto QgsGeometryCheckDegeneratePolygonAlgorithm::flags() const -> QgsProcessingAlgorithm::Flags +{ + return QgsProcessingAlgorithm::flags() | QgsProcessingAlgorithm::FlagNoThreading; +} + +auto QgsGeometryCheckDegeneratePolygonAlgorithm::createInstance() const -> QgsGeometryCheckDegeneratePolygonAlgorithm * +{ + return new QgsGeometryCheckDegeneratePolygonAlgorithm(); +} + +void QgsGeometryCheckDegeneratePolygonAlgorithm::initAlgorithm( const QVariantMap &configuration ) +{ + Q_UNUSED( configuration ) + + addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ), QList< int >() << QgsProcessing::TypeVectorPolygon ) ); + addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "ERRORS" ), QObject::tr( "Errors layer" ), QgsProcessing::TypeVectorPoint ) ); + addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Output layer" ), QgsProcessing::TypeVectorAnyGeometry ) ); + + std::unique_ptr< QgsProcessingParameterNumber > tolerance = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral( "TOLERANCE" ), + QObject::tr( "Tolerance" ), QgsProcessingParameterNumber::Integer, 8, false, 1, 13 ); + tolerance->setFlags( tolerance->flags() | QgsProcessingParameterDefinition::FlagAdvanced ); + addParameter( tolerance.release() ); +} + +auto QgsGeometryCheckDegeneratePolygonAlgorithm::prepareAlgorithm( const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback * ) -> bool +{ + mTolerance = parameterAsInt( parameters, QStringLiteral( "TOLERANCE" ), context ); + return true; +} + +auto QgsGeometryCheckDegeneratePolygonAlgorithm::createFeaturePool( QgsVectorLayer *layer, bool selectedOnly ) const -> QgsFeaturePool * +{ + return new QgsVectorDataProviderFeaturePool( layer, selectedOnly ); +} + +static auto outputFields( ) -> QgsFields +{ + QgsFields fields; + fields.append( QgsField( QStringLiteral( "gc_layerid" ), QVariant::String ) ); + fields.append( QgsField( QStringLiteral( "gc_layername" ), QVariant::String ) ); + fields.append( QgsField( QStringLiteral( "gc_featid" ), QVariant::Int ) ); + fields.append( QgsField( QStringLiteral( "gc_partidx" ), QVariant::Int ) ); + fields.append( QgsField( QStringLiteral( "gc_ringidx" ), QVariant::Int ) ); + fields.append( QgsField( QStringLiteral( "gc_vertidx" ), QVariant::Int ) ); + fields.append( QgsField( QStringLiteral( "gc_errorx" ), QVariant::Double ) ); + fields.append( QgsField( QStringLiteral( "gc_errory" ), QVariant::Double ) ); + fields.append( QgsField( QStringLiteral( "gc_error" ), QVariant::String ) ); + return fields; +} + + +auto QgsGeometryCheckDegeneratePolygonAlgorithm::processAlgorithm( const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) -> QVariantMap +{ + QString dest_output; + QString dest_errors; + std::unique_ptr< QgsProcessingFeatureSource > source( parameterAsSource( parameters, QStringLiteral( "INPUT" ), context ) ); + if ( !source ) + throw QgsProcessingException( invalidSourceError( parameters, QStringLiteral( "INPUT" ) ) ); + + mInputLayer.reset( source->materialize( QgsFeatureRequest() ) ); + + if ( !mInputLayer.get() ) + throw QgsProcessingException( QObject::tr( "Could not load source layer for INPUT" ) ); + + QgsFields fields = outputFields(); + + std::unique_ptr< QgsFeatureSink > sink_output( parameterAsSink( parameters, QStringLiteral( "OUTPUT" ), context, dest_output, fields, mInputLayer->wkbType(), mInputLayer->sourceCrs() ) ); + if ( !sink_output ) + throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "OUTPUT" ) ) ); + + std::unique_ptr< QgsFeatureSink > sink_errors( parameterAsSink( parameters, QStringLiteral( "ERRORS" ), context, dest_errors, fields, Qgis::WkbType::Point, mInputLayer->sourceCrs() ) ); + if ( !sink_errors ) + throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "ERRORS" ) ) ); + + QgsProcessingMultiStepFeedback multiStepFeedback( 3, feedback ); + + QgsProject *project = mInputLayer->project() ? mInputLayer->project() : QgsProject::instance(); + std::unique_ptr checkContext = std::make_unique( mTolerance, mInputLayer->sourceCrs(), project->transformContext(), project ); + + // Test detection + QList checkErrors; + QStringList messages; + + const QgsGeometryDegeneratePolygonCheck check( checkContext.get(), QVariantMap() ); + + multiStepFeedback.setCurrentStep( 1 ); + feedback->setProgressText( QObject::tr( "Preparing features…" ) ); + QMap featurePools; + featurePools.insert( mInputLayer->id(), createFeaturePool( mInputLayer.get() ) ); + + multiStepFeedback.setCurrentStep( 2 ); + feedback->setProgressText( QObject::tr( "Collecting errors…" ) ); + check.collectErrors( featurePools, checkErrors, messages, feedback ); + + multiStepFeedback.setCurrentStep( 3 ); + feedback->setProgressText( QObject::tr( "Exporting errors…" ) ); + double step{checkErrors.size() > 0 ? 100.0 / checkErrors.size() : 1}; + long i = 0; + feedback->setProgress( 0.0 ); + + for ( QgsGeometryCheckError *error : checkErrors ) + { + + if ( feedback->isCanceled() ) + break; + + QgsFeature f; + QgsAttributes attrs = f.attributes(); + + attrs << error->layerId() + << mInputLayer->name() + << error->featureId() + << error->vidx().part + << error->vidx().ring + << error->vidx().vertex + << error->location().x() + << error->location().y() + << error->value().toString(); + 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( i ) ); + } + + QVariantMap outputs; + outputs.insert( QStringLiteral( "OUTPUT" ), dest_output ); + outputs.insert( QStringLiteral( "ERRORS" ), dest_errors ); + + return outputs; +} + +///@endcond diff --git a/src/analysis/processing/qgsalgorithmcheckgeometrydegeneratepolygon.h b/src/analysis/processing/qgsalgorithmcheckgeometrydegeneratepolygon.h new file mode 100644 index 000000000000..a7e739256de4 --- /dev/null +++ b/src/analysis/processing/qgsalgorithmcheckgeometrydegeneratepolygon.h @@ -0,0 +1,59 @@ +/*************************************************************************** + qgsalgorithmcheckgeometrydegeneratepolygon.h + --------------------- + begin : January 2024 + copyright : (C) 2024 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 QGSALGORITHMCHECKGEOMETRYDEGENERATEPOLYGON_H +#define QGSALGORITHMCHECKGEOMETRYDEGENERATEPOLYGON_H + +#define SIP_NO_FILE + +#include "qgis_sip.h" +#include "qgsprocessingalgorithm.h" +#include "qgsfeaturepool.h" + +///@cond PRIVATE + +class QgsGeometryCheckDegeneratePolygonAlgorithm : public QgsProcessingAlgorithm +{ + public: + + QgsGeometryCheckDegeneratePolygonAlgorithm() = 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; + Flags flags() const override; + QgsGeometryCheckDegeneratePolygonAlgorithm *createInstance() const override SIP_FACTORY; + + protected: + + bool prepareAlgorithm( const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override; + QVariantMap processAlgorithm( const QVariantMap ¶meters, + QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override; + + private: + QgsFeaturePool *createFeaturePool( QgsVectorLayer *layer, bool selectedOnly = false ) const; + + std::unique_ptr< QgsVectorLayer > mInputLayer; + int mTolerance{8}; +}; + +///@endcond PRIVATE + +#endif // QGSALGORITHMCHECKGEOMETRYDEGENERATEPOLYGON_H diff --git a/src/analysis/processing/qgsnativealgorithms.cpp b/src/analysis/processing/qgsnativealgorithms.cpp index 7a3383e1b782..161377b34a1c 100644 --- a/src/analysis/processing/qgsnativealgorithms.cpp +++ b/src/analysis/processing/qgsnativealgorithms.cpp @@ -48,6 +48,7 @@ #include "qgsalgorithmcheckgeometryangle.h" #include "qgsalgorithmcheckgeometryselfintersection.h" #include "qgsalgorithmcheckgeometrylinelayerintersection.h" +#include "qgsalgorithmcheckgeometrydegeneratepolygon.h" #include "qgsalgorithmclip.h" #include "qgsalgorithmconcavehull.h" #include "qgsalgorithmconditionalbranch.h" @@ -322,6 +323,7 @@ void QgsNativeAlgorithms::loadAlgorithms() addAlgorithm( new QgsGeometryCheckAngleAlgorithm() ); addAlgorithm( new QgsGeometryCheckSelfIntersectionAlgorithm() ); addAlgorithm( new QgsGeometryCheckLineLayerIntersectionAlgorithm() ); + addAlgorithm( new QgsGeometryCheckDegeneratePolygonAlgorithm() ); addAlgorithm( new QgsClipAlgorithm() ); addAlgorithm( new QgsCollectAlgorithm() ); addAlgorithm( new QgsCombineStylesAlgorithm() ); diff --git a/tests/src/analysis/testqgsprocessingcheckgeometry.cpp b/tests/src/analysis/testqgsprocessingcheckgeometry.cpp index c472572dd51d..12203632701f 100644 --- a/tests/src/analysis/testqgsprocessingcheckgeometry.cpp +++ b/tests/src/analysis/testqgsprocessingcheckgeometry.cpp @@ -35,6 +35,7 @@ class TestQgsProcessingCheckGeometry: public QgsTest void areaAlg(); void dangleAlg(); void lineLayerIntersectionAlg(); + void degeneratePolygon(); void angleAlg_data(); void angleAlg(); @@ -330,5 +331,34 @@ void TestQgsProcessingCheckGeometry::lineLayerIntersectionAlg() QCOMPARE( errorsLayer->featureCount(), 5 ); } +void TestQgsProcessingCheckGeometry::degeneratePolygon() +{ + std::unique_ptr< QgsProcessingAlgorithm > alg( + QgsApplication::processingRegistry()->createAlgorithmById( QStringLiteral( "native:checkgeometrydegeneratepolygon" ) ) + ); + QVERIFY( alg != nullptr ); + + QVariantMap parameters; + parameters.insert( QStringLiteral( "INPUT" ), QVariant::fromValue( mPolygonLayer ) ); + 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 outputLayer( qobject_cast< QgsVectorLayer * >( context->getMapLayer( results.value( QStringLiteral( "OUTPUT" ) ).toString() ) ) ); + std::unique_ptr errorsLayer( qobject_cast< QgsVectorLayer * >( context->getMapLayer( results.value( QStringLiteral( "ERRORS" ) ).toString() ) ) ); + QVERIFY( outputLayer->isValid() ); + QVERIFY( errorsLayer->isValid() ); + QCOMPARE( outputLayer->featureCount(), 1 ); + QCOMPARE( errorsLayer->featureCount(), 1 ); +} + + QGSTEST_MAIN( TestQgsProcessingCheckGeometry ) #include "testqgsprocessingcheckgeometry.moc"