From 970d708ff9d796f7d9ec00b22023e835fbdc7f2d Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Mon, 30 Apr 2018 22:42:59 +0200 Subject: Refactor operation doc pages Extended the use of the :option: directive to all currently written operation doc pages. In the process several more default parameters were added for easy inclusion in other doc pages. Expanded the info tables for each operation with "domain", "alias", "input type" and "output type". Corrected various errors along the way. Mainly formatting errors and references to invalid parameters such as +sym in hatano. --- docs/source/operations/transformations/vgridshift.rst | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) (limited to 'docs/source/operations/transformations/vgridshift.rst') 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= + + 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. -- cgit v1.2.3