From b7afba5651aa5fe93546253510838f34abb80e88 Mon Sep 17 00:00:00 2001 From: Even Rouault Date: Tue, 10 Jul 2018 18:01:12 +0200 Subject: vgridshift: add a +multiplier={value} parameter As mentionned in #1071, it is often unclear how the offset of a vertical grid is applied. --- docs/source/operations/transformations/vgridshift.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'docs/source/operations/transformations') diff --git a/docs/source/operations/transformations/vgridshift.rst b/docs/source/operations/transformations/vgridshift.rst index e671779b..484ad4bf 100644 --- a/docs/source/operations/transformations/vgridshift.rst +++ b/docs/source/operations/transformations/vgridshift.rst @@ -113,3 +113,19 @@ Optional .. include:: ../options/t_final.rst .. versionadded:: 5.1.0 +.. option:: +multiplier= + + Specify the multiplier to apply to the grid value in the forward transformation + direction, such that: + + .. math:: + :label: multiplier_formula + + Z_{target} = Z_{source} + multiplier \times gridvalue + + The multiplier can be used to control whether the gridvalue should be added + or sustracted, and if unit conversion must be done (the multiplied gridvalue + must be expressed in metre). + + Note that the default is `-1.0` for historical reasons. +.. versionadded:: 5.2.0 -- cgit v1.2.3