QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
qgsalgorithmpolygonize.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmdpolygonize.cpp
3 ---------------------
4 begin : May 2020
5 copyright : (C) 2020 by Alexander Bruy
6 email : alexander dot bruy 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
20
22
23QString QgsPolygonizeAlgorithm::name() const
24{
25 return QStringLiteral( "polygonize" );
26}
27
28QString QgsPolygonizeAlgorithm::displayName() const
29{
30 return QObject::tr( "Polygonize" );
31}
32
33QString QgsPolygonizeAlgorithm::shortHelpString() const
34{
35 return QObject::tr( "Creates a polygon layer from the input lines layer." );
36}
37
38QStringList QgsPolygonizeAlgorithm::tags() const
39{
40 return QObject::tr( "create,lines,polygons,convert" ).split( ',' );
41}
42
43QString QgsPolygonizeAlgorithm::group() const
44{
45 return QObject::tr( "Vector geometry" );
46}
47
48QString QgsPolygonizeAlgorithm::groupId() const
49{
50 return QStringLiteral( "vectorgeometry" );
51}
52
53void QgsPolygonizeAlgorithm::initAlgorithm( const QVariantMap & )
54{
55 addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ), QList<int>() << static_cast<int>( Qgis::ProcessingSourceType::VectorLine ) ) );
56 addParameter( new QgsProcessingParameterBoolean( QStringLiteral( "KEEP_FIELDS" ), QObject::tr( "Keep table structure of line layer" ), false ) );
57 addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Polygons" ), Qgis::ProcessingSourceType::VectorPolygon ) );
58 addOutput( new QgsProcessingOutputNumber( QStringLiteral( "NUM_POLYGONS" ), QObject::tr( "Number of polygons" ) ) );
59}
60
61QgsPolygonizeAlgorithm *QgsPolygonizeAlgorithm::createInstance() const
62{
63 return new QgsPolygonizeAlgorithm();
64}
65
66QVariantMap QgsPolygonizeAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
67{
68 std::unique_ptr<QgsProcessingFeatureSource> source( parameterAsSource( parameters, QStringLiteral( "INPUT" ), context ) );
69 if ( !source )
70 throw QgsProcessingException( invalidSourceError( parameters, QStringLiteral( "INPUT" ) ) );
71
72 QgsFields fields = QgsFields();
73 if ( parameterAsBoolean( parameters, QStringLiteral( "KEEP_FIELDS" ), context ) )
74 fields = source->fields();
75
76 QString dest;
77 std::unique_ptr<QgsFeatureSink> sink( parameterAsSink( parameters, QStringLiteral( "OUTPUT" ), context, dest, fields, Qgis::WkbType::Polygon, source->sourceCrs() ) );
78 if ( !sink )
79 throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "OUTPUT" ) ) );
80
81 int polygonCount = 0;
82
83 feedback->pushInfo( QObject::tr( "Collecting lines…" ) );
84 const int i = 0;
85 double step = source->featureCount() > 0 ? 40.0 / source->featureCount() : 1;
86 QgsFeature f;
87 QgsFeatureIterator features = source->getFeatures( QgsFeatureRequest().setNoAttributes() );
88 QVector<QgsGeometry> linesList;
89 linesList.reserve( source->featureCount() );
90 while ( features.nextFeature( f ) )
91 {
92 if ( feedback->isCanceled() )
93 break;
94
95 if ( f.hasGeometry() )
96 linesList << f.geometry();
97
98 feedback->setProgress( i * step );
99 }
100 feedback->setProgress( 40 );
101
102 feedback->pushInfo( QObject::tr( "Noding lines…" ) );
103 const QgsGeometry lines = QgsGeometry::unaryUnion( linesList );
104 if ( feedback->isCanceled() )
105 return QVariantMap();
106 feedback->setProgress( 45 );
107
108 feedback->pushInfo( QObject::tr( "Polygonizing…" ) );
109 const QgsGeometry polygons = QgsGeometry::polygonize( QVector<QgsGeometry>() << lines );
110 if ( polygons.isEmpty() )
111 feedback->reportError( QObject::tr( "No polygons were created." ) );
112
113 feedback->setProgress( 50 );
114
115 if ( !polygons.isEmpty() )
116 {
117 const QgsGeometryCollection *collection = qgsgeometry_cast<const QgsGeometryCollection *>( polygons.constGet() );
118 step = collection->numGeometries() > 0 ? 50.0 / collection->numGeometries() : 1;
119 for ( int part = 0; part < collection->numGeometries(); ++part )
120 {
121 if ( feedback->isCanceled() )
122 break;
123
124 QgsFeature outFeat;
125 outFeat.setGeometry( QgsGeometry( collection->geometryN( part )->clone() ) );
126 if ( !sink->addFeature( outFeat, QgsFeatureSink::FastInsert ) )
127 throw QgsProcessingException( writeFeatureError( sink.get(), parameters, QStringLiteral( "OUTPUT" ) ) );
128 feedback->setProgress( 50 + i * step );
129 polygonCount += 1;
130 }
131 }
132
133 sink->finalize();
134
135 QVariantMap outputs;
136 outputs.insert( QStringLiteral( "OUTPUT" ), dest );
137 outputs.insert( QStringLiteral( "NUM_POLYGONS" ), polygonCount );
138 return outputs;
139}
140
@ VectorPolygon
Vector polygon layers.
@ VectorLine
Vector line layers.
@ Polygon
Polygon.
virtual QgsAbstractGeometry * clone() const =0
Clones the geometry by performing a deep copy.
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
This class 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
QgsGeometry geometry
Definition qgsfeature.h:69
bool hasGeometry() const
Returns true if the feature has an associated geometry.
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
Container of fields for a vector layer.
Definition qgsfields.h:46
int numGeometries() const
Returns the number of geometries within the collection.
const QgsAbstractGeometry * geometryN(int n) const
Returns a const reference to a geometry from within the collection.
A geometry is the spatial representation of a feature.
static QgsGeometry polygonize(const QVector< QgsGeometry > &geometries)
Creates a GeometryCollection geometry containing possible polygons formed from the constituent linewo...
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
bool isEmpty() const
Returns true if the geometry is empty (eg a linestring with no vertices, or a collection with no geom...
static QgsGeometry unaryUnion(const QVector< QgsGeometry > &geometries, const QgsGeometryParameters &parameters=QgsGeometryParameters())
Compute the unary union on a list of geometries.
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 pushInfo(const QString &info)
Pushes a general informational message from the algorithm.
virtual void reportError(const QString &error, bool fatalError=false)
Reports that the algorithm encountered an error while executing.
A numeric output for processing algorithms.
A boolean parameter for processing algorithms.
A feature sink output for processing algorithms.
An input feature source (such as vector layers) parameter for processing algorithms.