Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(autoware_lanelet2_map_validator): update usage #191

Merged
merged 2 commits into from
Jan 8, 2025
Merged

docs(autoware_lanelet2_map_validator): update usage #191

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9b4436
docs(autoware_lanelet2_map_validator): update usage
soblin Jan 8, 2025
2ebb093
fix
soblin Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions map/autoware_lanelet2_map_validator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator
You can use `autoware_lanelet2_map_validator` with the following command. This will run all validators including the default built-in validators in the [lanelet2_validation](https://github.com/fzi-forschungszentrum-informatik/Lanelet2/tree/master/lanelet2_validation).

```bash
ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator --map_file path/to_your/lanelet2_map.osm --projection mgrs
ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator --map_file <absolute_or_relative_path/to_your/lanelet2_map.osm> --projector mgrs
```

### Run a specific validator
Expand All @@ -41,11 +41,11 @@ ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator --map_f
If you want to call a few validators, you can select them with the `--validator, -v` option.

```bash
ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator --map_file path/to_your/lanelet2_map.osm --projection mgrs --validator mapping.traffic_light.missing_regulatory_elements
ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator --map_file path/to_your/lanelet2_map.osm --projector mgrs --validator mapping.traffic_light.missing_regulatory_elements
```

You can get a list of available validators with the `--print` option.
(`-p` is for `--projection`)
(`-p` is for `--projector`)

```bash
ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator --print
Expand All @@ -58,13 +58,13 @@ ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator --print
The output filename will be `lanelet2_validation_results.json`.

```bash
ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator --map_file path/to_your/lanelet2_map.osm --projection mgrs --input_requirements autoware_requirements_set.json --output_directory ./
ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator --map_file <absolute_or_relative_path/to_your/lanelet2_map.osm> --projector mgrs --input_requirements <absolute_or_relative_path_to_autoware_requirement_set.json> --output_directory ./
```

(Short version)

```bash
ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator -m path/to_your/lanelet2_map.osm -p mgrs -i autoware_requirements_set.json -o ./
ros2 run autoware_lanelet2_map_validator autoware_lanelet2_map_validator -m <absolute_or_relative_path/to_your/lanelet2_map.osm> -p mgrs -i <absolute_or_relative_path_to_autoware_requirement_set.json> -o ./
```

#### Input file
Expand Down
Loading