aboutsummaryrefslogtreecommitdiff
path: root/docs/source/operations/transformations/vgridshift.rst
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2018-05-01 19:41:42 +0200
committerGitHub <noreply@github.com>2018-05-01 19:41:42 +0200
commit3b1cca0b2e094ee14abcfd111b438b7e74300836 (patch)
treedf7fba0af55ca1bdd299f6515ed78ad4dbfb4bd2 /docs/source/operations/transformations/vgridshift.rst
parent2fdbffca6c61687dc064e92d5a7fedc53ebb4744 (diff)
parent82dd6b06010b8f37ec1ff797d2ae06d8a8cc0bf2 (diff)
downloadPROJ-3b1cca0b2e094ee14abcfd111b438b7e74300836.tar.gz
PROJ-3b1cca0b2e094ee14abcfd111b438b7e74300836.zip
Merge pull request #966 from kbevers/doc-improvements
Doc improvements
Diffstat (limited to 'docs/source/operations/transformations/vgridshift.rst')
-rw-r--r--docs/source/operations/transformations/vgridshift.rst19
1 files changed, 15 insertions, 4 deletions
diff --git a/docs/source/operations/transformations/vgridshift.rst b/docs/source/operations/transformations/vgridshift.rst
index c583b273..ca2b421c 100644
--- a/docs/source/operations/transformations/vgridshift.rst
+++ b/docs/source/operations/transformations/vgridshift.rst
@@ -4,17 +4,17 @@
Vertical grid shift
================================================================================
+.. versionadded:: 5.0.0
+
Change Vertical datum change by grid shift
+-----------------+--------------------------------------------------------------------+
+| **Domain** | 3D |
++-----------------+--------------------------------------------------------------------+
| **Input type** | Geodetic coordinates (horizontal), meters (vertical). |
+-----------------+--------------------------------------------------------------------+
| **Output type** | Geodetic coordinates (horizontal), meters (vertical). |
+-----------------+--------------------------------------------------------------------+
-| **Options** |
-+-----------------+--------------------------------------------------------------------+
-| `+grids` | Comma-separated list of grids to load. |
-+-----------------+--------------------------------------------------------------------+
The vertical grid shift is done by offsetting the vertical input coordinates by
a specific amount determined by the loaded grids. The simplest use case of the
@@ -39,3 +39,14 @@ list.
PROJ supports the GTX file format for vertical grid corrections. Details
about all the format can be found in the GDAL documentation. GDAL both reads and
writes the format. Using GDAL for construction of new grids is recommended.
+
+Parameters
+################################################################################
+
+.. option:: +grids=<list>
+
+ Comma-separated list of grids to load. If a grid is prefixed by an `@` the
+ grid is consideres optional and PROJ will the not complain if the grid is
+ not available.
+
+ Grids are expected to be in GTX format.