Skip to content

Commit

Permalink
docs: non-positive values of maximum_grade_level encoder config par…
Browse files Browse the repository at this point in the history 
…ameter (#1775)
  • Loading branch information
@takb
takb authored Apr 16, 2024
2 parents 0c404f2 + 83fda82 commit 9472c65
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ RELEASING:
## [Unreleased]
### Added
- documentation for A* config parameters ([#1759](https://github.com/GIScience/openrouteservice/pull/1759))
- documentation for non-positive values of `maximum_grade_level` encoder config parameter ([#1775](https://github.com/GIScience/openrouteservice/pull/1775))
- keep-alive-timeout for spring internal tomcat ([#1780](https://github.com/GIScience/openrouteservice/pull/1780))

### Fixed
Expand Down
18 changes: 9 additions & 9 deletions docs/run-instance/configuration/ors/engine/profiles.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,15 @@ Properties for each (enabled) profile are set under `ors.engine.profiles.<profil

Properties beneath `ors.engine.profiles.*.encoder_options`:

| key | type | profiles | description | example value |
|--------------------------|---------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| block_fords | boolean | * | Do not route through fords | `true` |
| consider_elevation | boolean | bike-* | The maximum possible speed is the bike-type specific maximum downhill speed, which is higher than the usual maximum speed | `true` |
| maximum_grade_level | number | car, hgv | Relates to the quality of tracks as described in [tracktype](https://wiki.openstreetmap.org/wiki/Key:tracktype). Specifying e.g. maximum_grade_level=1 means that tracktype=grade2 and below won't be considered for routing | `3` |
| preferred_speed_factor | number | wheelchair | Travel speeds on edges classified as preferable for wheelchair users are multiplied by this factor, use to set faster traveling speeds on such ways | `1.2` |
| problematic_speed_factor | number | wheelchair | Travel speeds on edges classified as problematic for wheelchair users are multiplied by this factor, use to set slow traveling speeds on such ways | `0.7` |
| turn_costs | boolean | car, hgv, bike-* | Should turn restrictions be respected | `true` |
| use_acceleration | boolean | car, hgv | Models how a vehicle would accelerate on the road segment to the maximum allowed speed. In practice it reduces speed on shorter road segments such as ones between nearby intersections in a city | `true` |
| key | type | profiles | description | example value |
|--------------------------|---------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| block_fords | boolean | * | Do not route through fords | `true` |
| consider_elevation | boolean | bike-* | The maximum possible speed is the bike-type specific maximum downhill speed, which is higher than the usual maximum speed | `true` |
| maximum_grade_level | number | car, hgv | Relates to the quality of tracks as described in [tracktype](https://wiki.openstreetmap.org/wiki/Key:tracktype). Specifying e.g. `maximum_grade_level=1` means that `tracktype=grade2` and below won't be considered for routing. Setting `maximum_grade_level=0` discards all tracks with a valid `tracktype` tag, while a negative value such as `maximum_grade_level=-1` entirely disables routing on tracks. | `3` |
| preferred_speed_factor | number | wheelchair | Travel speeds on edges classified as preferable for wheelchair users are multiplied by this factor, use to set faster traveling speeds on such ways | `1.2` |
| problematic_speed_factor | number | wheelchair | Travel speeds on edges classified as problematic for wheelchair users are multiplied by this factor, use to set slow traveling speeds on such ways | `0.7` |
| turn_costs | boolean | car, hgv, bike-* | Should turn restrictions be respected | `true` |
| use_acceleration | boolean | car, hgv | Models how a vehicle would accelerate on the road segment to the maximum allowed speed. In practice it reduces speed on shorter road segments such as ones between nearby intersections in a city | `true` |

## preparation

Expand Down

0 comments on commit 9472c65

Please sign in to comment.