forked from osmlab/atlas-checks
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for 5 more checks (osmlab#503)
* Add documentation for LongSegmentCheck * Add documentation for OverlappingEdgeCheck * Add documentation for RoadLinkCheck * Add documentation for ShortSegmentCheck * Add documentation for ValenceOneImportantRoadCheck * Fix number of configs for LongSegment * Remove underscore
- Loading branch information
Showing
6 changed files
with
101 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Long Segment Check | ||
|
||
#### Description | ||
Checks for Edges that have segments longer than the given configurable length, excluding ferry routes. | ||
|
||
#### Configuration | ||
|
||
This check has one configurable that can be changed in the configuration file [config.json](../../config/configuration.json) | ||
|
||
Defaults: | ||
- ```"length.minimum.kilometers": 10.0``` - Minimum length in kilometers for a flagged way | ||
|
||
#### Live Examples | ||
|
||
- [id:183926818](https://www.openstreetmap.org/way/183926818) | ||
- [id:279683900](https://www.openstreetmap.org/way/279683900) | ||
- [id:555861516](https://www.openstreetmap.org/way/555861516) | ||
|
||
Please see the source code for LongSegmentCheck here: [LongSegmentCheck](../../src/main/java/org/openstreetmap/atlas/checks/validation/linear/edges/LongSegmentCheck.java) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Overlapping Edge Check | ||
|
||
#### Description | ||
The purpose of this check is to identify Edges which overlap another Edge. Overlapping Edges share two consecutive Nodes. | ||
|
||
#### Configuration | ||
|
||
This check has two configurables that can be changed in the configuration file [config.json](../../config/configuration.json) | ||
|
||
Defaults: | ||
- ```"highway.priority.minimum": "residential"``` - Minimum highway type for priority | ||
- ```"pedestrian.areas.filter": true``` - Whether or not to filter out pedestrian areas | ||
|
||
#### Live Examples | ||
|
||
- Part of [id:851925421](https://www.openstreetmap.org/way/851925421) is overlapping part of [id:55081553](https://www.openstreetmap.org/way/55081553) | ||
- Part of [id:857538513](https://www.openstreetmap.org/way/857538513) is overlapping part of [id:130585687](https://www.openstreetmap.org/way/130585687) | ||
- Part of [id:125452478](https://www.openstreetmap.org/way/125452478) is overlapping part of [id:230343727](https://www.openstreetmap.org/way/230343727) | ||
|
||
Please see the source code for OverlappingEdgeCheck here: [OverlappingEdgeCheck](../../src/main/java/org/openstreetmap/atlas/checks/validation/linear/edges/OverlappingEdgeCheck.java) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Road Link Check | ||
|
||
#### Description | ||
The purpose of this check is to verify that at least one end of a highway link is connected to another road or link of the same classification. This check also identifies links that are longer than the given configurable distance. | ||
|
||
#### Configuration | ||
|
||
This check has one configurable that can be changed in the configuration file [config.json](../../config/configuration.json) | ||
|
||
Defaults: | ||
- ```"length.maximum.miles": 1.0``` - Maximum length (miles) of road link | ||
|
||
#### Live Examples | ||
|
||
- Road link [id:89146080](https://www.openstreetmap.org/way/89146080) is longer than 1 mile. | ||
- Road link [id:867719370](https://www.openstreetmap.org/way/867719370) is highway type ```secondary_link``` connected to two other highways ([id:867719371](https://www.openstreetmap.org/way/867719371) & [id:867719372](https://www.openstreetmap.org/way/867719372)) with different type values of ```primary``` | ||
|
||
|
||
Please see the source code for RoadLinkCheck here: [RoadLinkCheck](../../src/main/java/org/openstreetmap/atlas/checks/validation/linear/edges/RoadLinkCheck.java) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Short Segment Check | ||
|
||
#### Description | ||
The purpose of this check is to flag Edges which are shorter than the given configurable length, and are also connected to a Node with a connection valence less than given configurable minimum value. | ||
|
||
#### Configuration | ||
|
||
This check has three configurables that can be changed in the configuration file [config.json](../../config/configuration.json) | ||
|
||
Defaults: | ||
- ```"edge.length.maximum.meters": 1.0``` - Maximum length (meters) of edge | ||
- ```"node.valence.minimum": 3``` - Minimum number of valence nodes | ||
- ```"highway.priority.minimum": "service"``` - Minimum highway type for priorities | ||
|
||
#### Live Examples | ||
|
||
- Edge [id:186939108](https://www.openstreetmap.org/way/186939108) is less than 1 meter and it is connected to Node [id:1922609289](https://www.openstreetmap.org/node/1922609289) that has less than 3 connections. | ||
- Edge [id:54358738](https://www.openstreetmap.org/way/54358738) is less than 1 meter and it is connected to Node [id:685072915](https://www.openstreetmap.org/node/685072915) that has less than 3 connections. | ||
- Edge [id:859429484](https://www.openstreetmap.org/way/859429484) is less than 1 meter and it is connected to Node [id:8010983331](https://www.openstreetmap.org/node/8010983331) that has less than 3 connections. | ||
|
||
|
||
Please see the source code for ShortSegmentCheck here: [ShortSegmentCheck](../../src/main/java/org/openstreetmap/atlas/checks/validation/linear/edges/ShortSegmentCheck.java) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Valence One Important Road Check | ||
|
||
#### Description | ||
The purpose of this check is to flag high priority roads that have a start or end Node with a valence of one. This has some overlap with [FloatingEdgeCheck](floatingEdgeCheck.md), though it does not have the same segment length requirements and targets high priority road segments only. | ||
|
||
#### Configuration | ||
|
||
This check has no configurables. | ||
|
||
#### Live Examples | ||
|
||
- Edge [id:868979533](https://www.openstreetmap.org/way/868979533) dead ends at Node [id:8099729922](https://www.openstreetmap.org/node/8099729922). | ||
- Edge [id:897224763](https://www.openstreetmap.org/way/897224763) dead ends at Node [id:8339439952](https://www.openstreetmap.org/node/8339439952). | ||
|
||
|
||
Please see the source code for ValenceOneImportantRoadCheck here: [ValenceOnceImportantRoadCheck](../../src/main/java/org/openstreetmap/atlas/checks/validation/linear/edges/ValenceOneImportantRoadCheck.java) |