QGIS API Documentation 3.41.0-Master (cea29feecf2)
Loading...
Searching...
No Matches
qgsvectorwarper.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsgcptransformer.cpp
3 --------------------------------------
4 Date : February 2022
5 Copyright : (C) 2022 by Nyall Dawson
6 Email : nyall dot dawson at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#include "qgsvectorwarper.h"
17#include "moc_qgsvectorwarper.cpp"
18#include "qgsfeaturesink.h"
19#include "qgsfeedback.h"
21#include "qgsvectorlayer.h"
22#include "qgsvectorfilewriter.h"
23
24#include <QObject>
25#include <QFileInfo>
26
28 : mMethod( method )
29 , mPoints( points )
30 , mDestinationCrs( destinationCrs )
31{
32}
33
35{
36 if ( !sink )
37 return false;
38
39 QVector<QgsPointXY> sourcePoints;
40 sourcePoints.reserve( mPoints.size() );
41 QVector<QgsPointXY> destinationPoints;
42 destinationPoints.reserve( mPoints.size() );
43 for ( const QgsGcpPoint &gcpPoint : mPoints )
44 {
45 sourcePoints << gcpPoint.sourcePoint();
46 destinationPoints << gcpPoint.transformedDestinationPoint( mDestinationCrs, context );
47 }
48
49 if ( feedback && feedback->isCanceled() )
50 return false;
51
52 QgsGcpGeometryTransformer transformer( mMethod, sourcePoints, destinationPoints );
53
54 QgsFeature f;
55
56 long long i = 0;
57 while ( iterator.nextFeature( f ) )
58 {
59 if ( feedback )
60 {
61 if ( feedback->isCanceled() )
62 break;
63
64 feedback->setProcessedCount( i );
65 }
66 i++;
67
68 QgsFeature outputFeature = f;
69 bool ok = false;
70 const QgsGeometry transformed = transformer.transform( f.geometry(), ok, feedback );
71 if ( ok )
72 {
73 outputFeature.setGeometry( transformed );
74 if ( !sink->addFeature( outputFeature, QgsFeatureSink::FastInsert ) )
75 {
76 mError = sink->lastError();
77 return false;
78 }
79 }
80 else
81 {
82 mError = QObject::tr( "An error occurred while transforming a feature" );
83 return false;
84 }
85 }
86 return true;
87}
88
89
90//
91// QgsVectorWarperTask
92//
93
94QgsVectorWarperTask::QgsVectorWarperTask( QgsGcpTransformerInterface::TransformMethod method, const QList<QgsGcpPoint> &points, const QgsCoordinateReferenceSystem &destinationCrs, QgsVectorLayer *layer, const QString &fileName )
95 : QgsTask( tr( "Warping %1" ).arg( fileName ), QgsTask::CanCancel )
96 , mMethod( method )
97 , mPoints( points )
98 , mDestinationCrs( destinationCrs )
99 , mDestFileName( fileName )
100{
101 if ( layer )
102 {
103 mTransformContext = layer->transformContext();
104 mSource.reset( new QgsVectorLayerFeatureSource( layer ) );
105 mFeatureCount = layer->featureCount();
106 mFields = layer->fields();
107 mWkbType = layer->wkbType();
108 }
109}
110
112{
113 if ( mFeedback )
114 mFeedback->cancel();
115
117}
118
120{
121 mFeedback = std::make_unique<QgsFeedback>();
122
124
125 const QString fileExtension = QFileInfo( mDestFileName ).completeSuffix();
126 saveOptions.driverName = QgsVectorFileWriter::driverForExtension( fileExtension );
127
128 std::unique_ptr<QgsVectorFileWriter> exporter( QgsVectorFileWriter::create( mDestFileName, mFields, mWkbType, mDestinationCrs, mTransformContext, saveOptions ) );
129 if ( exporter->hasError() )
130 {
131 mErrorMessage = exporter->errorMessage();
132 mResult = Result::Error;
133 return false;
134 }
135
136 QgsVectorWarper warper( mMethod, mPoints, mDestinationCrs );
137
138 connect( mFeedback.get(), &QgsFeedback::processedCountChanged, this, [=]( long long count ) {
139 const double newProgress = 100.0 * count / mFeatureCount;
140 // avoid flooding with too many events
141 if ( static_cast<int>( newProgress * 10 ) != static_cast<int>( mLastProgress * 10 ) )
142 {
143 mLastProgress = newProgress;
144 emit progressChanged( newProgress );
145 }
146 } );
147
148 QgsFeatureIterator iterator = mSource->getFeatures();
149 const bool res = warper.transformFeatures( iterator, exporter.get(), mTransformContext, mFeedback.get() );
150 if ( !res )
151 {
152 mErrorMessage = warper.error();
153 mResult = Result::Error;
154 }
155
156 mResult = mFeedback->isCanceled() ? Result::Canceled : Result::Success;
157 mFeedback.reset();
158 return mResult == Result::Success;
159}
This class represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
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.
An interface for objects which accept features via addFeature(s) methods.
virtual bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags())
Adds a single feature to the sink.
@ FastInsert
Use faster inserts, at the cost of updating the passed features to reflect changes made at the provid...
virtual QString lastError() const
Returns the most recent error encountered by the sink, e.g.
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
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
bool isCanceled() const
Tells whether the operation has been canceled already.
Definition qgsfeedback.h:53
void setProcessedCount(unsigned long long processedCount)
Sets the current processed objects count for the feedback object.
Definition qgsfeedback.h:96
void processedCountChanged(unsigned long long processedCount)
Emitted when the feedback object reports a change in the number of processed objects.
A geometry transformer which uses an underlying Ground Control Points (GCP) based transformation to m...
QgsGeometry transform(const QgsGeometry &geometry, bool &ok, QgsFeedback *feedback=nullptr)
Transforms the specified input geometry using the GCP based transform.
Contains properties of a ground control point (GCP).
Definition qgsgcppoint.h:31
TransformMethod
Available transformation methods.
A geometry is the spatial representation of a feature.
QgsCoordinateTransformContext transformContext() const
Returns the layer data provider coordinate transform context or a default transform context if the la...
Abstract base class for long running background tasks.
virtual void cancel()
Notifies the task that it should terminate.
Options to pass to writeAsVectorFormat()
static QString driverForExtension(const QString &extension)
Returns the OGR driver name for a specified file extension.
static QgsVectorFileWriter * create(const QString &fileName, const QgsFields &fields, Qgis::WkbType geometryType, const QgsCoordinateReferenceSystem &srs, const QgsCoordinateTransformContext &transformContext, const QgsVectorFileWriter::SaveVectorOptions &options, QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), QString *newFilename=nullptr, QString *newLayer=nullptr)
Create a new vector file writer.
Partial snapshot of vector layer's state (only the members necessary for access to features)
Represents a vector layer which manages a vector based data sets.
long long featureCount(const QString &legendKey) const
Number of features rendered with specified legend key.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
bool run() override
Performs the task's operation.
@ Error
An error occurred while warping.
void cancel() override
Notifies the task that it should terminate.
QgsVectorWarperTask(QgsGcpTransformerInterface::TransformMethod method, const QList< QgsGcpPoint > &points, const QgsCoordinateReferenceSystem &destinationCrs, QgsVectorLayer *layer, const QString &fileName)
Constructor for QgsVectorWarperTask.
Vector layer warper which warps vector layers based on a list of source and destination GCPs.
bool transformFeatures(QgsFeatureIterator &iterator, QgsFeatureSink *sink, const QgsCoordinateTransformContext &context, QgsFeedback *feedback=nullptr) const
Transforms the features from iterator and adds the results to the specified sink.
QgsVectorWarper(QgsGcpTransformerInterface::TransformMethod method, const QList< QgsGcpPoint > &points, const QgsCoordinateReferenceSystem &destinationCrs)
Constructor for QgsVectorWarper.