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: document A* config parameters #1759

Merged
merged 1 commit into from
Mar 26, 2024
Merged

docs: document A* config parameters #1759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ RELEASING:
-->

## [Unreleased]
### Added
- documentation for A* config parameters ([#1759](https://github.com/GIScience/openrouteservice/pull/1759))

## [8.0.0] - 2024-03-21
### Added
Expand Down
29 changes: 20 additions & 9 deletions docs/run-instance/configuration/ors/engine/profiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,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 | `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 Expand Up @@ -113,6 +113,17 @@ Properties beneath `ors.engine.profiles.*.preparation.methods.core`:

Properties beneath `ors.engine.profiles.*.execution` are relevant when querying services.

### methods.astar

Parameters for beeline approximation in the A* routing algorithm.

Properties beneath `ors.engine.profiles.*.execution.methods.astar`:

| key | type | description | default value |
|---------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| approximation | string | Method to use for distance approximation. Can be either the faster `BeelineSimplification` or the more precise but slower `BeelineAccurate` | `BeelineSimplification` |
| epsilon | number | Factor to use for distance approximation | `1` |

### methods.lm

Settings for using landmarks in routing.
Expand Down
Loading