QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
qgsalgorithmshortestpathlayertopoint.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmshortestpathlayertopoint.cpp
3 ---------------------
4 begin : July 2018
5 copyright : (C) 2018 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
19
20#include "qgsgraphanalyzer.h"
21
22#include "qgsmessagelog.h"
23
25
26QString QgsShortestPathLayerToPointAlgorithm::name() const
27{
28 return QStringLiteral( "shortestpathlayertopoint" );
29}
30
31QString QgsShortestPathLayerToPointAlgorithm::displayName() const
32{
33 return QObject::tr( "Shortest path (layer to point)" );
34}
35
36QStringList QgsShortestPathLayerToPointAlgorithm::tags() const
37{
38 return QObject::tr( "network,path,shortest,fastest" ).split( ',' );
39}
40
41QString QgsShortestPathLayerToPointAlgorithm::shortHelpString() const
42{
43 return QObject::tr( "This algorithm computes optimal (shortest or fastest) route from multiple start points defined by vector layer and given end point." );
44}
45
46QgsShortestPathLayerToPointAlgorithm *QgsShortestPathLayerToPointAlgorithm::createInstance() const
47{
48 return new QgsShortestPathLayerToPointAlgorithm();
49}
50
51void QgsShortestPathLayerToPointAlgorithm::initAlgorithm( const QVariantMap & )
52{
53 addCommonParams();
54 addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "START_POINTS" ), QObject::tr( "Vector layer with start points" ), QList< int >() << static_cast< int >( Qgis::ProcessingSourceType::VectorPoint ) ) );
55 addParameter( new QgsProcessingParameterPoint( QStringLiteral( "END_POINT" ), QObject::tr( "End point" ) ) );
56
57 std::unique_ptr< QgsProcessingParameterNumber > maxEndPointDistanceFromNetwork = std::make_unique < QgsProcessingParameterDistance >( QStringLiteral( "POINT_TOLERANCE" ), QObject::tr( "Maximum point distance from network" ), QVariant(), QStringLiteral( "INPUT" ), true, 0 );
58 maxEndPointDistanceFromNetwork->setFlags( maxEndPointDistanceFromNetwork->flags() | Qgis::ProcessingParameterFlag::Advanced );
59 maxEndPointDistanceFromNetwork->setHelp( QObject::tr( "Specifies an optional limit on the distance from the start and end points to the network layer. If the start feature is further from the network than this distance it will be treated as non-routable. If the end point is further from the network than this distance an error will be raised." ) );
60 addParameter( maxEndPointDistanceFromNetwork.release() );
61
62 addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Shortest path" ), Qgis::ProcessingSourceType::VectorLine ) );
63
64 std::unique_ptr< QgsProcessingParameterFeatureSink > outputNonRoutable = std::make_unique< QgsProcessingParameterFeatureSink >( QStringLiteral( "OUTPUT_NON_ROUTABLE" ), QObject::tr( "Non-routable features" ),
66 outputNonRoutable->setHelp( QObject::tr( "An optional output which will be used to store any input features which could not be routed (e.g. those which are too far from the network layer)." ) );
67 outputNonRoutable->setCreateByDefault( false );
68 addParameter( outputNonRoutable.release() );
69}
70
71QVariantMap QgsShortestPathLayerToPointAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
72{
73 loadCommonParams( parameters, context, feedback );
74
75 const QgsPointXY endPoint = parameterAsPoint( parameters, QStringLiteral( "END_POINT" ), context, mNetwork->sourceCrs() );
76
77 std::unique_ptr< QgsFeatureSource > startPoints( parameterAsSource( parameters, QStringLiteral( "START_POINTS" ), context ) );
78 if ( !startPoints )
79 throw QgsProcessingException( invalidSourceError( parameters, QStringLiteral( "START_POINTS" ) ) );
80
81 QgsFields fields = startPoints->fields();
82 fields.append( QgsField( QStringLiteral( "start" ), QMetaType::Type::QString ) );
83 fields.append( QgsField( QStringLiteral( "end" ), QMetaType::Type::QString ) );
84 fields.append( QgsField( QStringLiteral( "cost" ), QMetaType::Type::Double ) );
85
86 QString dest;
87 std::unique_ptr< QgsFeatureSink > sink( parameterAsSink( parameters, QStringLiteral( "OUTPUT" ), context, dest, fields, Qgis::WkbType::LineString, mNetwork->sourceCrs() ) );
88 if ( !sink )
89 throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "OUTPUT" ) ) );
90
91 QString nonRoutableSinkId;
92 std::unique_ptr< QgsFeatureSink > nonRoutableSink( parameterAsSink( parameters, QStringLiteral( "OUTPUT_NON_ROUTABLE" ), context, nonRoutableSinkId, startPoints->fields(),
93 Qgis::WkbType::Point, mNetwork->sourceCrs() ) );
94
95 const double pointDistanceThreshold = parameters.value( QStringLiteral( "POINT_TOLERANCE" ) ).isValid() ? parameterAsDouble( parameters, QStringLiteral( "POINT_TOLERANCE" ), context ) : -1;
96
97 QVector< QgsPointXY > points;
98 points.push_front( endPoint );
99 QHash< int, QgsAttributes > sourceAttributes;
100 loadPoints( startPoints.get(), points, sourceAttributes, context, feedback );
101
102 feedback->pushInfo( QObject::tr( "Building graph…" ) );
103 QVector< QgsPointXY > snappedPoints;
104 mDirector->makeGraph( mBuilder.get(), points, snappedPoints, feedback );
105
106 const QgsPointXY snappedEndPoint = snappedPoints[0];
107
108 if ( pointDistanceThreshold >= 0 )
109 {
110 const double distanceEndPointToNetwork = mBuilder->distanceArea()->measureLine( endPoint, snappedEndPoint );
111 if ( distanceEndPointToNetwork > pointDistanceThreshold )
112 {
113 throw QgsProcessingException( QObject::tr( "End point is too far from the network layer (%1, maximum permitted is %2)" ).arg( distanceEndPointToNetwork ).arg( pointDistanceThreshold ) );
114 }
115 }
116
117 feedback->pushInfo( QObject::tr( "Calculating shortest paths…" ) );
118 std::unique_ptr< QgsGraph > graph( mBuilder->takeGraph() );
119 const int idxEnd = graph->findVertex( snappedEndPoint );
120 int idxStart;
121 int currentIdx;
122
123 QVector< int > tree;
124 QVector< double > costs;
125
126 QVector<QgsPointXY> route;
127 double cost;
128
129 QgsFeature feat;
130 feat.setFields( fields );
131 QgsAttributes attributes;
132
133 const double step = points.size() > 0 ? 100.0 / points.size() : 1;
134 for ( int i = 1; i < points.size(); i++ )
135 {
136 if ( feedback->isCanceled() )
137 {
138 break;
139 }
140
141 const QgsPointXY snappedPoint = snappedPoints.at( i );
142 const QgsPointXY originalPoint = points.at( i );
143
144 if ( pointDistanceThreshold >= 0 )
145 {
146 const double distancePointToNetwork = mBuilder->distanceArea()->measureLine( originalPoint, snappedPoint );
147 if ( distancePointToNetwork > pointDistanceThreshold )
148 {
149 feedback->pushWarning( QObject::tr( "Point is too far from the network layer (%1, maximum permitted is %2)" ).arg( distancePointToNetwork ).arg( pointDistanceThreshold ) );
150 if ( nonRoutableSink )
151 {
152 feat.setGeometry( QgsGeometry::fromPointXY( originalPoint ) );
153 attributes = sourceAttributes.value( i );
154 feat.setAttributes( attributes );
155 if ( !nonRoutableSink->addFeature( feat, QgsFeatureSink::FastInsert ) )
156 throw QgsProcessingException( writeFeatureError( nonRoutableSink.get(), parameters, QStringLiteral( "OUTPUT_NON_ROUTABLE" ) ) );
157 }
158
159 feedback->setProgress( i * step );
160 continue;
161 }
162 }
163
164 idxStart = graph->findVertex( snappedPoint );
165 QgsGraphAnalyzer::dijkstra( graph.get(), idxStart, 0, &tree, &costs );
166
167 if ( tree.at( idxEnd ) == -1 )
168 {
169 feedback->reportError( QObject::tr( "There is no route from start point (%1) to end point (%2)." )
170 .arg( originalPoint.toString(),
171 endPoint.toString() ) );
172 feat.clearGeometry();
173 attributes = sourceAttributes.value( i );
174 attributes.append( originalPoint.toString() );
175 feat.setAttributes( attributes );
176 if ( !sink->addFeature( feat, QgsFeatureSink::FastInsert ) )
177 throw QgsProcessingException( writeFeatureError( sink.get(), parameters, QStringLiteral( "OUTPUT" ) ) );
178 continue;
179 }
180
181 route.clear();
182 route.push_front( graph->vertex( idxEnd ).point() );
183 cost = costs.at( idxEnd );
184 currentIdx = idxEnd;
185 while ( currentIdx != idxStart )
186 {
187 currentIdx = graph->edge( tree.at( currentIdx ) ).fromVertex();
188 route.push_front( graph->vertex( currentIdx ).point() );
189 }
190
191 const QgsGeometry geom = QgsGeometry::fromPolylineXY( route );
192 QgsFeature feat;
193 feat.setFields( fields );
194 attributes = sourceAttributes.value( i );
195 attributes.append( originalPoint.toString() );
196 attributes.append( endPoint.toString() );
197 attributes.append( cost / mMultiplier );
198 feat.setAttributes( attributes );
199 feat.setGeometry( geom );
200 if ( !sink->addFeature( feat, QgsFeatureSink::FastInsert ) )
201 throw QgsProcessingException( writeFeatureError( sink.get(), parameters, QStringLiteral( "OUTPUT" ) ) );
202
203 feedback->setProgress( i * step );
204 }
205
206 QVariantMap outputs;
207 outputs.insert( QStringLiteral( "OUTPUT" ), dest );
208 if ( nonRoutableSink )
209 {
210 outputs.insert( QStringLiteral( "OUTPUT_NON_ROUTABLE" ), nonRoutableSinkId );
211 }
212 return outputs;
213}
214
@ VectorPoint
Vector point layers.
@ VectorLine
Vector line layers.
@ LineString
LineString.
@ Advanced
Parameter is an advanced parameter which should be hidden from users by default.
A vector of attributes.
@ 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
void setAttributes(const QgsAttributes &attrs)
Sets the feature's attributes.
void setFields(const QgsFields &fields, bool initAttributes=false)
Assigns a field map with the feature to allow attribute access by attribute name.
void clearGeometry()
Removes any geometry associated with the feature.
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
Encapsulate a field in an attribute table or data source.
Definition qgsfield.h:53
Container of fields for a vector layer.
Definition qgsfields.h:46
bool append(const QgsField &field, Qgis::FieldOrigin origin=Qgis::FieldOrigin::Provider, int originIndex=-1)
Appends a field.
Definition qgsfields.cpp:69
A geometry is the spatial representation of a feature.
static QgsGeometry fromPolylineXY(const QgsPolylineXY &polyline)
Creates a new LineString geometry from a list of QgsPointXY points.
static QgsGeometry fromPointXY(const QgsPointXY &point)
Creates a new geometry from a QgsPointXY object.
static void dijkstra(const QgsGraph *source, int startVertexIdx, int criterionNum, QVector< int > *resultTree=nullptr, QVector< double > *resultCost=nullptr)
Solve shortest path problem using Dijkstra algorithm.
A class to represent a 2D point.
Definition qgspointxy.h:60
QString toString(int precision=-1) const
Returns a string representation of the point (x, y) with a preset precision.
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 pushWarning(const QString &warning)
Pushes a warning informational message from the algorithm.
virtual void reportError(const QString &error, bool fatalError=false)
Reports that the algorithm encountered an error while executing.
A feature sink output for processing algorithms.
An input feature source (such as vector layers) parameter for processing algorithms.
A point parameter for processing algorithms.