31using namespace Qt::StringLiterals;
35QString QgsValidateNetworkAlgorithm::name()
const
37 return u
"validatenetwork"_s;
40QString QgsValidateNetworkAlgorithm::displayName()
const
42 return QObject::tr(
"Validate network" );
45QStringList QgsValidateNetworkAlgorithm::tags()
const
47 return QObject::tr(
"topological,topology,check,graph,shortest,path" ).split(
',' );
50QString QgsValidateNetworkAlgorithm::group()
const
52 return QObject::tr(
"Network analysis" );
55QString QgsValidateNetworkAlgorithm::groupId()
const
57 return u
"networkanalysis"_s;
60QIcon QgsValidateNetworkAlgorithm::icon()
const
65QString QgsValidateNetworkAlgorithm::svgIconPath()
const
70QString QgsValidateNetworkAlgorithm::shortDescription()
const
72 return QObject::tr(
"Validates a network line layer, identifying data and topology errors that may affect network analysis tools." );
75QString QgsValidateNetworkAlgorithm::shortHelpString()
const
77 return QObject::tr(
"This algorithm analyzes a network vector layer to identify data and topology errors "
78 "that may affect network analysis tools (like shortest path).\n\n"
79 "Optional checks include:\n\n"
80 "1. Validating the 'Direction' field to ensure all direction field values in the input layer "
81 "match the configured forward/backward/both values. Errors will be reported if the direction field "
82 "value is non-null and does not match one of the configured values.\n"
83 "2. Checking node-to-node separation. This check identifies nodes from the network graph that "
84 "are closer to other nodes than the specified tolerance distance. This often indicates missed "
85 "snaps or short segments in the input layer. In the case that a node violates this condition with multiple other "
86 "nodes, only the closest violation will be reported.\n"
87 "3. Checking node-to-segment separation: This check identifies nodes that are closer to a line "
88 "segment (e.g. a graph edge) than the specified tolerance distance, without being connected to it. In the case "
89 "that a node violates this condition with multiple other edges, only the closest violation will be reported.\n\n"
90 "Topology checks (node-to-node and node-to-segment) can optionally be restricted to only evaluate nodes that are topological dead-ends (connected to only one other distinct node). This is useful for specifically targeting dangles or undershoots.\n\n"
91 "Two layers are output by this algorithm:\n"
92 "1. An output containing features from the original network layer which failed the direction validation checks.\n"
93 "2. An output representing the problematic node locations with a 'error' field explaining the error. This is "
94 "a line layer, where the output features join the problematic node to the node or "
95 "segment which failed the tolerance checks." );
98QgsValidateNetworkAlgorithm *QgsValidateNetworkAlgorithm::createInstance()
const
100 return new QgsValidateNetworkAlgorithm();
103void QgsValidateNetworkAlgorithm::initAlgorithm(
const QVariantMap & )
107 auto separationNodeNodeParam = std::make_unique<QgsProcessingParameterDistance>( u
"TOLERANCE_NODE_NODE"_s, QObject::tr(
"Minimum separation between nodes" ), QVariant(), u
"INPUT"_s,
true );
109 separationNodeNodeParam->setHelp( QObject::tr(
"The minimum allowed distance between two distinct graph nodes.\n\n"
110 "Nodes closer than this distance (but not identical) will be flagged as errors.\n\n"
111 "Leave empty to disable this check." ) );
112 addParameter( separationNodeNodeParam.release() );
114 auto separationNodeSegmentParam = std::make_unique<QgsProcessingParameterDistance>( u
"TOLERANCE_NODE_SEGMENT"_s, QObject::tr(
"Minimum separation between nodes and non-noded segments" ), QVariant(), u
"INPUT"_s,
true );
116 separationNodeSegmentParam->setHelp( QObject::tr(
"The minimum allowed distance between a graph node and a graph edge (segment) "
117 "that is not connected to the node.\n\n"
118 "Nodes closer to a segment than this distance "
119 "will be flagged. Leave empty to disable this check." ) );
120 addParameter( separationNodeSegmentParam.release() );
122 auto endpointsOnlyParam = std::make_unique<QgsProcessingParameterBoolean>( u
"ENDPOINTS_ONLY"_s, QObject::tr(
"Only check for errors at end points" ),
false );
123 endpointsOnlyParam->setHelp( QObject::tr(
"If checked, topology checks (node-to-node and node-to-segment) will only be evaluated for nodes that are topological dead-ends (connected to only one other distinct node)." ) );
124 addParameter( endpointsOnlyParam.release() );
127 directionField->setHelp( QObject::tr(
"The attribute field specifying the direction of traffic flow for each segment." ) );
128 addParameter( directionField.release() );
130 auto forwardValue = std::make_unique<QgsProcessingParameterString>( u
"VALUE_FORWARD"_s, QObject::tr(
"Value for forward direction" ), QVariant(),
false,
true );
131 forwardValue->setHelp( QObject::tr(
"The string value in the direction field that indicates one-way traffic in the digitized direction." ) );
132 addParameter( forwardValue.release() );
134 auto backwardValue = std::make_unique<QgsProcessingParameterString>( u
"VALUE_BACKWARD"_s, QObject::tr(
"Value for backward direction" ), QVariant(),
false,
true );
135 backwardValue->setHelp( QObject::tr(
"The string value in the direction field that indicates one-way traffic opposite to the digitized direction." ) );
136 addParameter( backwardValue.release() );
138 auto bothValue = std::make_unique<QgsProcessingParameterString>( u
"VALUE_BOTH"_s, QObject::tr(
"Value for both directions" ), QVariant(),
false,
true );
139 bothValue->setHelp( QObject::tr(
"The string value in the direction field that indicates two-way traffic." ) );
140 addParameter( bothValue.release() );
142 std::unique_ptr<QgsProcessingParameterNumber> tolerance = std::make_unique<QgsProcessingParameterDistance>( u
"TOLERANCE"_s, QObject::tr(
"Topology tolerance" ), 0, u
"INPUT"_s,
false, 0 );
144 addParameter( tolerance.release() );
146 auto invalidNetworkOutput = std::make_unique< QgsProcessingParameterFeatureSink >( u
"OUTPUT_INVALID_NETWORK"_s, QObject::tr(
"Invalid network features" ),
Qgis::ProcessingSourceType::VectorLine, QVariant(),
true,
true );
147 invalidNetworkOutput->setHelp( QObject::tr(
"Output line layer containing geometries representing features from the network layer with validity errors.\n\n"
148 "This output includes an attribute explaining why each feature is invalid." ) );
149 addParameter( invalidNetworkOutput.release() );
151 addOutput(
new QgsProcessingOutputNumber( u
"COUNT_INVALID_NETWORK_FEATURES"_s, QObject::tr(
"Count of invalid network features" ) ) );
153 auto invalidNodeOutput = std::make_unique< QgsProcessingParameterFeatureSink >( u
"OUTPUT_INVALID_NODES"_s, QObject::tr(
"Invalid network nodes" ),
Qgis::ProcessingSourceType::VectorLine, QVariant(),
true,
true );
154 invalidNodeOutput->setHelp( QObject::tr(
"Output line layer containing geometries representing nodes from the network layer with validity errors.\n\n"
155 "This output includes an attribute explaining why each node is invalid." ) );
156 addParameter( invalidNodeOutput.release() );
163 std::unique_ptr<QgsFeatureSource> networkSource( parameterAsSource( parameters, u
"INPUT"_s, context ) );
164 if ( !networkSource )
167 const QString directionFieldName = parameterAsString( parameters, u
"DIRECTION_FIELD"_s, context );
168 const QString forwardValue = parameterAsString( parameters, u
"VALUE_FORWARD"_s, context );
169 const QString backwardValue = parameterAsString( parameters, u
"VALUE_BACKWARD"_s, context );
170 const QString bothValue = parameterAsString( parameters, u
"VALUE_BOTH"_s, context );
171 const double tolerance = parameterAsDouble( parameters, u
"TOLERANCE"_s, context );
173 const bool checkEndpointsOnly = parameterAsBoolean( parameters, u
"ENDPOINTS_ONLY"_s, context );
175 double toleranceNodeToNode = 0;
176 bool checkNodeToNodeDistance =
false;
177 if ( parameters.value( u
"TOLERANCE_NODE_NODE"_s ).isValid() )
179 toleranceNodeToNode = parameterAsDouble( parameters, u
"TOLERANCE_NODE_NODE"_s, context );
180 checkNodeToNodeDistance = ( toleranceNodeToNode > 0 );
183 double toleranceNodeToSegment = 0;
184 bool checkNodeToSegmentDistance =
false;
185 if ( parameters.value( u
"TOLERANCE_NODE_SEGMENT"_s ).isValid() )
187 toleranceNodeToSegment = parameterAsDouble( parameters, u
"TOLERANCE_NODE_SEGMENT"_s, context );
188 checkNodeToSegmentDistance = ( toleranceNodeToSegment > 0 );
192 newNetworkErrorFields.
append(
QgsField( u
"error"_s, QMetaType::Type::QString ) );
195 QString networkErrorDest;
196 std::unique_ptr<QgsFeatureSink> networkErrorSink( parameterAsSink( parameters, u
"OUTPUT_INVALID_NETWORK"_s, context, networkErrorDest, networkErrorFields, networkSource->wkbType(), networkSource->sourceCrs() ) );
199 nodeErrorFields.
append(
QgsField( u
"error"_s, QMetaType::Type::QString ) );
201 QString nodeErrorDest;
202 std::unique_ptr<QgsFeatureSink> nodeErrorSink( parameterAsSink( parameters, u
"OUTPUT_INVALID_NODES"_s, context, nodeErrorDest, nodeErrorFields,
Qgis::WkbType::LineString, networkSource->sourceCrs() ) );
205 multiFeedback.setStepWeights( { 10, 40, 10, 40 } );
206 multiFeedback.setCurrentStep( 0 );
209 if ( networkErrorSink )
210 outputs.insert( u
"OUTPUT_INVALID_NETWORK"_s, networkErrorDest );
212 outputs.insert( u
"OUTPUT_INVALID_NODES"_s, nodeErrorDest );
215 int directionFieldIdx = -1;
216 long long countInvalidFeatures = 0;
217 if ( !directionFieldName.isEmpty() )
219 directionFieldIdx = networkSource->fields().lookupField( directionFieldName );
220 if ( directionFieldIdx < 0 )
222 throw QgsProcessingException( QObject::tr(
"Missing field %1 in input layer" ).arg( directionFieldName ) );
225 multiFeedback.pushInfo( QObject::tr(
"Validating direction attributes…" ) );
226 const long long count = networkSource->featureCount();
227 long long current = 0;
228 const double step = count > 0 ? 100.0 /
static_cast< double >( count ) : 1;
234 if ( multiFeedback.isCanceled() )
237 const QVariant val = feature.
attribute( directionFieldIdx );
240 const QString directionValueString = val.toString();
241 if ( directionValueString != forwardValue && directionValueString != backwardValue && directionValueString != bothValue )
243 if ( networkErrorSink )
247 outputFeatureAttrs.append( QObject::tr(
"Invalid direction value: '%1'" ).arg( directionValueString ) );
251 throw QgsProcessingException( writeFeatureError( networkErrorSink.get(), parameters, u
"OUTPUT_INVALID_NETWORK"_s ) );
254 countInvalidFeatures++;
259 multiFeedback.setProgress(
static_cast< double >( current ) * step );
262 if ( networkErrorSink )
264 networkErrorSink->finalize();
268 outputs.insert( u
"COUNT_INVALID_NETWORK_FEATURES"_s, countInvalidFeatures );
269 if ( countInvalidFeatures > 0 )
271 multiFeedback.reportError( QObject::tr(
"Found %1 invalid network features" ).arg( countInvalidFeatures ) );
274 if ( !checkNodeToNodeDistance && !checkNodeToSegmentDistance )
280 multiFeedback.pushInfo( QObject::tr(
"Building graph for topology validation…" ) );
281 multiFeedback.setCurrentStep( 1 );
286 QVector<QgsPointXY> snappedPoints;
287 director.makeGraph( &builder, {}, snappedPoints, &multiFeedback );
289 std::unique_ptr<QgsGraph> graph( builder.takeGraph() );
291 if ( multiFeedback.isCanceled() )
294 multiFeedback.pushInfo( QObject::tr(
"Indexing graph nodes and edges…" ) );
295 multiFeedback.setCurrentStep( 2 );
303 const int vertexCount = graph->vertexCount();
305 const long long totalGraphElements = ( checkNodeToNodeDistance ? vertexCount : 0 ) + ( checkNodeToSegmentDistance ? graph->edgeCount() : 0 );
306 const double indexStep = totalGraphElements > 0 ? 100.0 /
static_cast< double >( totalGraphElements ) : 1;
307 long long elementsProcessed = 0;
309 if ( checkNodeToNodeDistance )
311 for (
int i = 0; i < vertexCount; ++i )
313 if ( multiFeedback.isCanceled() )
315 nodeIndex.
addFeature( i, graph->vertex( i ).point() );
317 multiFeedback.setProgress(
static_cast< double >( elementsProcessed ) * indexStep );
322 if ( checkNodeToSegmentDistance )
324 for (
int i = 0; i < graph->edgeCount(); ++i )
326 if ( multiFeedback.isCanceled() )
335 multiFeedback.setProgress(
static_cast< double >( elementsProcessed ) * indexStep );
340 multiFeedback.pushInfo( QObject::tr(
"Validating graph topology…" ) );
341 multiFeedback.setCurrentStep( 2 );
343 const double topoStep = vertexCount > 0 ? 100.0 / vertexCount : 1;
349 double distance = std::numeric_limits<double>::max();
352 QSet< QPair< long long, long long > > alreadyReportedNodes;
353 long long countInvalidNodes = 0;
355 for (
long long i = 0; i < vertexCount; ++i )
357 if ( multiFeedback.isCanceled() )
364 bool evaluateNode =
true;
366 if ( checkEndpointsOnly )
369 QSet<int> adjacentNodeIndices;
372 adjacentNodeIndices.insert( graph->edge( edgeId ).toVertex() );
376 adjacentNodeIndices.insert( graph->edge( edgeId ).fromVertex() );
378 if ( adjacentNodeIndices.count() != 1 )
380 evaluateNode =
false;
384 if ( evaluateNode && checkNodeToNodeDistance )
386 const std::vector< QgsVectorLayerDirector::VertexSourceInfo > &fidsFirstNode = director.sourcesForVertex( i );
388 const QList<QgsSpatialIndexKDBushData> candidates = nodeIndex.
intersects(
393 NodeError closestError;
404 if ( graph->edge( edge ).fromVertex() == i )
414 if ( graph->edge( edge ).toVertex() == data.id )
423 const std::vector<QgsVectorLayerDirector::VertexSourceInfo> &fidsSecondNode = director.sourcesForVertex( data.id );
425 bool shareCommonFeature =
false;
430 if ( info1 == info2 )
432 shareCommonFeature =
true;
436 if ( shareCommonFeature )
440 if ( shareCommonFeature )
446 const double distanceNodeToNode = pt.
distance( data.point() );
447 if ( distanceNodeToNode < toleranceNodeToNode && distanceNodeToNode < closestError.distance )
449 closestError.distance = distanceNodeToNode;
450 closestError.id = data.id;
451 closestError.pt = data.point();
455 if ( !closestError.pt.isEmpty() )
457 const QPair< long long, long long > nodeId = qMakePair( std::min( closestError.id, i ), std::max( closestError.id, i ) );
458 if ( alreadyReportedNodes.contains( nodeId ) )
463 alreadyReportedNodes.insert( nodeId );
467 QgsFeature nodeErrorFeature( nodeErrorFields );
468 nodeErrorFeature.setGeometry( std::make_unique< QgsLineString >( QVector<QgsPointXY>() << pt << closestError.pt ) );
469 nodeErrorFeature.setAttributes(
QgsAttributes() << QObject::tr(
"Node too close to adjacent node (%1 < %2)" ).arg( closestError.distance ).arg( toleranceNodeToNode ) );
471 throw QgsProcessingException( writeFeatureError( nodeErrorSink.get(), parameters, u
"OUTPUT_INVALID_NODES"_s ) );
477 if ( evaluateNode && checkNodeToSegmentDistance )
480 NodeError closestError;
482 const QList<QgsFeatureId> edgeIds = edgeIndex.intersects(
QgsRectangle::fromCenterAndSize( pt, toleranceNodeToSegment * 2, toleranceNodeToSegment * 2 ) );
485 const QgsGraphEdge &edge = graph->edge(
static_cast< int >( edgeIdx ) );
494 const double distanceToSegment = std::sqrt( pt.
sqrDistToSegment( p1.
x(), p1.
y(), p2.
x(), p2.
y(), closestPt ) );
495 if ( distanceToSegment >= toleranceNodeToSegment )
505 if ( distanceToSegment > closestError.distance )
509 closestError.distance = distanceToSegment;
510 closestError.pt = closestPt;
513 if ( !closestError.pt.isEmpty() )
517 QgsFeature nodeErrorFeature( nodeErrorFields );
518 nodeErrorFeature.setGeometry( std::make_unique< QgsLineString >( QVector<QgsPointXY>() << pt << closestError.pt ) );
519 nodeErrorFeature.setAttributes(
QgsAttributes() << QObject::tr(
"Node too close to non-noded segment (%1 < %2)" ).arg( closestError.distance ).arg( toleranceNodeToSegment ) );
521 throw QgsProcessingException( writeFeatureError( nodeErrorSink.get(), parameters, u
"OUTPUT_INVALID_NODES"_s ) );
527 multiFeedback.setProgress(
static_cast< double >( i ) * topoStep );
532 nodeErrorSink->finalize();
536 if ( countInvalidNodes > 0 )
538 multiFeedback.reportError( QObject::tr(
"Found %1 invalid network nodes" ).arg( countInvalidNodes ) );
541 outputs.insert( u
"COUNT_INVALID_NODES"_s, countInvalidNodes );
@ VectorLine
Vector line layers.
@ Advanced
Parameter is an advanced parameter which should be hidden from users by default.
@ Optional
Parameter is optional.
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
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.
@ 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...
void setAttributes(const QgsAttributes &attrs)
Sets the feature's attributes.
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
void setProgress(double progress)
Sets the current progress for the feedback object.
Encapsulate a field in an attribute table or data source.
Container of fields for a vector layer.
bool append(const QgsField &field, Qgis::FieldOrigin origin=Qgis::FieldOrigin::Provider, int originIndex=-1)
Appends a field.
Used for making the QgsGraph object.
Represents an edge in a graph.
int fromVertex() const
Returns the index of the vertex at the start of this edge.
int toVertex() const
Returns the index of the vertex at the end of this edge.
Represents vertex in a graph.
QgsGraphEdgeIds outgoingEdges() const
Returns outgoing edge ids, i.e.
QgsGraphEdgeIds incomingEdges() const
Returns the incoming edge ids, i.e.
QgsPointXY point() const
Returns point associated with graph vertex.
double distance(double x, double y) const
Returns the distance between this point and a specified x, y coordinate.
bool compare(const QgsPointXY &other, double epsilon=4 *std::numeric_limits< double >::epsilon()) const
Compares this point with another point with a fuzzy tolerance.
double sqrDistToSegment(double x1, double y1, double x2, double y2, QgsPointXY &minDistPoint, double epsilon=Qgis::DEFAULT_SEGMENT_EPSILON) const
Returns the minimum distance between this point and a segment.
Contains information about the context in which a processing algorithm is executed.
QString ellipsoid() const
Returns the ellipsoid to use for distance and area calculations.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
Processing feedback object for multi-step operations.
A numeric output for processing algorithms.
An input feature source (such as vector layers) parameter for processing algorithms.
static QgsFields combineFields(const QgsFields &fieldsA, const QgsFields &fieldsB, const QString &fieldsBPrefix=QString())
Combines two field lists, avoiding duplicate field names (in a case-insensitive manner).
A rectangle specified with double values.
static QgsRectangle fromCenterAndSize(const QgsPointXY ¢er, double width, double height)
Creates a new rectangle, given the specified center point and width and height.
A container for data stored inside a QgsSpatialIndexKDBush index.
A very fast static spatial index for 2D points based on a flat KD-tree.
void finalize()
Finalizes the index after manually adding features.
QList< QgsSpatialIndexKDBushData > intersects(const QgsRectangle &rectangle) const
Returns the list of features which fall within the specified rectangle.
bool addFeature(QgsFeatureId id, const QgsPointXY &point)
Adds a single feature to the index.
A spatial index for QgsFeature objects.
@ FlagStoreFeatureGeometries
Indicates that the spatial index should also store feature geometries. This requires more memory,...
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
Determines creating a graph from a vector line layer.
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Represents information about a graph node's source vertex.