diff --git a/map/autoware_lanelet2_map_validator/README.md b/map/autoware_lanelet2_map_validator/README.md index e0c799f7..d9c32d24 100644 --- a/map/autoware_lanelet2_map_validator/README.md +++ b/map/autoware_lanelet2_map_validator/README.md @@ -153,24 +153,28 @@ When the `input_requirements` is thrown to `autoware_lanelet2_map_validator`, it "issues": [ { "id": 163, + "issue_code": "Crosswalk.MissingRegulatoryElements-001", "message": "No regulatory element refers to this crosswalk.", "primitive": "lanelet", "severity": "Error" }, { "id": 164, + "issue_code": "Crosswalk.MissingRegulatoryElements-001", "message": "No regulatory element refers to this crosswalk.", "primitive": "lanelet", "severity": "Error" }, { "id": 165, + "issue_code": "Crosswalk.MissingRegulatoryElements-001", "message": "No regulatory element refers to this crosswalk.", "primitive": "lanelet", "severity": "Error" }, { "id": 166, + "issue_code": "Crosswalk.MissingRegulatoryElements-001", "message": "No regulatory element refers to this crosswalk.", "primitive": "lanelet", "severity": "Error" @@ -183,6 +187,7 @@ When the `input_requirements` is thrown to `autoware_lanelet2_map_validator`, it "issues": [ { "id": 0, + "issue_code": "General.PrerequisitesFailure-001", "message": "Prerequisites didn't pass", "primitive": "primitive", "severity": "Error" @@ -210,24 +215,28 @@ When the `input_requirements` is thrown to `autoware_lanelet2_map_validator`, it "issues": [ { "id": 9896, + "issue_code": "TrafficLight.MissingRegulatoryElements-001", "message": "Regulatory element of traffic light must have a stop line(ref_line).", "primitive": "regulatory element", "severity": "Error" }, { "id": 9918, + "issue_code": "TrafficLight.MissingRegulatoryElements-001", "message": "Regulatory element of traffic light must have a stop line(ref_line).", "primitive": "regulatory element", "severity": "Error" }, { "id": 9838, + "issue_code": "TrafficLight.MissingRegulatoryElements-001", "message": "Regulatory element of traffic light must have a stop line(ref_line).", "primitive": "regulatory element", "severity": "Error" }, { "id": 9874, + "issue_code": "TrafficLight.MissingRegulatoryElements-001", "message": "Regulatory element of traffic light must have a stop line(ref_line).", "primitive": "regulatory element", "severity": "Error" @@ -250,7 +259,7 @@ When the `input_requirements` is thrown to `autoware_lanelet2_map_validator`, it - `lanelet2_validation_results.json` inherits the JSON file of `input_requirements` and add results to it. - So additional input information not related to this validator also remains in the output. - `autoware_lanelet2_map_validator` adds a boolean `passed` field to each requirement. If all validators of the requirement have been passed, the `passed` field of the requirement will be `true` (`false` if not). -- The `passed` field is also given to each validator. If the validator found any issues the `passed` field will turn to be `false` (`true` if not), and adds an `issues` field which is a list of issues found. Each issue contains information of `severity`, `primitive`, `id`, and `message`. +- The `passed` field is also given to each validator. If the validator found any issues the `passed` field will turn to be `false` (`true` if not), and adds an `issues` field which is a list of issues found. Each issue contains information of `severity`, `primitive`, `id`, `message` and `issue_code`. ### Available command options @@ -303,9 +312,9 @@ The "Validators" column will be blank if it hasn't be implemented. | vm-01-03 | Linestring sharing | | | vm-01-04 | Sharing of the centerline of lanes for opposing traffic | | | vm-01-05 | Lane geometry | | -| vm-01-06 | Line position (1) | | -| vm-01-07 | Line position (2) | | -| vm-01-08 | Line position (3) | | +| vm-01-06 | Line position (1) | (Not possible to validate because real-world correspondence cannot be determined programmatically.) | +| vm-01-07 | Line position (2) | (Not possible to validate because real-world correspondence cannot be determined programmatically.) | +| vm-01-08 | Line position (3) | (Not possible to validate because real-world correspondence cannot be determined programmatically.) | | vm-01-09 | Speed limits | | | vm-01-10 | Centerline | | | vm-01-11 | Centerline connection (1) | | @@ -317,7 +326,7 @@ The "Validators" column will be blank if it hasn't be implemented. | vm-01-17 | Side strip | | | vm-01-18 | Side strip Linestring sharing | | | vm-01-19 | Walkway | | -| vm-02-01 | Stop line alignment | (Not detectable) | +| vm-02-01 | Stop line alignment | (Not possible to validate because real-world correspondence cannot be determined programmatically.) | | vm-02-02 | Stop sign | [mapping.stop_line.missing_regulatory_elements](./docs/stop_line/missing_regulatory_elements_for_stop_lines.md) | | vm-03-01 | Intersection criteria | [mapping.intersection.intersection_area_dangling_reference](./docs/intersection/intersection_area_dangling_reference.md) | | vm-03-02 | Lanelet's turn direction and virtual | | @@ -330,14 +339,14 @@ The "Validators" column will be blank if it hasn't be implemented. | vm-03-09 | Range of Lanelet in the intersection | | | vm-03-10 | Right of way (with signal) | | | vm-03-11 | Right of way (without signal) | | -| vm-03-12 | Right of way supplements | | +| vm-03-12 | Right of way supplements | (Nothing to validate.) | | vm-03-13 | Merging from private area, sidewalk | | | vm-03-14 | Road marking | | | vm-03-15 | Exclusive bicycle lane | | | vm-04-01 | Traffic light basics | [mapping.traffic_light.missing_regulatory_elements](./docs/traffic_light/missing_regulatory_elements_for_traffic_lights.md), [mapping.traffic_light.regulatory_element_details](./docs/traffic_light/regulatory_element_details_for_traffic_lights.md), [mapping.traffic_light.missing_referrers](./docs/traffic_light/missing_referrers_for_traffic_lights.md) | -| vm-04-02 | Traffic light position and size | [mapping.traffic_light.correct_facing](./docs/traffic_light/traffic_light_facing.md) (Undone) | +| vm-04-02 | Traffic light position and size | [mapping.traffic_light.correct_facing](./docs/traffic_light/traffic_light_facing.md) (TODO: Compare the light_bulb direction and traffic_light direction.) | | vm-04-03 | Traffic light lamps | | -| vm-05-01 | Crosswalks across the road | [mapping.crosswalk.missing_regulatory_elements](./docs/crosswalk/missing_regulatory_elements_for_crosswalk.md), [mapping.crosswalk.regulatory_element_details](./docs/crosswalk/regulatory_element_details_for_crosswalks.md) | +| vm-05-01 | Crosswalks across the road | [mapping.crosswalk.missing_regulatory_elements](./docs/crosswalk/missing_regulatory_elements_for_crosswalk.md), [mapping.crosswalk.regulatory_element_details](./docs/crosswalk/regulatory_element_details_for_crosswalks.md) (TODO: handle cases against missing referrers) | | vm-05-02 | Crosswalks with pedestrian signals | | | vm-05-03 | Deceleration for safety at crosswalks | | | vm-05-04 | Fences | | @@ -346,7 +355,7 @@ The "Validators" column will be blank if it hasn't be implemented. | vm-06-03 | No stopping signs | | | vm-06-04 | No stopping sections | | | vm-06-05 | Detection area | | -| vm-07-01 | Vector Map creation range | | -| vm-07-02 | Range of detecting pedestrians who enter the road | | -| vm-07-03 | Guardrails, guard pipes, fences | | -| vm-07-04 | Ellipsoidal height | | +| vm-07-01 | Vector Map creation range | (Not possible to validate because real-world correspondence cannot be determined programmatically?) | +| vm-07-02 | Range of detecting pedestrians who enter the road | (Not possible to validate because real-world correspondence cannot be determined programmatically.) | +| vm-07-03 | Guardrails, guard pipes, fences | (Not possible to validate because real-world correspondence cannot be determined programmatically.) | +| vm-07-04 | Ellipsoidal height | (Not possible to validate because real-world correspondence cannot be determined programmatically?) | diff --git a/map/autoware_lanelet2_map_validator/docs/how_to_contribute.md b/map/autoware_lanelet2_map_validator/docs/how_to_contribute.md index 6689b2ee..1ddd7551 100644 --- a/map/autoware_lanelet2_map_validator/docs/how_to_contribute.md +++ b/map/autoware_lanelet2_map_validator/docs/how_to_contribute.md @@ -1,4 +1,4 @@ -# How to contribute to `autoware_lanelet2_map_validator` +# How to contribute to autoware_lanelet2_map_validator Your contribution is welcome to achieve a broad view of validation for lanelet2 maps. This document gives you the instructions on how to add a validator to `autoware_lanelet2_map_validator`.