Compare commits

...

10 Commits

Author SHA1 Message Date
Michael Krasnyk
5484118d77
Bump version to 5.14.1 2017-11-29 13:28:30 +01:00
Michael Krasnyk
2116cc68ca
Don't use removed alternative paths in filterPackedPathsByCellSharing 2017-11-29 13:21:54 +01:00
Daniel Patterson
531b281b73
Use the correct driving_side property on the arrive step. (#4708)
Use the correct driving_side property on the arrive step.
2017-11-27 13:17:03 -08:00
Daniel J. Hofmann
7137459fb0
Makes MLD default algorithm in example to avoid confusion, see #4702 2017-11-27 12:37:13 -08:00
brian lewis
f57fd4ffc3
Refer to Lua scripting language by its correct name 2017-11-27 12:37:04 -08:00
brian lewis
275f71a7d7
Fix typos in profiles documentation 2017-11-27 12:36:58 -08:00
Daniel Patterson
2c7d1ed48c
Add Macau and Hong Kong to the left-side driving polygon file. 2017-11-27 12:36:48 -08:00
Daniel Patterson
d67cd34edd
Enable building release candidate branch 2017-11-22 12:54:12 -08:00
Daniel Patterson
c8c3a49fb5
Set changelog to 5.14 2017-11-22 12:36:01 -08:00
Daniel Patterson
3ae313d35d
Make 5.14.0-rc.1 2017-11-22 12:35:30 -08:00
11 changed files with 335 additions and 62 deletions

View File

@ -15,6 +15,7 @@ branches:
- master
# enable building tags
- /^v\d+\.\d+(\.\d+)?(-\S*)?$/
- 5.14
cache:
yarn: true
@ -422,7 +423,7 @@ install:
script:
- if [[ $TARGET_ARCH == armhf ]] ; then echo "Skip tests for $TARGET_ARCH" && exit 0 ; fi
- make -C test/data benchmark
- ./example/build/osrm-example test/data/ch/monaco.osrm
- ./example/build/osrm-example test/data/mld/monaco.osrm
# All tests assume to be run from the build directory
- pushd ${OSRM_BUILD_DIR}
- ./unit_tests/library-tests

View File

@ -1,4 +1,9 @@
# UNRELEASED
# 5.14.1
- Changes from 5.14.0
- Bugfixes:
- FIXED: don't use removed alternative candidates in `filterPackedPathsByCellSharing`
# 5.14.0
- Changes from 5.13
- API:
- ADDED: new RouteStep property `driving_side` that has either "left" or "right" for that step

View File

@ -62,7 +62,7 @@ endif()
project(OSRM C CXX)
set(OSRM_VERSION_MAJOR 5)
set(OSRM_VERSION_MINOR 14)
set(OSRM_VERSION_PATCH 0)
set(OSRM_VERSION_PATCH 1)
set(OSRM_VERSION "${OSRM_VERSION_MAJOR}.${OSRM_VERSION_MINOR}.${OSRM_VERSION_PATCH}")
add_definitions(-DOSRM_PROJECT_DIR="${CMAKE_CURRENT_SOURCE_DIR}")

View File

@ -1,6 +1,6 @@
# Everyone
Please take some time to review our [code of conduct](CODE_OF_CONDUCT.md) to help guide your interactions with others on this project.
Please take some time to review our [code of conduct](CODE-OF-CONDUCT.md) to help guide your interactions with others on this project.
# User

View File

@ -36,7 +36,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -399,7 +401,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -506,7 +510,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -589,7 +595,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1277,7 +1285,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1308,7 +1318,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1339,7 +1351,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1370,7 +1384,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1529,7 +1545,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1560,7 +1578,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1591,7 +1611,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1622,7 +1644,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1653,7 +1677,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1684,7 +1710,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1715,7 +1743,9 @@
},
{
"type": "Feature",
"properties": { "driving_side" : "left" },
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
@ -1743,6 +1773,212 @@
]
]
}
},
{
"type": "Feature",
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
113.53256464004518,
22.17096258989228
],
[
113.53754281997682,
22.16047023983672
],
[
113.54106187820436,
22.154587822430837
],
[
113.54878664016725,
22.14703570986906
],
[
113.54990243911743,
22.141947742446394
],
[
113.54792833328247,
22.118731558535227
],
[
113.54852914810182,
22.11006426296891
],
[
113.56088876724245,
22.105531611874294
],
[
113.5914444923401,
22.117300298747207
],
[
113.60217332839966,
22.136303063467075
],
[
113.58766794204713,
22.183520585503548
],
[
113.57015848159791,
22.189083895743767
],
[
113.56621026992799,
22.189163370008256
],
[
113.56406450271608,
22.190514425625366
],
[
113.56380701065065,
22.19941517306984
],
[
113.56191873550418,
22.2050573189853
],
[
113.56088876724245,
22.21260631441281
],
[
113.55256319046022,
22.217294433458783
],
[
113.54850769042969,
22.21683754739093
],
[
113.5441303253174,
22.217056058304685
],
[
113.54318618774415,
22.216479983343337
],
[
113.5415554046631,
22.213242000752253
],
[
113.54114770889284,
22.213003618712484
],
[
113.53824019432068,
22.213659168347313
],
[
113.53728532791139,
22.21367903343993
],
[
113.53571891784668,
22.213559842841935
],
[
113.53435635566713,
22.213182405280275
],
[
113.53312253952026,
22.212367931293002
],
[
113.53496789932252,
22.20616982803302
],
[
113.53222131729127,
22.19401121511328
],
[
113.52681398391725,
22.184792218694355
],
[
113.53256464004518,
22.17096258989228
]
]
]
}
},
{
"type": "Feature",
"properties": {
"driving_side": "left"
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
114.1398811340332,
22.298308554808454
],
[
114.1146469116211,
22.295926164040363
],
[
114.10280227661133,
22.2808367460213
],
[
114.1505241394043,
22.226342457476385
],
[
114.20768737792969,
22.188199741518677
],
[
114.26794052124023,
22.199325771045544
],
[
114.26673889160155,
22.257008033931445
],
[
114.24699783325194,
22.278295210101668
],
[
114.22657012939453,
22.29354373265189
],
[
114.20408248901367,
22.29973796977008
],
[
114.184513092041,
22.290843594643704
],
[
114.16563034057617,
22.28925525380013
],
[
114.1398811340332,
22.298308554808454
]
]
]
}
}
]
}

View File

@ -6,7 +6,7 @@ OSRM supports "profiles". Profiles representing routing behavior for different t
## Available profiles
Out-of-the-box OSRM comes with profiles for car, bicycle and foot. You can easily modify these or create new ones if you like.
Profiles have a 'lua' extension, and are places in 'profiles' directory.
Profiles have a 'lua' extension, and are placed in 'profiles' directory.
When running OSRM preprocessing commands you specify the profile with the --profile (or the shorthand -p) option, for example:
@ -17,8 +17,8 @@ It's important to understand that profiles are used when preprocessing the OSM d
This means that after modifying a profile **you will need to extract, contract and reload the data again** and to see changes in the routing results. See [Processing Flow](https://github.com/Project-OSRM/osrm-backend/wiki/Processing-Flow) for more.
## Profiles are written in LUA
Profiles are not just configuration files. They are scripts written in the [LUA scripting language](http://www.lua.org). The reason for this is that OpenStreetMap data is complex, and it's not possible to simply define tag mappings. LUA scripting offers a powerful way to handle all the possible tag combinations found in OpenStreetMap nodes and ways.
## Profiles are written in Lua
Profiles are not just configuration files. They are scripts written in the [Lua scripting language](http://www.lua.org). The reason for this is that OpenStreetMap data is complex, and it's not possible to simply define tag mappings. Lua scripting offers a powerful way to handle all the possible tag combinations found in OpenStreetMap nodes and ways.
## Basic structure of profiles
A profile will process every node and way in the OSM input data to determine what ways are routable in which direction, at what speed, etc.
@ -35,40 +35,40 @@ A profile can also define various local functions it needs.
Looking at [car.lua](../profiles/car.lua) as an example, at the top of the file the api version is defined and then required library files are included.
Then follows the `setup` functions, which is called once when the profile is loaded. It returns a big hash table of configurations, specifying things like what speed to use for different way types. The configurations are used later in the various processing functions. Many adjustments can be done just be modifying this configuration table.
Then follows the `setup` function, which is called once when the profile is loaded. It returns a big hash table of configurations, specifying things like what speed to use for different way types. The configurations are used later in the various processing functions. Many adjustments can be done just by modifying this configuration table.
The setup function is also where you can do other setup, like loading elevation data source if you want to consider that when processing ways.
The setup function is also where you can do other setup, like loading an elevation data source if you want to consider that when processing ways.
Then comes the `process_node` and `process_way` functions, which are called for each OSM node and way when extracting OpenStreetMap data with `osrm-extract`.
Then come the `process_node` and `process_way` functions, which are called for each OSM node and way when extracting OpenStreetMap data with `osrm-extract`.
The `process_turn` function processes every possible turn in the network, and sets a penalty depending on the angle and turn of the movement.
Profiles can also define a `process_segment` function to handle differences in speed along an OSM way, for example to handle elevation. As you can see, this is not currently used in the car profile.
At the end of the file, a table if returned with references to the setup and processing functions the profile has defined.
At the end of the file, a table is returned with references to the setup and processing functions the profile has defined.
## Understanding speed, weight and rate
When computing a route from A to B there can be different measure of what is the best route. That's why there's a need for different profiles.
When computing a route from A to B there can be different measures of what is the best route. That's why there's a need for different profiles.
Because speeds very on different types of roads, the shortest and the fastest route are typically different. But there are many other possible preferences. For example a user might prefer a bicycle route that follow parks or other green areas, even though both duration and distance are a bit longer.
Because speeds vary on different types of roads, the shortest and the fastest route are typically different. But there are many other possible preferences. For example a user might prefer a bicycle route that follow parks or other green areas, even though both duration and distance are a bit longer.
To handle this, OSRM doesn't simply choose the ways with the highest speed. Instead it uses the concept of `weight` and `rate`. The rate is an abstract measure that you can assign to ways as you like to make some ways preferable to others. Routing will prefer ways with high rate.
To handle this, OSRM doesn't simply choose the ways with the highest speed. Instead it uses the concepts of `weight` and `rate`. The rate is an abstract measure that you can assign to ways as you like to make some ways preferable to others. Routing will prefer ways with high rate.
The weight of a way normally computed as length / rate. The weight can be thought of as the resistance or cost when passing the way. Routing will prefer ways with low weight.
The weight of a way is normally computed as length / rate. The weight can be thought of as the resistance or cost when passing the way. Routing will prefer ways with low weight.
You can also set the weight of a way to a fixed value, In this case it's not calculated based on the length or rate, and the rate is ignored.
You can also set the weight of a way to a fixed value. In this case it's not calculated based on the length or rate, and the rate is ignored.
You should set the speed to you best estimate of the actual speed that will be used on a particular way. This will result in the best estimated travel times.
You should set the speed to your best estimate of the actual speed that will be used on a particular way. This will result in the best estimated travel times.
If you want to prefer certain ways due to other factors than the speed, adjust the rate accordingly. If you adjust the speed, the time time estimation will be skewed.
If you want to prefer certain ways due to other factors than the speed, adjust the rate accordingly. If you adjust the speed, the time estimation will be skewed.
If you set the same rate on all ways, the result will be shortest path routing.
If you set rate = speed on all ways, the result will be fastest path routing.
If you want to prioritize certain street, increase the rate on these.
If you want to prioritize certain streets, increase the rate on these.
## Elements
### api_version
A profile should set api_version at the top of your profile. This is done to ensure that older profiles are still supported when the api changes. If api_version is not defined, 0 will be assumed. The current api version is 2.
A profile should set `api_version` at the top of your profile. This is done to ensure that older profiles are still supported when the api changes. If `api_version` is not defined, 0 will be assumed. The current api version is 2.
### Library files
The folder [profiles/lib/](../profiles/lib/) contains LUA library files for handling many common processing tasks.
@ -81,15 +81,15 @@ set.lua | Defines the Set helper for handling sets of values
sequence.lua | Defines the Sequence helper for handling sequences of values
access.lua | Function for finding relevant access tags
destination.lua | Function for finding relevant destination tags
destination.lua | Function for determining maximum speed
maxspeed.lua | Function for determining maximum speed
guidance.lua | Function for processing guidance attributes
They all return a table of functions when you use `require` to load them. You can either store this table and reference it's functions later, of if you need only a single you can store that directly.
They all return a table of functions when you use `require` to load them. You can either store this table and reference its functions later, or if you need only a single function you can store that directly.
### setup()
The `setup` function is called once when the profile is loaded and must return a table of configurations. It's also where you can do other global setup, like loading data sources that are used during processing.
Note that processing of data is parallelized and several unconnected LUA interpreters will be running at the same time. The `setup` function will be called once for each. Each LUA iinterpreter will have it's own set of globals.
Note that processing of data is parallelized and several unconnected LUA interpreters will be running at the same time. The `setup` function will be called once for each. Each LUA iinterpreter will have its own set of globals.
The following global properties can be set under `properties` in the hash you return in the `setup` function:
@ -109,8 +109,7 @@ The following additional global properties can be set in the hash you return in
Attribute | Type | Notes
-------------------------------------|------------------|----------------------------------------------------------------------------
excludable | Sequence of Sets | Determines which class-combinations are supported by the `exclude` option at query time.
| | E.g. `Sequence{Set{"ferry", "motorway"}, Set{"motorway"}}` will allow you to exclude ferries and motorways, or only motorways.
excludable | Sequence of Sets | Determines which class-combinations are supported by the `exclude` option at query time. E.g. `Sequence{Set{"ferry", "motorway"}, Set{"motorway"}}` will allow you to exclude ferries and motorways, or only motorways.
classes | Sequence | Determines the allowed classes that can be referenced using `{forward,backward}_classes` on the way in the `process_way` function.
restrictions | Sequence | Determines which turn restrictions will be used for this profile.
suffix_list | Set | List of name suffixes needed for determining if "Highway 101 NW" the same road as "Highway 101 ES".
@ -147,26 +146,26 @@ Importantly it will set `result.forward_mode` and `result.backward_mode` to indi
It will also set a number of other attributes on `result`.
Using the power of the scripting language you wouldn't typically see something as simple as a `result.forward_speed = 20` line within the `process_way` function. Instead `process_way` will examine the tag set on the way, process this information in various ways, calling other local functions and referencing the configuration in `profile`, etc, before arriving at the result.
Using the power of the scripting language you wouldn't typically see something as simple as a `result.forward_speed = 20` line within the `process_way` function. Instead `process_way` will examine the tag set on the way, process this information in various ways, calling other local functions and referencing the configuration in `profile`, etc., before arriving at the result.
The following attributes can be set on the result in `process_way`:
Attribute | Type | Notes
----------------------------------------|----------|--------------------------------------------------------------------------
forward_speed | Float | Speed on this way in km/h. Mandatory.
backward_speed | Float | " "
backward_speed | Float | ""
forward_rate | Float | Routing weight, expressed as meters/*weight* (e.g. for a fastest-route weighting, you would want this to be meters/second, so set it to forward_speed/3.6)
backward_rate | Float | " "
backward_rate | Float | ""
forward_mode | Enum | Mode of travel (e.g. `car`, `ferry`). Mandatory. Defined in `include/extractor/travel_mode.hpp`.
backward_mode | Enum | " "
backward_mode | Enum | ""
forward_classes | Table | Mark this way as being of a specific class, e.g. `result.classes["toll"] = true`. This will be exposed in the API as `classes` on each `RouteStep`.
backward_classes | Table | " "
backward_classes | Table | ""
duration | Float | Alternative setter for duration of the whole way in both directions
weight | Float | Alternative setter for weight of the whole way in both directions
turn_lanes_forward | String | Directions for individual lanes (normalized OSM `turn:lanes` value)
turn_lanes_backward | String | " "
turn_lanes_backward | String | ""
forward_restricted | Boolean | Is this a restricted access road? (e.g. private, or deliveries only; used to enable high turn penalty, so that way is only chosen for start/end of route)
backward_restricted | Boolean | " "
backward_restricted | Boolean | ""
is_startpoint | Boolean | Can a journey start on this way? (e.g. ferry; if `false`, prevents snapping the start point to this way)
roundabout | Boolean | Is this part of a roundabout?
circular | Boolean | Is this part of a non-roundabout circular junction?
@ -188,18 +187,18 @@ The `process_segment` function is called for every segment of OSM ways. A segmen
On OpenStreetMap way cannot have different tags on different parts of a way. Instead you would split the way into several smaller ways. However many ways are long. For example, many ways pass hills without any change in tags.
Processing each segment of an OSM way makes it possible to have different speeds on different parts of a way based on external data like data about elevation, pollution, noise or scenic value and adjust weight and duration of the segment.
Processing each segment of an OSM way makes it possible to have different speeds on different parts of a way based on external data like data about elevation, pollution, noise or scenic value and adjust weight and duration of the segment accordingly.
In the `process_segment` you don't have access to OSM tags. Instead you use the geographical location of the start and end point of the way to lookup other data source, like elevation data. See [rasterbot.lua](../profiles/rasterbot.lua) for an example.
In the `process_segment` function you don't have access to OSM tags. Instead you use the geographical location of the start and end point of the way to look up information from another data source, like elevation data. See [rasterbot.lua](../profiles/rasterbot.lua) for an example.
The following attributes can be read and set on the result in `process_segment`:
Attribute | Read/write? | Type | Notes
-------------------|-------------|---------|----------------------------------------
source.lon | Read | Float | Co-ordinates of segment start
source.lat | Read | Float | " "
source.lat | Read | Float | ""
target.lon | Read | Float | Co-ordinates of segment end
target.lat | Read | Float | " "
target.lat | Read | Float | ""
target.distance | Read | Float | Length of segment
weight | Read/write | Float | Routing weight for this segment
duration | Read/write | Float | Duration for this segment
@ -231,7 +230,7 @@ The priority-category influences the decision which road is considered the obvio
Forks can be emitted between roads of similar priority category only. Obvious choices follow a major priority road, if the priority difference is large.
### Using raster data
OSRM has build-in support for loading an interpolating raster data in ASCII format. This can be used e.g. for factoring in elevation when computing routes.
OSRM has built-in support for loading an interpolating raster data in ASCII format. This can be used e.g. for factoring in elevation when computing routes.
Use `raster:load()` in your `setup` function to load data and store the source in your configuration hash:
@ -284,8 +283,8 @@ See [rasterbot.lua](../profiles/rasterbot.lua) and [rasterbotinterp.lua](../prof
### Helper functions
There are a few helper functions defined in the global scope that profiles can use:
durationIsValid
parseDuration
trimLaneString
applyAccessTokens
canonicalizeStringList
- `durationIsValid`
- `parseDuration`
- `trimLaneString`
- `applyAccessTokens`
- `canonicalizeStringList`

View File

@ -30,9 +30,17 @@ int main(int argc, const char *argv[])
// Configure based on a .osrm base path, and no datasets in shared mem from osrm-datastore
EngineConfig config;
config.storage_config = {argv[1]};
config.use_shared_memory = false;
// We support two routing speed up techniques:
// - Contraction Hierarchies (CH): requires extract+contract pre-processing
// - Multi-Level Dijkstra (MLD): requires extract+partition+customize pre-processing
//
// config.algorithm = EngineConfig::Algorithm::CH;
config.algorithm = EngineConfig::Algorithm::MLD;
// Routing machine with several services (such as Route, Table, Nearest, Trip, Match)
const OSRM osrm{config};

View File

@ -116,3 +116,28 @@ Feature: Testbot - side bias
| from | to | route | driving_side | time |
| d | a | bd,ab,ab | right,right,right | 27s +-1 |
| d | c | bd,bc,bc | right,right,right | 24s +-1 |
Scenario: changing sides
Given the profile "car"
# Note - the boundary in null-island.geojson is at lon = 2.0,
# and we use the "last node of the way" as the heuristic to detect
# whether the way is in our out of the driving_side polygon
And the node locations
| node | lat | lon |
| a | 0 | 0.5 |
| b | 0 | 1.5 |
| c | 0 | 2.5 |
| d | 0 | 3.5 |
And the ways
| nodes |
| ab |
| bc |
| cd |
And the extract extra arguments "--location-dependent-data test/data/regions/null-island.geojson"
When I route I should get
| from | to | route | driving_side |
| d | a | cd,bc,ab,ab | right,right,left,left |
| a | d | ab,bc,cd,cd | left,right,right,right |

View File

@ -312,7 +312,7 @@ inline std::vector<RouteStep> assembleSteps(const datafacade::BaseDataFacade &fa
leg_geometry.locations.size() - 1,
leg_geometry.locations.size(),
{intersection},
facade.IsLeftHandDriving(source_node_id)});
facade.IsLeftHandDriving(target_node_id)});
BOOST_ASSERT(steps.front().intersections.size() == 1);
BOOST_ASSERT(steps.front().intersections.front().bearings.size() == 1);

View File

@ -1,6 +1,6 @@
{
"name": "osrm",
"version": "5.14.0-latest.1",
"version": "5.14.1",
"private": false,
"description": "The Open Source Routing Machine is a high performance routing engine written in C++14 designed to run on OpenStreetMap data.",
"dependencies": {

View File

@ -784,9 +784,8 @@ InternalManyRoutesResult alternativePathSearch(SearchEngineData<Algorithm> &sear
begin(weighted_packed_paths) + 1,
alternative_paths_last);
alternative_paths_last = filterPackedPathsByCellSharing(begin(weighted_packed_paths), //
end(weighted_packed_paths), //
partition); //
alternative_paths_last = filterPackedPathsByCellSharing(
begin(weighted_packed_paths), alternative_paths_last, partition);
BOOST_ASSERT(weighted_packed_paths.size() >= 1);