aboutsummaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2018-07-11 17:27:10 +0200
committerGitHub <noreply@github.com>2018-07-11 17:27:10 +0200
commit98ead006b9d8b116fdd4f12fd6f45b58ad1ab94a (patch)
treef89d6ce334d7e299a8af6b410f6209ca5d3670ff /docs/source
parent81bfa7551ffb3f0406760f566c50b84370c3d020 (diff)
parentb7afba5651aa5fe93546253510838f34abb80e88 (diff)
downloadPROJ-98ead006b9d8b116fdd4f12fd6f45b58ad1ab94a.tar.gz
PROJ-98ead006b9d8b116fdd4f12fd6f45b58ad1ab94a.zip
Merge pull request #1072 from rouault/vgridshift_add_operation_parameter
vgridshift: add a +multiplier={value}
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/operations/transformations/vgridshift.rst16
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