diff --git a/docs/available_checks.md b/docs/available_checks.md index 69d9b09dd..d602597ae 100644 --- a/docs/available_checks.md +++ b/docs/available_checks.md @@ -23,23 +23,23 @@ This document is a list of tables with a description and link to documentation f | [FloatingEdgeCheck](checks/floatingEdgeCheck.md) | The purpose of this check is to identify Edges that are not accessible or navigable from the rest of the Edge network due to lack of connectivity or access restrictions. | | [InconsistentRoadClassificationCheck](checks/inconsistentRoadClassificationCheck.md) | The purpose of this check is to identify roads, that transition from one classification to another and then back to the original classification. | | [InvalidPiersCheck](checks/invalidPiersCheck.md) | The purpose of this check is to identify piers(OSM Ways with man_made=pier tag) that are ingested in Atlas as edges with linear or polygonal geometry without an area=yes tag | -| LongSegmentCheck | This check identifies long segments/edges (length is more than minimumLength). | +| [LongSegmentCheck](checks/longSegmentCheck.md) | This check identifies long segments/edges (length is more than minimumLength). | | [MalformedRoundaboutCheck](checks/malformedRoundaboutCheck.md) | The purpose of this check is to identify roundabouts mapped in the opposite direction of traffic. The check takes into consideration countries with both left-side and right-side traffic. There are three types of map errors that will be flagged by this check: 1. Wrong-way-roundabouts, 2. Multi-directional roundabouts, and 3. Roundabouts with poor geometry. | -| OverlappingEdgeCheck | The purpose of this check is to identify edges that share the same two consecutive geometry points. | -| RoadLinkCheck | Verifies that one end or the other of an edge is a fork to/from a road of the same class, that is not a _link. | +| [OverlappingEdgeCheck](checks/overlappingEdgeCheck.md) | The purpose of this check is to identify edges that share the same two consecutive geometry points. | +| [RoadLinkCheck](checks/roadLinkCheck.md) | Verifies that one end or the other of an edge is a fork to/from a road of the same class, that is not a link. | | [~~RoundaboutClosedLoopCheck~~ (Deprecated)](checks/roundaboutClosedLoopCheck.md) | The purpose of this check is to identify Roundabout Edges that are bi-directional or have an end Node with less than 2 connections. **This check has been deprecated and is no longer active.** | | [RoundaboutConnectorCheck](checks/roundaboutConnectorCheck.md) | The purpose of this check is to identify roads that connect to a roundabout at too sharp an angle | | [RoundaboutValenceCheck](checks/roundaboutValenceCheck.md) | The purpose of this check is to identify OpenStreetMap (OSM) tagged roundabouts that have an unusual number of edges connected to them. | | [RoundaboutMissingTag](checks/roundaboutMissingTagCheck.md) | The purpose of this check is to identify Roundabouts with missing junction=roundabout tag. Candidate must be navigable, closed and round shape OSM Way that intersects with at least two navigable roads. | | [SharpAngleCheck](checks/sharpAngleCheck.md) | The purpose of this check is to identify roads with angles that are too sharp. Sharp angles may indicate inaccurate digitization once a certain threshold is exceeded. | -| ShortSegmentCheck | The purpose of this check is to identify short segments/edges (length is less than a configured minimum length) that have a node with less than or equal to a configured node valence connections. | +| [ShortSegmentCheck](checks/shortSegmentCheck.md) | The purpose of this check is to identify short segments/edges (length is less than a configured minimum length) that have a node with less than or equal to a configured node valence connections. | | [SignPostCheck](checks/signPostCheck.md) | The purpose of this check is to identify On-/Off-Ramps in motorways and trunk highways that are not relaying information from their respective sign posts. | | [SingleSegmentMotorwayCheck](checks/singleSegmentMotorwayCheck.md) | The purpose of this check is to identify ways tagged with highway=motorway that are not connected to any ways tagged the same. | | [SinkIslandCheck](tutorials/tutorial3-SinkIslandCheck.md) | The purpose of this check is to identify whether a network of car-navigable Edges can be exited. | | [SnakeRoadCheck](checks/snakeRoadCheck.md) | The purpose of the SnakeRoad check is to identify roads that should be split into two or more roads. | | [SuddenHighwayTypeChangeCheck](checks/suddenHighwayTypeChangeCheck.md) | The purpose of this check is to identify roads that jump to much different highway classifications. | | [UnwalkableWaysCheck](checks/unwalkableWaysCheck.md) | The purpose of this check is to identify any non-motorway single carriageway edges with no foot tags that cross any high-priority roads that are dual carriageways. | -| ValenceOneImportantRoadCheck | This check identifies important roads that either start or end with valance-1 nodes. | +| [ValenceOneImportantRoadCheck](checks/valenceOneImportantRoadCheck.md) | This check identifies important roads that either start or end with valance-1 nodes. | ## Nodes | Check Name | Check Description | diff --git a/docs/checks/longSegmentCheck.md b/docs/checks/longSegmentCheck.md new file mode 100644 index 000000000..9b0f3d9e1 --- /dev/null +++ b/docs/checks/longSegmentCheck.md @@ -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) \ No newline at end of file diff --git a/docs/checks/overlappingEdgeCheck.md b/docs/checks/overlappingEdgeCheck.md new file mode 100644 index 000000000..d80033570 --- /dev/null +++ b/docs/checks/overlappingEdgeCheck.md @@ -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) \ No newline at end of file diff --git a/docs/checks/roadLinkCheck.md b/docs/checks/roadLinkCheck.md new file mode 100644 index 000000000..5e4edacd5 --- /dev/null +++ b/docs/checks/roadLinkCheck.md @@ -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) \ No newline at end of file diff --git a/docs/checks/shortSegmentCheck.md b/docs/checks/shortSegmentCheck.md new file mode 100644 index 000000000..5c094b021 --- /dev/null +++ b/docs/checks/shortSegmentCheck.md @@ -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) \ No newline at end of file diff --git a/docs/checks/valenceOneImportantRoadCheck.md b/docs/checks/valenceOneImportantRoadCheck.md new file mode 100644 index 000000000..52ae4e278 --- /dev/null +++ b/docs/checks/valenceOneImportantRoadCheck.md @@ -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) \ No newline at end of file