Skip to content

Commit

Permalink
docs: fix table (#1941)
Browse files Browse the repository at this point in the history 
Co-authored-by: Jakob Schnell <[email protected]>
  • Loading branch information
@TheGreatRefrigerator @koebi
TheGreatRefrigerator and koebi authored Jan 8, 2025
1 parent f2b0d63 commit 514764f
Showing 1 changed file with 17 additions and 26 deletions.
43 changes: 17 additions & 26 deletions docs/run-instance/configuration/engine/profiles/build.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,23 @@
Properties beneath `ors.engine.profiles.<profile>.build` are used to define the parameters for building the routing
graphs for the specified profile.

| key | type | description | default value |
|---------------------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
| source_file | string | The OSM file to be used, supported formats are `.osm`, `.osm.gz`, `.osm.zip` and `.pbf` | `ors-api/src/test/files/heidelberg.test.pbf` |
| elevation | boolean | Specifies whether to use or not elevation data | `false` |
| elevation_smoothing | boolean | Smooth out elevation data | `false` |
| traffic | boolean | Use traffic data if available | `false` |
| interpolate_bridges_and_tunnels | boolean | Toggle elevation interpolation of bridges and tunnels on and off | `true` |
| instructions | boolean | Specifies whether way names will be stored during the import or not | `true` |
| optimize | boolean | Optimize the sort order when contracting nodes for CH. This is rather expensive, but yields a better contraction hierarchy. | `false` |
| maximum_speed_lower_bound | number | Specifies the threshold for the query parameter `maximum_speed`, required when calculating preparation data for the Core-ALT algorithm | `80` |

[//]: # (TODO: verify above with @aoles)
| encoder_flags_size | number | The number of bytes used for FlagEncoders | `8` |
| location_index_resolution | number | The minimum resolution in meters of tiles in the location index. Lower values
yield faster queries at a cost of increased memory requirements. Reducing the resolution reduces the lookup radius which
can be compensated by increasing `location_index_search_iterations`. Corresponds to GraphHopper's
`index.high_resolution` configuration parameter. | `500` |
| location_index_search_iterations | number | The maximum number of iterations performed in coordinates lookup. Higher
values yield a broader search area, but might reduce query performance. It only affects the storage lookup but not its
layout so changing this parameter does not require rebuilding the location index. Corresponds to GraphHopper's
`index.max_region_search` configuration parameter. | `4` |
| gtfs_file | string | Only for `public-transport` profile: location of GTFS data; can either be a zip-file or the
unzipped folder | _NA_ |
| encoder_options | string | For details see [encoder_options](#encoder-options) below | |
| preparation | object | [Preparation settings](#preparation) for building the routing graphs | |
| ext_storages | object | [External storages](#ext_storages) for returning extra information | |
| key | type | description | default value |
|----------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
| source_file | string | The OSM file to be used, supported formats are `.osm`, `.osm.gz`, `.osm.zip` and `.pbf` | `ors-api/src/test/files/heidelberg.test.pbf` |
| elevation | boolean | Specifies whether to use or not elevation data | `false` |
| elevation_smoothing | boolean | Smooth out elevation data | `false` |
| traffic | boolean | Use traffic data if available | `false` |
| interpolate_bridges_and_tunnels | boolean | Toggle elevation interpolation of bridges and tunnels on and off | `true` |
| instructions | boolean | Specifies whether way names will be stored during the import or not | `true` |
| optimize | boolean | Optimize the sort order when contracting nodes for CH. This is rather expensive, but yields a better contraction hierarchy. | `false` |
| maximum_speed_lower_bound | number | Specifies the threshold for the query parameter `maximum_speed`, required when calculating preparation data for the Core-ALT algorithm | `80` |
| encoder_flags_size | number | The number of bytes used for FlagEncoders | `8` |
| location_index_resolution | number | The minimum resolution in meters of tiles in the location index. Lower values yield faster queries at a cost of increased memory requirements. Reducing the resolution reduces the lookup radius which can be compensated by increasing `location_index_search_iterations`. Corresponds to GraphHopper's `index.high_resolution` configuration parameter. | `500` |
| location_index_search_iterations | number | The maximum number of iterations performed in coordinates lookup. Higher values yield a broader search area, but might reduce query performance. It only affects the storage lookup but not its layout so changing this parameter does not require rebuilding the location index. Corresponds to GraphHopper's `index.max_region_search` configuration parameter. | `4` |
| gtfs_file | string | Only for `public-transport` profile: location of GTFS data; can either be a zip-file or the unzipped folder | _NA_ |
| encoder_options | string | For details see [encoder_options](#encoder-options) below | |
| preparation | object | [Preparation settings](#preparation) for building the routing graphs | |
| ext_storages | object | [External storages](#ext_storages) for returning extra information | |

## `encoder_options`

Expand Down

0 comments on commit 514764f

Please sign in to comment.