Skip to content

Commit

Permalink
Added documentation about new features
Browse files Browse the repository at this point in the history
  • Loading branch information
simdens committed Dec 6, 2023
1 parent 6a84490 commit b8b986d
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/developers/profile_developers_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,10 @@ Some variable names are pre-defined and accessed by the routing engine:

- `downhillcost`
- `downhillcutoff`
- `downhillmaxbuffercost`
- `uphillcost`
- `uphillcutoff`
- `uphillmaxbuffercost`
- `elevationpenaltybuffer`
- `elevationmaxbuffer`
- `elevationbufferreduce`
Expand Down Expand Up @@ -172,6 +174,7 @@ All expressions have one of the following basic forms:
- `and <boolean expression 1> <boolean expression 2>`
- `xor <boolean expression 1> <boolean expression 2>`
- `multiply <numeric expression 1> <numeric expression 2>`
- `div <numeric expression 1> <numeric expression 2>`
- `add <numeric expression 1> <numeric expression 2>`
- `sub <numeric expression 1> <numeric expression 2>`
- `max <numeric expression 1> <numeric expression 2>`
Expand Down Expand Up @@ -276,15 +279,15 @@ it climbed only 10 m on those 500 m, all 10 m would be *swallowed* by cutoff,
together with up to 5 m from the buffer, if there were any.

When elevation does not fit the buffer of size `elevationmaxbuffer`, it is
converted by up/downhillcost ratio to Elevationcost portion of Equivalentlength.
Up/downhillcostfactors are used, if defined, otherwise costfactor is used.
converted by `uphillcost`/`downhillcost` ratio to Elevationcost portion of Equivalentlength.
`uphillcostfactors`/`downhillcostfactors` are used, if defined, otherwise costfactor is used.

- `elevationpenaltybuffer` - default 5(m).

The variable value is used for 2 purposes

- with `buffer content > elevationpenaltybuffer`, it starts partially convert
the buffered elevation to ElevationCost by Up/downhillcost
the buffered elevation to ElevationCost by `uphillcost`/`downhillcost`

- with `elevation taken = MIN (buffer content - elevationpenaltybuffer, WayLength[km] * elevationbufferreduce*10`
Up/downhillcost factor takes place instead of costfactor at the percentage
Expand All @@ -294,8 +297,8 @@ Up/downhillcostfactors are used, if defined, otherwise costfactor is used.
- `elevationmaxbuffer` - default 10(m)

is the size of the buffer, above which all elevation is converted to
Elevationcost by Up/Downhillcost ratio, and - if defined -
Up/downhillcostfactor fully replaces costfactor in way cost calculation.
Elevationcost by `uphillmaxbuffercost`/`downhillmaxbuffercost` parameter or, if those are not defined, by `uphillcost`/`downhillcost` parameter.
Additionally, when reaching `elevationmaxbuffer`, `uphillcostfactor`/ `downhillcostfactor` fully replaces `costfactor` in way cost calculation if those cost factors are defined.

- `elevationbufferreduce` - default 0(slope%)

Expand Down

0 comments on commit b8b986d

Please sign in to comment.