From b8b986d57b0c1cc9c8a141cbbd209bd6cfbaeabb Mon Sep 17 00:00:00 2001 From: Simon Densborn Date: Wed, 6 Dec 2023 16:09:17 +0100 Subject: [PATCH] Added documentation about new features --- docs/developers/profile_developers_guide.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/developers/profile_developers_guide.md b/docs/developers/profile_developers_guide.md index 200732cbc..f12b16fe5 100644 --- a/docs/developers/profile_developers_guide.md +++ b/docs/developers/profile_developers_guide.md @@ -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` @@ -172,6 +174,7 @@ All expressions have one of the following basic forms: - `and ` - `xor ` - `multiply ` + - `div ` - `add ` - `sub ` - `max ` @@ -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 @@ -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%)