diff options
| author | Even Rouault <even.rouault@spatialys.com> | 2018-07-10 18:01:12 +0200 |
|---|---|---|
| committer | Even Rouault <even.rouault@spatialys.com> | 2018-07-10 18:51:08 +0200 |
| commit | b7afba5651aa5fe93546253510838f34abb80e88 (patch) | |
| tree | f89d6ce334d7e299a8af6b410f6209ca5d3670ff /docs/source/operations | |
| parent | 81bfa7551ffb3f0406760f566c50b84370c3d020 (diff) | |
| download | PROJ-b7afba5651aa5fe93546253510838f34abb80e88.tar.gz PROJ-b7afba5651aa5fe93546253510838f34abb80e88.zip | |
vgridshift: add a +multiplier={value} parameter
As mentionned in #1071, it is often unclear how the offset of a vertical grid
is applied.
Diffstat (limited to 'docs/source/operations')
| -rw-r--r-- | docs/source/operations/transformations/vgridshift.rst | 16 |
1 files changed, 16 insertions, 0 deletions
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=<value> + + 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 |