diff options
| author | Kristian Evers <kristianevers@gmail.com> | 2018-04-30 22:42:59 +0200 |
|---|---|---|
| committer | Kristian Evers <kristianevers@gmail.com> | 2018-04-30 22:57:05 +0200 |
| commit | 970d708ff9d796f7d9ec00b22023e835fbdc7f2d (patch) | |
| tree | cbee11737ed36f20e51ba19c9e8faa757e79ac0d /docs/source | |
| parent | cd23e5f1b2630ee07567bd361373ba725774061b (diff) | |
| download | PROJ-970d708ff9d796f7d9ec00b22023e835fbdc7f2d.tar.gz PROJ-970d708ff9d796f7d9ec00b22023e835fbdc7f2d.zip | |
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.
Diffstat (limited to 'docs/source')
40 files changed, 1022 insertions, 299 deletions
diff --git a/docs/source/operations/conversions/axisswap.rst b/docs/source/operations/conversions/axisswap.rst index ddaad075..0fbe6d76 100644 --- a/docs/source/operations/conversions/axisswap.rst +++ b/docs/source/operations/conversions/axisswap.rst @@ -4,20 +4,26 @@ Axis swap ================================================================================ +.. versionadded:: 5.0.0 + Change the order and sign of 2,3 or 4 axes. -+--------------+---------------------------------------------------------------+ -| **Options** | -+--------------+---------------------------------------------------------------+ -| `+order` | Ordered comma-separated list of axis, e.g. `+order=2,1,3,4` | -+--------------+---------------------------------------------------------------+ ++---------------------+--------------------------------------------------------+ +| **Alias** | axisswap | ++---------------------+--------------------------------------------------------+ ++ **Domain** | 2D, 3D or 4D | ++---------------------+--------------------------------------------------------+ +| **Input type** | Any | ++---------------------+--------------------------------------------------------+ +| **Output type** | Any | ++---------------------+--------------------------------------------------------+ -Each of the possible four axes are numbered with 1-4, such that the first input axis +Each of the possible four axes are numbered with 1--4, such that the first input axis is 1, the second is 2 and so on. The output ordering is controlled by a list of the input axes re-ordered to the new mapping. -Examples +Usage ################################################################################ Reversing the order of the axes:: @@ -37,3 +43,14 @@ It is only necessary to specify the axes that are affected by the swap operation:: +proj=axisswap +order=2,1 + +Parameters +################################################################################ + +.. option:: +order=<list> + + Ordered comma-separated list of axis, e.g. *+order=2,1,3,4*. + Adding a minus in front of an axis number results in a change of direction + for that axis, e.g. southward instead of northward. + + *Required.* diff --git a/docs/source/operations/conversions/cart.rst b/docs/source/operations/conversions/cart.rst index 0c3c7c23..75aa9ab2 100644 --- a/docs/source/operations/conversions/cart.rst +++ b/docs/source/operations/conversions/cart.rst @@ -4,21 +4,22 @@ Cartesian to geodetic conversion ================================================================================ +.. versionadded:: 5.0.0 + Convert geodetic coordinates to cartesian coordinates. -+--------------+--------------------------------------------------------------------+ -| **Options** | -+--------------+--------------------------------------------------------------------+ -| `+ellps` | Ellipsoid of the input coordinates. If used together with the | -| | ellipsoid parameters below, ``+ellps`` is overwritten. | -+--------------+--------------------------------------------------------------------+ -| `+a` | Semi-major radius of ellipsoid axis. | -+--------------+--------------------------------------------------------------------+ -| `+b` | Semi-minor radius of ellipsoid axis. | -+--------------+--------------------------------------------------------------------+ -| `+es` | Eccentricity of ellipsoid. | -+--------------+--------------------------------------------------------------------+ -| `+f` | Flattening of ellipsoid. | -+--------------+--------------------------------------------------------------------+ ++---------------------+--------------------------------------------------------+ +| **Alias** | cart | ++---------------------+--------------------------------------------------------+ ++ **Domain** | 3D | ++---------------------+--------------------------------------------------------+ +| **Input type** | Cartesian coordinates | ++---------------------+--------------------------------------------------------+ +| **Output type** | Cartesian coordinates | ++---------------------+--------------------------------------------------------+ + +Parameters +################################################################################ +.. include:: ../options/ellps.rst diff --git a/docs/source/operations/conversions/latlon.rst b/docs/source/operations/conversions/latlon.rst index 6712fa7b..e6623c95 100644 --- a/docs/source/operations/conversions/latlon.rst +++ b/docs/source/operations/conversions/latlon.rst @@ -4,3 +4,36 @@ Lat/long (Geodetic alias) ******************************************************************************** +Passes geodetic coordinates through unchanged. + ++---------------------+--------------------------------------------------------+ +| **Aliases** | latlon, latlong, lonlat, longlat | ++---------------------+--------------------------------------------------------+ ++ **Domain** | 2D | ++---------------------+--------------------------------------------------------+ +| **Input type** | Geodetic coordinates | ++---------------------+--------------------------------------------------------+ +| **Output type** | Geodetic coordinates | ++---------------------+--------------------------------------------------------+ + +.. note:: Can not be used with the :program:`proj` application. + + +Parameters +################################################################################ + +No parameters will affect the output of the operation if used on it's own. +However, the parameters below can be used in a declarative manner when used with +:program:`cs2cs` or in a :ref:`transformation pipeline <pipeline>` . + +.. include:: ../options/ellps.rst + +.. option:: +datum=<value> + + Declare the datum used with the coordinates. See ``cs2cs -l`` for a + list of available datums. + +.. option:: +towgs84=<list> + + A list of three or seven :ref:`Helmert <helmert>` parameters that maps + the input coordinates to the WGS84 datum. diff --git a/docs/source/operations/conversions/unitconvert.rst b/docs/source/operations/conversions/unitconvert.rst index bc422afb..3ed33273 100644 --- a/docs/source/operations/conversions/unitconvert.rst +++ b/docs/source/operations/conversions/unitconvert.rst @@ -4,23 +4,19 @@ Unit conversion ================================================================================ +.. versionadded:: 5.0.0 + Convert between various distance and time units. -+--------------+--------------------------------------------------------------------+ -| **Options** | -+--------------+--------------------------------------------------------------------+ -| `+xy_in` | Input unit of the horizontal components. | -+--------------+--------------------------------------------------------------------+ -| `+xy_out` | Output unit of the horizontal components. | -+--------------+--------------------------------------------------------------------+ -| `+z_in` | Input unit of the vertical component. | -+--------------+--------------------------------------------------------------------+ -| `+z_out` | Output unit of the vertical component. | -+--------------+--------------------------------------------------------------------+ -| `+t_in` | Input unit of the time component. | -+--------------+--------------------------------------------------------------------+ -| `+t_out` | Output unit of the time component. | -+--------------+--------------------------------------------------------------------+ ++---------------------+--------------------------------------------------------+ +| **Alias** | unitconvert | ++---------------------+--------------------------------------------------------+ ++ **Domain** | 2D, 3D or 4D | ++---------------------+--------------------------------------------------------+ +| **Input type** | Any | ++---------------------+--------------------------------------------------------+ +| **Output type** | Any | ++---------------------+--------------------------------------------------------+ There are many examples of coordinate reference systems that are expressed in other units than the meter. There are also many cases where temporal data @@ -42,16 +38,48 @@ expected to be in units of decimalyears. This can be fixed with `unitconvert`:: +step +proj=unitconvert +t_in=gpsweek +t_out=decimalyear +step +proj=helmert +epoch=2000.0 +t_obs=2017.5 ... +Parameters +################################################################################ + +.. option:: +xy_in=<unit> + + Horizontal input units. See :ref:`distance_units` for a list of available + units. + +.. option:: +xy_out=<unit> + + Horizontal output units. See :ref:`distance_units` for a list of available + units. + +.. option:: +z_in=<unit> + + Vertical output units. See :ref:`distance_units` for a list of available + units. + +.. option:: +z_out=<unit> + + Vertical output units. See :ref:`distance_units` for a list of available + units. + +.. option:: +t_in=<unit> + + Temporal input units. See :ref:`time_units` for a list of available units. + +.. option:: +t_out=<unit> + + Temporal output units. See :ref:`time_units` for a list of available units. + +.. _distance_units: Distance units ############################################################################### In the table below all distance units supported by PROJ is listed. -The same list can also be produced on the command line with `proj` or `cs2cs`, -by adding the `-lu` flag when calling the utility. +The same list can also be produced on the command line with :program:`proj` or +:program:`cs2cs`, by adding the `-lu` flag when calling the utility. +----------+---------------------------------+ -| Label | Name | +| **Label**| **Name** | +----------+---------------------------------+ | km | Kilometer | +----------+---------------------------------+ @@ -96,6 +124,7 @@ by adding the `-lu` flag when calling the utility. | ind-ch | Indian Chain | +----------+---------------------------------+ +.. _time_units: Time units ############################################################################### @@ -103,6 +132,8 @@ Time units In the table below all time units supported by PROJ is listed. +--------------+-----------------------------+ +| **label** | **Name** | ++--------------+-----------------------------+ | mjd | Modified Julian date | +--------------+-----------------------------+ | decimalyear | Decimal year | diff --git a/docs/source/operations/options/R.rst b/docs/source/operations/options/R.rst new file mode 100644 index 00000000..1d4af03a --- /dev/null +++ b/docs/source/operations/options/R.rst @@ -0,0 +1,4 @@ +.. option:: +R=<value> + + Radius of the sphere given in meters. If used in conjunction with ``+ellps`` + ``+R`` takes precedence. diff --git a/docs/source/operations/options/h.rst b/docs/source/operations/options/h.rst new file mode 100644 index 00000000..b41bcada --- /dev/null +++ b/docs/source/operations/options/h.rst @@ -0,0 +1,5 @@ +.. option:: +h=<value> + + Height of the view point above the Earth and must be in the same units as + the radius of the sphere or semimajor axis of the ellipsoid. + diff --git a/docs/source/operations/options/lat_0.rst b/docs/source/operations/options/lat_0.rst index 71e0d190..b8da9cdc 100644 --- a/docs/source/operations/options/lat_0.rst +++ b/docs/source/operations/options/lat_0.rst @@ -1,4 +1,4 @@ -.. option:: +lat_0 +.. option:: +lat_0=<value> Latitude of projection center. diff --git a/docs/source/operations/options/lat_1.rst b/docs/source/operations/options/lat_1.rst new file mode 100644 index 00000000..dee60ee0 --- /dev/null +++ b/docs/source/operations/options/lat_1.rst @@ -0,0 +1,5 @@ +.. option:: +lat_1=<value> + + First standard parallel. + + *Defaults to 0.0.* diff --git a/docs/source/operations/options/lat_2.rst b/docs/source/operations/options/lat_2.rst new file mode 100644 index 00000000..29e739a6 --- /dev/null +++ b/docs/source/operations/options/lat_2.rst @@ -0,0 +1,5 @@ +.. option:: +lat_2=<value> + + Second standard parallel. + + *Defaults to 0.0.* diff --git a/docs/source/operations/options/lon_0.rst b/docs/source/operations/options/lon_0.rst index 9bc4458f..143a7b84 100644 --- a/docs/source/operations/options/lon_0.rst +++ b/docs/source/operations/options/lon_0.rst @@ -1,4 +1,4 @@ -.. option:: +lon_0 +.. option:: +lon_0=<value> Longitude of projection center. diff --git a/docs/source/operations/pipeline.rst b/docs/source/operations/pipeline.rst index abe98776..9223202d 100644 --- a/docs/source/operations/pipeline.rst +++ b/docs/source/operations/pipeline.rst @@ -4,18 +4,18 @@ The pipeline operator ================================================================================ +.. versionadded:: 5.0.0 + Construct complex operations by daisy-chaining operations in a sequential pipeline. +-----------------+--------------------------------------------------------------------+ -| **Input type** | Any. | -+-----------------+--------------------------------------------------------------------+ -| **Output type** | Any. | +| **Alias** | pipeline | +-----------------+--------------------------------------------------------------------+ -| **Options** | +| **Domain** | 2D, 3D and 4D | +-----------------+--------------------------------------------------------------------+ -| `step` | Separate each step in a pipeline. | +| **Input type** | Any | +-----------------+--------------------------------------------------------------------+ -| `inv` | Invert a step in a pipeline. | +| **Output type** | Any | +-----------------+--------------------------------------------------------------------+ .. note:: See the section on :ref:`transformation` for a more thorough introduction @@ -109,3 +109,20 @@ pass an operation that outputs projected coordinates to an operation that expect +step +proj=merc # Mercator outputs projected coordinates +step +proj=robin # The Robinson projection expects angular input +Parameters +------------------------------------------------------------------------------- + +Required ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. option:: +step + + Separate each step in a pipeline. + + +Optional ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. option:: +inv + + Invert a step in a pipeline. diff --git a/docs/source/operations/projections/aea.rst b/docs/source/operations/projections/aea.rst index d4a4c1de..4fcd3cac 100644 --- a/docs/source/operations/projections/aea.rst +++ b/docs/source/operations/projections/aea.rst @@ -4,23 +4,42 @@ Albers Equal Area ******************************************************************************** +---------------------+----------------------------------------------------------+ -| **Classification** | Conic. | +| **Classification** | Conic | +---------------------+----------------------------------------------------------+ -| **Available forms** | Forward and inverse, spherical and elliptical projection.| +| **Available forms** | Forward and inverse, spherical and elliptical projection | +---------------------+----------------------------------------------------------+ -| **Defined area** | Global. | +| **Defined area** | Global | +---------------------+----------------------------------------------------------+ +| **Alias** | aea | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| `+lat_1` | First standard parallel. Defaults to 0.0. | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ -| `+lat_2` | Second standard parallel. Can not be equal to `lat_1`. | -| | Defaults to 0.0. | +| **Output type** | Projected coordinates | +---------------------+----------------------------------------------------------+ + .. image:: ./images/aea.png :scale: 50% :alt: Albers Equal Area +Options +################################################################################ + +.. note:: All options are optional for the Albers Equal Area projection. + +.. include:: ../options/lat_1.rst + +.. include:: ../options/lat_2.rst + +.. include:: ../options/lon_0.rst + +.. include:: ../options/ellps.rst + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst diff --git a/docs/source/operations/projections/aeqd.rst b/docs/source/operations/projections/aeqd.rst index d4baa8b6..4663af3e 100644 --- a/docs/source/operations/projections/aeqd.rst +++ b/docs/source/operations/projections/aeqd.rst @@ -8,14 +8,13 @@ Azimuthal Equidistant +---------------------+----------------------------------------------------------+ | **Available forms** | Forward and inverse, spherical and elliptical projection | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Gerald I. Evenden | +| **Alias** | aeqd | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| `+guam` | Use Guam elliptical formulas. Only accurate near the | -| | Island of Guam (:math:`\lambda\approx 144.5^{\circ}`, | -| | :math:`\phi\approx 13.5^{\circ}`) | -| | Defaults to false. | +| **Input type** | Geodetic coordinates | ++---------------------+----------------------------------------------------------+ +| **Output type** | Projected coordinates | +---------------------+----------------------------------------------------------+ @@ -23,3 +22,29 @@ Azimuthal Equidistant :scale: 50% :alt: Azimuthal Equidistant + +Options +################################################################################ + +.. note:: All options are optional for the Azimuthal Equidistant projection. + +.. option:: +guam + + Use Guam elliptical formulas. Only accurate near the Island of Guam + (:math:`\lambda\approx 144.5^{\circ}`, :math:`\phi\approx 13.5^{\circ}`) + +.. include:: ../options/k_0.rst + +.. include:: ../options/lat_ts.rst + +.. include:: ../options/lat_0.rst + +.. include:: ../options/lon_0.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + +.. include:: ../options/ellps.rst + +.. include:: ../options/R.rst diff --git a/docs/source/operations/projections/airy.rst b/docs/source/operations/projections/airy.rst index eefda4e9..1c856d0a 100644 --- a/docs/source/operations/projections/airy.rst +++ b/docs/source/operations/projections/airy.rst @@ -9,26 +9,47 @@ within the small or great circle defined by an angular distance, :math:`\phi_b`, from the tangency point of the plane :math:`( \lambda_0, \phi_0 )`. +---------------------+----------------------------------------------------------+ -| **Classification** | | +| **Classification** | Azimuthal | +---------------------+----------------------------------------------------------+ | **Available forms** | Forward spherical projection | +---------------------+----------------------------------------------------------+ | **Defined area** | Global | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Gerald I. Evenden | +| **Alias** | airy | +---------------------+----------------------------------------------------------+ -| **Options** | ++ **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| `+lat_b` | Angular distance from tangency point of the plane | -| | :math:`( \lambda_0, \phi_0 )` where the error is kept at | -| | minimum. Defaults to :math:`90^{\circ}` which is | -| | suitable for hemispherical maps. | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ -| `+no_cut` | Do not cut at hemisphere limit | +| **Output type** | Projected coordinates | +---------------------+----------------------------------------------------------+ + .. image:: ./images/airy.png :scale: 50% :alt: Airy +Options +################################################################################ + +.. option:: +lat_b + + Angular distance from tangency point of the plane :math:`( \lambda_0, \phi_0 )` + where the error is kept at minimum. + + *Defaults to 90° (suitable for hemispherical maps).* + +.. option:: +no_cut + + Do not cut at hemisphere limit + +.. include:: ../options/lat_0.rst + +.. include:: ../options/lon_0.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + +.. include:: ../options/R.rst diff --git a/docs/source/operations/projections/aitoff.rst b/docs/source/operations/projections/aitoff.rst index 14b9177a..92ef2f12 100644 --- a/docs/source/operations/projections/aitoff.rst +++ b/docs/source/operations/projections/aitoff.rst @@ -10,9 +10,28 @@ Aitoff +---------------------+----------------------------------------------------------+ | **Defined area** | Global | +---------------------+----------------------------------------------------------+ - +| **Alias** | aitoff | ++---------------------+----------------------------------------------------------+ +| **Domain** | 2D | ++---------------------+----------------------------------------------------------+ +| **Input type** | Geodetic coordinates | ++---------------------+----------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+----------------------------------------------------------+ .. image:: ./images/aitoff.png :scale: 50% :alt: Aitoff +Parameters +################################################################################ + +.. note:: All parameters for the projection are optional. + +.. include:: ../options/lon_0.rst + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst diff --git a/docs/source/operations/projections/alsk.rst b/docs/source/operations/projections/alsk.rst index 659de33b..d08fa827 100644 --- a/docs/source/operations/projections/alsk.rst +++ b/docs/source/operations/projections/alsk.rst @@ -1,7 +1,7 @@ .. _alsk: ******************************************************************************** -Mod. Stererographics of Alaska +Modified Stererographics of Alaska ******************************************************************************** +---------------------+----------------------------------------------------------+ | **Classification** | Modified azimuthal | @@ -10,8 +10,29 @@ Mod. Stererographics of Alaska +---------------------+----------------------------------------------------------+ | **Defined area** | Alaska | +---------------------+----------------------------------------------------------+ +| **Alsk** | alsk | ++---------------------+----------------------------------------------------------+ +| **Domain** | 2D | ++---------------------+----------------------------------------------------------+ +| **Input type** | Geodetic coordinates | ++---------------------+----------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+----------------------------------------------------------+ + .. image:: ./images/alsk.png :scale: 50% :alt: Mod. Stererographics of Alaska +Options +################################################################################ + +.. note:: All options are optional for the projection. + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + +.. include:: ../options/ellps.rst + +.. include:: ../options/R.rst diff --git a/docs/source/operations/projections/apian.rst b/docs/source/operations/projections/apian.rst index 096adf44..6b5e247d 100644 --- a/docs/source/operations/projections/apian.rst +++ b/docs/source/operations/projections/apian.rst @@ -11,8 +11,31 @@ Apian Globular I +---------------------+----------------------------------------------------------+ | **Defined area** | Global | +---------------------+----------------------------------------------------------+ +| **Alias** | apian | ++---------------------+----------------------------------------------------------+ +| **Domain** | 2D | ++---------------------+----------------------------------------------------------+ +| **Input type** | Geodetic coordinates | ++---------------------+----------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+----------------------------------------------------------+ + .. image:: ./images/apian.png :scale: 50% :alt: Apian Globular I +Options +################################################################################ + +.. note:: All options are optional for the Apian Globular projection. + +.. include:: ../options/lat_0.rst + +.. include:: ../options/lon_0.rst + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst diff --git a/docs/source/operations/projections/calcofi.rst b/docs/source/operations/projections/calcofi.rst index 4a29c812..8a240ebd 100644 --- a/docs/source/operations/projections/calcofi.rst +++ b/docs/source/operations/projections/calcofi.rst @@ -14,12 +14,15 @@ California Cooperative Oceanic Fisheries Investigations program, known as CalCOF +---------------------+----------------------------------------------------------+ | **Defined area** | Only valid for the west coast of USA and Mexico | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Frank Warmerdam | +| **Alias** | calcofi | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| `No special options for this projection` | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+----------------------------------------------------------+ + .. image:: ../../../images/calcofi.png @@ -67,6 +70,15 @@ Output of the above command:: 80.0 60.0 -121.15 34.15 +Options +################################################################################ + +.. note:: All options are optional for the CalCOFI projection. + +.. include:: ../options/ellps.rst + +.. include:: ../options/R.rst + Mathematical definition ################################################################################ diff --git a/docs/source/operations/projections/cass.rst b/docs/source/operations/projections/cass.rst index 4111a2ee..dba6a7c4 100644 --- a/docs/source/operations/projections/cass.rst +++ b/docs/source/operations/projections/cass.rst @@ -13,12 +13,15 @@ Although the Cassini projection has been largely replaced by the Transverse Merc +---------------------+-------------------------------------------------------------------------+ | **Defined area** | Global, but best used near the central meridian with long, narrow areas | +---------------------+-------------------------------------------------------------------------+ -| **Implemented by** | Gerald I. Evenden | +| **Alias** | cass | +---------------------+-------------------------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+-------------------------------------------------------------------------+ -| `+lat_0` | Latitude of origin (Default to 0) | +| **Input type** | Geodetic coordinates | +---------------------+-------------------------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+-------------------------------------------------------------------------+ + .. image:: ./images/cass.png :scale: 50% @@ -42,6 +45,24 @@ Example using EPSG 3068 (Soldner Berlin):: $ echo 13.5 52.4 | proj +proj=cass +lat_0=52.41864827777778 +lon_0=13.62720366666667 +x_0=40000 +y_0=10000 +ellps=bessel +datum=potsdam +units=m +no_defs 31343.05 7932.76 +Options +################################################################################ + +.. note:: All options are optional for the Cassini projection. + +.. include:: ../options/lat_0.rst + +.. include:: ../options/lon_0.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + +.. include:: ../options/ellps.rst + +.. include:: ../options/R.rst + + Mathematical definition ####################### diff --git a/docs/source/operations/projections/ccon.rst b/docs/source/operations/projections/ccon.rst index 8a858e38..f5ceed67 100644 --- a/docs/source/operations/projections/ccon.rst +++ b/docs/source/operations/projections/ccon.rst @@ -4,8 +4,10 @@ Central Conic ******************************************************************************** -This is central (centrographic) projection on cone tangent at ``lat_0`` latitude, -identical with ``conic()`` projection from ``mapproj`` R package. +.. versionadded:: 5.0.0 + +This is central (centrographic) projection on cone tangent at :option:``lat_1`` +latitude, identical with ``conic()`` projection from ``mapproj`` R package. +---------------------+----------------------------------------------------------+ | **Classification** | Conic | @@ -14,13 +16,16 @@ identical with ``conic()`` projection from ``mapproj`` R package. +---------------------+----------------------------------------------------------+ | **Defined area** | Global, but best used near the standard parallel | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Lukasz Komsta | +| **Alias** | ccon | ++---------------------+----------------------------------------------------------+ +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ -| `+lat_1` | Latitude of standard parallel. | +| **Output type** | Projected coordinates | +---------------------+----------------------------------------------------------+ + .. image:: ./images/ccon.png :scale: 50% :alt: Central Conic @@ -44,13 +49,38 @@ The ATPOL coordinates can be achieved with with the following parameters: :: - +proj=ccon +lat_1=52 +lat_0=52 +lon_0=19 +axis=esu +a=6390000 +x_0=330000 +y_0=-350000 + +proj=ccon +lat_1=52 +lon_0=19 +axis=esu +a=6390000 +x_0=330000 +y_0=-350000 For more information see [Komsta2016]_ and [Verey2017]_. +Parameters +################################################################################ + +Required +------------------------------------------------------------------------------- + +.. option:: +lat_1=<value> + + Standard parallel of projection. + +Optional +------------------------------------------------------------------------------- + +.. include:: ../options/lon_0.rst + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + + +Mathematical definition +################################################################################ + Forward projection -================== +------------------------------------------------------------------------------- .. math:: @@ -66,7 +96,7 @@ Forward projection Inverse projection -================== +------------------------------------------------------------------------------- .. math:: @@ -81,7 +111,7 @@ Inverse projection \lambda = \frac{\tan^{-1} \sqrt{x^2+y^2}}{\sin \phi_0} Reference values -================== +################################################################################ For ATPOL to WGS84 test, run the following script: diff --git a/docs/source/operations/projections/eqc.rst b/docs/source/operations/projections/eqc.rst index 5833bd61..de463034 100644 --- a/docs/source/operations/projections/eqc.rst +++ b/docs/source/operations/projections/eqc.rst @@ -13,15 +13,16 @@ The simplest of all projections. Standard parallels (0° when omitted) may be sp +---------------------+----------------------------------------------------------+ | **Defined area** | Global, but best used near the equator | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Gerald I. Evenden | +| **Alias** | eqc | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| `+lat_ts` | Latitude of true scale. Defaults to 0.0 | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ -| `+lat_0` | Center of the map : latitude of origin | +| **Output type** | Projected coordinates | +---------------------+----------------------------------------------------------+ + .. image:: ./images/eqc.png :scale: 50% :alt: Equidistant Cylindrical (Plate Carrée) @@ -67,6 +68,24 @@ Example using Plate Carrée projection with true scale at latitude 30° and cent $ echo -88 30 | proj +proj=eqc +lat_ts=30 +lon_0=90w 192811.01 3339584.72 +Parameters +################################################################################ + + +.. include:: ../options/lon_0.rst + +.. include:: ../options/lat_0.rst + +.. include:: ../options/lat_ts.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + +.. include:: ../options/ellps.rst + +.. include:: ../options/R.rst + Mathematical definition ####################### diff --git a/docs/source/operations/projections/gall.rst b/docs/source/operations/projections/gall.rst index b9120d9f..bdb88895 100644 --- a/docs/source/operations/projections/gall.rst +++ b/docs/source/operations/projections/gall.rst @@ -7,22 +7,26 @@ Gall (Gall Stereographic) The Gall stereographic projection, presented by James Gall in 1855, is a cylindrical projection. It is neither equal-area nor conformal but instead tries to balance the distortion inherent in any projection. -+---------------------+--------------------------------------------------------------------------------+ -| **Classification** | Transverse and oblique cylindrical | -+---------------------+--------------------------------------------------------------------------------+ -| **Available forms** | Forward and inverse, Spherical | -+---------------------+--------------------------------------------------------------------------------+ -| **Defined area** | Global | -+---------------------+--------------------------------------------------------------------------------+ -| **Implemented by** | Gerald I. Evenden | -+---------------------+--------------------------------------------------------------------------------+ -| **Options** | No special options for this projection | -+---------------------+--------------------------------------------------------------------------------+ ++---------------------+----------------------------------------------------------+ +| **Classification** | Transverse and oblique cylindrical | ++---------------------+----------------------------------------------------------+ +| **Available forms** | Forward and inverse, Spherical | ++---------------------+----------------------------------------------------------+ +| **Defined area** | Global | ++---------------------+----------------------------------------------------------+ +| **Alias** | gall | ++---------------------+----------------------------------------------------------+ +| **Domain** | 2D | ++---------------------+----------------------------------------------------------+ +| **Input type** | Geodetic coordinates | ++---------------------+----------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+----------------------------------------------------------+ .. image:: ./images/gall.png :scale: 50% - :alt: Gall (Gall Stereographic) + :alt: Gall (Gall Stereographic) Usage ##### @@ -38,7 +42,7 @@ Unlike the Mercator, the Gall shows the poles as lines running across the top an Example using Gall Stereographical :: - $ echo 9 51 | proj +proj=gall +lon_0=0 +x_0=0 +y_0=0 +ellps=WGS84 +datum=WGS84 +units=m +no_defs + $ echo 9 51 | proj +proj=gall +lon_0=0 +x_0=0 +y_0=0 +ellps=WGS84 +datum=WGS84 +units=m +no_defs 708432.90 5193386.36 Example using Gall Stereographical (Central meridian 90°W) :: @@ -46,6 +50,22 @@ Example using Gall Stereographical (Central meridian 90°W) :: $ echo 9 51 | proj +proj=gall +lon_0=90w +x_0=0 +y_0=0 +ellps=WGS84 +datum=WGS84 +units=m +no_defs 7792761.91 5193386.36 +Parameters +################################################################################ + +.. note:: All parameters for the projection are optional. + +.. include:: ../options/lon_0.rst + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + +.. include:: ../options/ellps.rst + + Mathematical definition ####################### @@ -70,7 +90,7 @@ Inverse projection .. math:: - \phi = 2 \arctan( \frac{y}{1+\frac{\sqrt{2}}{2}} ) + \phi = 2 \arctan( \frac{y}{1+\frac{\sqrt{2}}{2}} ) .. math:: diff --git a/docs/source/operations/projections/geos.rst b/docs/source/operations/projections/geos.rst index cd576283..3dc914b3 100644 --- a/docs/source/operations/projections/geos.rst +++ b/docs/source/operations/projections/geos.rst @@ -3,6 +3,10 @@ ******************************************************************************** Geostationary Satellite View ******************************************************************************** + +The geos projection pictures how a geostationary satellite scans the earth at regular +scanning angle intervals. + +---------------------+----------------------------------------------------------+ | **Classification** | Azimuthal | +---------------------+----------------------------------------------------------+ @@ -10,16 +14,13 @@ Geostationary Satellite View +---------------------+----------------------------------------------------------+ | **Defined area** | Global | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Gerald I. Evenden and Martin Raspaud | +| **Alias** | geos | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| `+h` | Satellite height above earth. Required. | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ -| `+sweep` | Sweep angle axis of the viewing instrument. | -| | Valid options are ``x`` and ``y``. Defaults to ``y``. | -+---------------------+----------------------------------------------------------+ -| `+lon_0` | Subsatellite longitude point. | +| **Output type** | Projected coordinates | +---------------------+----------------------------------------------------------+ @@ -27,9 +28,6 @@ Geostationary Satellite View :scale: 50% :alt: Geostationary Satellite View -The geos projection pictures how a geostationary satellite scans the earth at regular -scanning angle intervals. - Usage ############################################################################### @@ -70,3 +68,33 @@ The sweep argument is used to tell PROJ which on which axis the outer-gimbal is rotating. The possible values are x or y, y being the default. Thus, the scanning geometry of the Meteosat series satellite should take sweep as x, and GOES should take sweep as y. + +Parameters +################################################################################ + +Required +------------------------------------------------------------------------------- + +.. include:: ../options/h.rst + + +Optional +------------------------------------------------------------------------------- + +.. option:: +sweep=<axis> + + Sweep angle axis of the viewing instrument. Valid options are *"x"* and *"y*". + + *Defaults to "y".* + +.. include:: ../options/lon_0.rst + +.. include:: ../options/R.rst + +.. include:: ../options/ellps.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + + diff --git a/docs/source/operations/projections/hatano.rst b/docs/source/operations/projections/hatano.rst index 5d0c63b7..99e9ac3d 100644 --- a/docs/source/operations/projections/hatano.rst +++ b/docs/source/operations/projections/hatano.rst @@ -12,25 +12,37 @@ Hatano Asymmetrical Equal Area +---------------------+----------------------------------------------------------+ | **Available forms** | Forward and inverse, spherical projection | +---------------------+----------------------------------------------------------+ -| **Defined area** | Global, but best between standard parallels | +| **Defined area** | Global | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Gerald I. Evenden | +| **Alias** | hatano | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| `+lat_1` | Standard Parallel 1 | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ -| `+lat_2` | Standard Parallel 2 | -+---------------------+----------------------------------------------------------+ -| `+sym` | Symmetric form used instead of asymmetric | +| **Output type** | Projected coordinates | +---------------------+----------------------------------------------------------+ + .. image:: ./images/hatano.png :scale: 50% :alt: Hatano Asymmetrical Equal Area +Parameters +################################################################################ + +.. note:: All parameters for the projection are optional. + +.. include:: ../options/lon_0.rst + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + Mathematical Definition -------------------------------------------------------------------------------- @@ -52,10 +64,10 @@ Forward ==================================== ================== =================== -Condition :math:`C_p` :math:`C_p` +Condition :math:`C_y` :math:`C_p` ==================================== ================== =================== -if ``+sym`` or :math:`\phi > 0` 1.75859 2.67595 -if not ``+sym`` and :math:`\phi < 0` 1.93052 2.43763 +For :math:`\phi > 0` 1.75859 2.67595 +For :math:`\phi < 0` 1.93052 2.43763 ==================================== ================== =================== For :math:`\phi = 0`, :math:`y \leftarrow 0`, and :math:`x \leftarrow 0.85\lambda`. diff --git a/docs/source/operations/projections/healpix.rst b/docs/source/operations/projections/healpix.rst index d05b2123..e13c5456 100644 --- a/docs/source/operations/projections/healpix.rst +++ b/docs/source/operations/projections/healpix.rst @@ -4,18 +4,21 @@ HEALPix ******************************************************************************** +---------------------+----------------------------------------------------------+ -| **Classification** | Mixed | +| **Classification** | Miscellaneous | +---------------------+----------------------------------------------------------+ | **Available forms** | Forward and inverse, spherical and elliptical projection | +---------------------+----------------------------------------------------------+ | **Defined area** | Global | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Alex Raichev and Michael Speth | +| **Alias** | healpix | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| `No special options for this projection` | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+----------------------------------------------------------+ + .. image:: ../../../images/healpix.png :scale: 75% @@ -43,13 +46,23 @@ To run a forward HEALPix projection on a unit sphere model, use the following co # output 0 0 0.00 0.00 -Further reading +Parameters ################################################################################ -#. `NASA <http://healpix.jpl.nasa.gov/>`_ -#. `Wikipedia <https://en.wikipedia.org/wiki/HEALPix>`_ +.. note:: All parameters for the projection are optional. + +.. include:: ../options/lon_0.rst +.. include:: ../options/x_0.rst +.. include:: ../options/y_0.rst +.. include:: ../options/ellps.rst +.. include:: ../options/R.rst +Further reading +################################################################################ + +#. `NASA <http://healpix.jpl.nasa.gov/>`_ +#. `Wikipedia <https://en.wikipedia.org/wiki/HEALPix>`_ diff --git a/docs/source/operations/projections/merc.rst b/docs/source/operations/projections/merc.rst index 31ca250a..888b12a3 100644 --- a/docs/source/operations/projections/merc.rst +++ b/docs/source/operations/projections/merc.rst @@ -16,6 +16,8 @@ The projection is conformal which makes it suitable for navigational purposes. +---------------------+----------------------------------------------------------+ | **Defined area** | Global, but best used near the equator | +---------------------+----------------------------------------------------------+ +| **Alias** | merc | ++---------------------+----------------------------------------------------------+ + **Domain** | 2D | +---------------------+----------------------------------------------------------+ | **Input type** | Geodetic coordinates | @@ -52,16 +54,14 @@ Example using scaling factor:: Note that :option:`+lat_ts` and :option:`+k_0` are mutually exclusive. If used together, :option:`+lat_ts` takes precedence over :option:`+k_0`. -Options -######### - -.. note:: All options are optional for the Mercator projection. +Parameters +################################################################################ -.. include:: ../options/k_0.rst +.. note:: All parameters for the projection are optional. .. include:: ../options/lat_ts.rst -.. include:: ../options/lat_0.rst +.. include:: ../options/k_0.rst .. include:: ../options/lon_0.rst @@ -71,6 +71,8 @@ Options .. include:: ../options/ellps.rst +.. include:: ../options/R.rst + Mathematical definition ####################### diff --git a/docs/source/operations/projections/mill.rst b/docs/source/operations/projections/mill.rst index eb9c2092..718d4b9b 100644 --- a/docs/source/operations/projections/mill.rst +++ b/docs/source/operations/projections/mill.rst @@ -7,19 +7,22 @@ Miller Cylindrical The Miller cylindrical projection is a modified Mercator projection, proposed by Osborn Maitland Miller in 1942. The latitude is scaled by a factor of :math:`\frac{4}{5}`, projected according to Mercator, and then the result is multiplied by :math:`\frac{5}{4}` to retain scale along the equator. -+---------------------+--------------------------------------------------------------------------------+ -| **Classification** | Neither conformal nor equal area cylindrical | -+---------------------+--------------------------------------------------------------------------------+ -| **Available forms** | Forward and inverse spherical | -+---------------------+--------------------------------------------------------------------------------+ -| **Defined area** | Global, but best used near the equator | -+---------------------+--------------------------------------------------------------------------------+ -| **Implemented by** | Gerald I. Evenden | -+---------------------+--------------------------------------------------------------------------------+ -| **Options** | -+---------------------+--------------------------------------------------------------------------------+ -| `+lat_0` | Latitude of origin (Default to 0) | -+---------------------+--------------------------------------------------------------------------------+ ++---------------------+----------------------------------------------------------+ +| **Classification** | Neither conformal nor equal area cylindrical | ++---------------------+----------------------------------------------------------+ +| **Available forms** | Forward and inverse spherical | ++---------------------+----------------------------------------------------------+ +| **Defined area** | Global, but best used near the equator | ++---------------------+----------------------------------------------------------+ +| **Alias** | mill | ++---------------------+----------------------------------------------------------+ +| **Domain** | 2D | ++---------------------+----------------------------------------------------------+ +| **Input type** | Geodetic coordinates | ++---------------------+----------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+----------------------------------------------------------+ + .. image:: ./images/mill.png :scale: 50% @@ -36,6 +39,19 @@ Example using Central meridian 90°W:: $ echo -100 35 | proj +proj=mill +lon_0=90w -1113194.91 4061217.24 +Parameters +################################################################################ + +.. note:: All parameters for the projection are optional. + +.. include:: ../options/lon_0.rst + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + Mathematical definition ####################### diff --git a/docs/source/operations/projections/natearth.rst b/docs/source/operations/projections/natearth.rst index 57dd96db..4d304fab 100644 --- a/docs/source/operations/projections/natearth.rst +++ b/docs/source/operations/projections/natearth.rst @@ -10,12 +10,16 @@ Natural Earth +---------------------+--------------------------------------------------------+ | **Defined area** | Global | +---------------------+--------------------------------------------------------+ -| **Implemented by** | Bernhard Jenny | +| **Alias** | natearth | +---------------------+--------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+--------------------------------------------------------+ -| `No special options for this projection` | +| **Input type** | Geodetic coordinates | +---------------------+--------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+--------------------------------------------------------+ + + .. image:: ./images/natearth.png :scale: 50% @@ -40,6 +44,18 @@ an example of an inverse projection on a sphere with a radius of 7500 m:: $ echo 3500 -8000 | proj -I +proj=natearth +a=7500 37d54'6.091"E 61d23'4.582"S +Parameters +################################################################################ + +.. note:: All parameters for the projection are optional. + +.. include:: ../options/lon_0.rst + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst Further reading ################################################################################ diff --git a/docs/source/operations/projections/nsper.rst b/docs/source/operations/projections/nsper.rst index d204305b..d7611587 100644 --- a/docs/source/operations/projections/nsper.rst +++ b/docs/source/operations/projections/nsper.rst @@ -7,25 +7,42 @@ Near-sided perspective The near-sided perspective projection simulates a view from a height :math:`h` similar to how a satellite in orbit would see it. -+---------------------+-------------------------------------------------------------+ -| **Classification** | Azimuthal. Neither conformal nor equal area. | -+---------------------+-------------------------------------------------------------+ -| **Available forms** | Forward and inverse spherical projection | -+---------------------+-------------------------------------------------------------+ -| **Defined area** | Global, although for one hemisphere at a time. | -+---------------------+-------------------------------------------------------------+ -| **Options** | -+---------------------+-------------------------------------------------------------+ -| `+h` | Height of the view point above the Earth and must be in | -| | the same units as the radius of the sphere. Required. | -+---------------------+-------------------------------------------------------------+ -| `+lat_0` | Latitude (in degrees) of the view position. Defaults to 0. | -+---------------------+-------------------------------------------------------------+ -| `+lon_0` | Longitude (in degrees) of the view position. Defaults to 0. | -+---------------------+-------------------------------------------------------------+ ++---------------------+----------------------------------------------------------+ +| **Classification** | Azimuthal. Neither conformal nor equal area. | ++---------------------+----------------------------------------------------------+ +| **Available forms** | Forward and inverse spherical projection | ++---------------------+----------------------------------------------------------+ +| **Defined area** | Global, although for one hemisphere at a time. | ++---------------------+----------------------------------------------------------+ +| **Alias** | nsper | ++---------------------+----------------------------------------------------------+ +| **Domain** | 2D | ++---------------------+----------------------------------------------------------+ +| **Input type** | Geodetic coordinates | ++---------------------+----------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+----------------------------------------------------------+ .. image:: ./images/nsper.png :scale: 50% :alt: Near-sided perspective +Parameters +################################################################################ + +Required +------------------------------------------------------------------------------- + +.. include:: ../options/h.rst + +Optional +------------------------------------------------------------------------------- + +.. include:: ../options/lon_0.rst + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst diff --git a/docs/source/operations/projections/ortho.rst b/docs/source/operations/projections/ortho.rst index 1a8da63a..5e96e2a2 100644 --- a/docs/source/operations/projections/ortho.rst +++ b/docs/source/operations/projections/ortho.rst @@ -15,14 +15,30 @@ around a given latitude and longitude. | **Defined area** | Global, although only one hemisphere can be seen at a | | | time | +---------------------+--------------------------------------------------------+ -| **Options** | +| **Alias** | ortho | +---------------------+--------------------------------------------------------+ -| `+lon_0` | Longitudinal projection center. Defaults to 0.0. | +| **Domain** | 2D | +---------------------+--------------------------------------------------------+ -| `+lat_0` | Latitudinal projection center. Defaults to 0.0. | +| **Input type** | Geodetic coordinates | ++---------------------+--------------------------------------------------------+ +| **Output type** | Projected coordinates | +---------------------+--------------------------------------------------------+ .. image:: ./images/ortho.png :scale: 50% :alt: Orthographic +Parameters +################################################################################ + +.. note:: All parameters for the projection are optional. + +.. include:: ../options/lon_0.rst + +.. include:: ../options/lat_0.rst + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst diff --git a/docs/source/operations/projections/qsc.rst b/docs/source/operations/projections/qsc.rst index 740901e8..56d4ea3f 100644 --- a/docs/source/operations/projections/qsc.rst +++ b/docs/source/operations/projections/qsc.rst @@ -11,15 +11,16 @@ Quadrilateralized Spherical Cube +---------------------+----------------------------------------------------------+ | **Defined area** | Global | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Martin Lambers | +| **Alias** | qsc | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| `+lat_0` | Latitude (in degrees) of the view position. | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ -| `+lon_0` | Longitude (in degrees) of the view position. | +| **Output type** | Projected coordinates | +---------------------+----------------------------------------------------------+ + The purpose of the Quadrilateralized Spherical Cube (QSC) projection is to project a sphere surface onto the six sides of a cube: @@ -151,6 +152,21 @@ The resulting images can be laid out in a grid like below. | | |bottomside| | | | +------------+--------------+-------------+------------+ +Parameters +################################################################################ + +.. note:: All parameters for the projection are optional. + +.. include:: ../options/lon_0.rst + +.. include:: ../options/lat_0.rst + +.. include:: ../options/ellps.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + Further reading ################################################################################ diff --git a/docs/source/operations/projections/rhealpix.rst b/docs/source/operations/projections/rhealpix.rst index 52a913a5..caca5c7b 100644 --- a/docs/source/operations/projections/rhealpix.rst +++ b/docs/source/operations/projections/rhealpix.rst @@ -4,23 +4,22 @@ rHEALPix ******************************************************************************** +---------------------+----------------------------------------------------------+ -| **Classification** | Mixed | +| **Classification** | Miscellaneous | +---------------------+----------------------------------------------------------+ | **Available forms** | Forward and inverse, spherical and elliptical projection | +---------------------+----------------------------------------------------------+ | **Defined area** | Global | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Alex Raichev and Michael Speth | +| **Alias** | rhealpix | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| `+north_square` | Position of the north polar square. | -| | Valid inputs are 0--3. Defaults to 0. | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ -| `+south_square` | Position of the south polar square. | -| | Valid inputs are 0--3. Defaults to 0. | +| **Output type** | Projected coordinates | +---------------------+----------------------------------------------------------+ + .. image:: ../../../images/rhealpix.png :scale: 75% :alt: rHEALPix @@ -43,6 +42,31 @@ command:: > EOF 55 12 6115727.86 1553840.13 +Parameters +################################################################################ + +.. note:: All parameters for the projection are optional. + +.. option:: +north_square + + Position of the north polar square. Valid inputs are 0--3. + + *Defaults to 0.0.* + +.. option:: +south_square + + Position of the south polar square. Valid inputs are 0--3. + + *Defaults to 0.0.* + + +.. include:: ../options/lon_0.rst + +.. include:: ../options/ellps.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst Further reading ################################################################################ diff --git a/docs/source/operations/projections/tmerc.rst b/docs/source/operations/projections/tmerc.rst index 1fc0cd7e..cd864d13 100644 --- a/docs/source/operations/projections/tmerc.rst +++ b/docs/source/operations/projections/tmerc.rst @@ -6,21 +6,23 @@ Transverse Mercator The transverse Mercator projection in its various forms is the most widely used projected coordinate system for world topographical and offshore mapping. -+---------------------+--------------------------------------------------------------------------------+ -| **Classification** | Transverse and oblique cylindrical | -+---------------------+--------------------------------------------------------------------------------+ -| **Available forms** | Forward and inverse, Spherical and Elliptical | -+---------------------+--------------------------------------------------------------------------------+ -| **Defined area** | Global, but reasonably accurate only within 15 degrees of the central meridian | -+---------------------+--------------------------------------------------------------------------------+ -| **Implemented by** | Gerald I. Evenden | -+---------------------+--------------------------------------------------------------------------------+ -| **Options** | -+---------------------+--------------------------------------------------------------------------------+ -| `+lat_0` | Latitude of origin (Default to 0) | -+---------------------+--------------------------------------------------------------------------------+ -| `+k0` | Scale factor at natural origin (Default to 1) | -+---------------------+--------------------------------------------------------------------------------+ ++---------------------+----------------------------------------------------------+ +| **Classification** | Transverse and oblique cylindrical | ++---------------------+----------------------------------------------------------+ +| **Available forms** | Forward and inverse, Spherical and Elliptical | ++---------------------+----------------------------------------------------------+ +| **Defined area** | Global, but reasonably accurate only within 15 degrees | +| | of the central meridian | ++---------------------+----------------------------------------------------------+ +| **Alias** | tmerc | ++---------------------+----------------------------------------------------------+ +| **Domain** | 2D | ++---------------------+----------------------------------------------------------+ +| **Input type** | Geodetic coordinates | ++---------------------+----------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+----------------------------------------------------------+ + .. image:: ./images/tmerc.png @@ -65,6 +67,25 @@ Example using Gauss Boaga on Italy area (EPSG:3004) :: $ echo 15 42 | proj +proj=tmerc +lat_0=0 +lon_0=15 +k=0.9996 +x_0=2520000 +y_0=0 +ellps=intl +units=m +no_defs 2520000.00 4649858.60 +Parameters +################################################################################ + +.. note:: All parameters for the projection are optional. + +.. include:: ../options/lon_0.rst + +.. include:: ../options/lat_0.rst + +.. include:: ../options/ellps.rst + +.. include:: ../options/R.rst + +.. include:: ../options/k_0.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + Mathematical definition ####################### diff --git a/docs/source/operations/projections/tpers.rst b/docs/source/operations/projections/tpers.rst index 13d49cd7..1d36b07c 100644 --- a/docs/source/operations/projections/tpers.rst +++ b/docs/source/operations/projections/tpers.rst @@ -10,22 +10,17 @@ Tilted perspective +---------------------+----------------------------------------------------------+ | **Defined area** | Global | +---------------------+----------------------------------------------------------+ -| **Implemented by** | Gerald I. Evenden | +| **Alias** | tpers | +---------------------+----------------------------------------------------------+ -| **Options** | +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ -| `+h` | Height (in meters) above the surface. Required. | +| **Input type** | Geodetic coordinates | +---------------------+----------------------------------------------------------+ -| `+azi` | Bearing (in degrees) from due north. | -+---------------------+----------------------------------------------------------+ -| `+tilt` | Angle (in degrees) away from nadir. | -+---------------------+----------------------------------------------------------+ -| `+lat_0` | Latitude (in degrees) of the view position. | -+---------------------+----------------------------------------------------------+ -| `+lon_0` | Longitude (in degrees) of the view position. | +| **Output type** | Projected coordinates | +---------------------+----------------------------------------------------------+ + .. image:: ./images/tpers.png :scale: 50% :alt: Tilted perspective @@ -34,6 +29,40 @@ Tilted perspective Tilted Perspective is similar to :ref:`nsper` (``nsper``) in that it simulates a perspective view from a height. Where ``nsper`` projects onto a plane tangent to the surface, Tilted Perspective orients the plane towards the direction of the -view. Thus, extra parameters azi and tilt are required beyond `nsper``'s ``h``. -As with ``nsper``, ``lat_0`` & ``lon_0`` are also required -for satellite position. +view. Thus, extra parameters specifying azimuth and tilt are required beyond +`nsper``'s ``h``. As with ``nsper``, ``lat_0`` & ``lon_0`` are +also required for satellite position. + +Parameters +################################################################################ + +Required +------------------------------------------------------------------------------- + +.. include:: ../options/h.rst + +Optional +------------------------------------------------------------------------------- + +.. option:: +azi=<value> + + Bearing in degrees away from north. + + *Defaults to 0.0.* + +.. option:: +tilt=<value> + + Angle in degrees away from nadir. + + *Defaults to 0.0.* + +.. include:: ../options/lon_0.rst + +.. include:: ../options/lat_0.rst + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + diff --git a/docs/source/operations/projections/webmerc.rst b/docs/source/operations/projections/webmerc.rst index 0c465afc..92da2d45 100644 --- a/docs/source/operations/projections/webmerc.rst +++ b/docs/source/operations/projections/webmerc.rst @@ -4,6 +4,8 @@ Web Mercator / Pseudo Mercator ******************************************************************************** +.. versionadded:: 5.1.0 + The Web Mercator / Pseudo Mercator projection is a cylindrical map projection. This is a variant of the regular :ref:`merc` projection, except that the computation is done on a sphere, using the semi-major axis of the ellipsoid. @@ -22,14 +24,19 @@ From `Wikipedia <https://en.wikipedia.org/wiki/Web_Mercator>`_: +---------------------+----------------------------------------------------------+ | **Classification** | Cylindrical (non conformant if used with ellipsoid) | +---------------------+----------------------------------------------------------+ -| **Version** | Added in proj 5.1.0 | -+---------------------+----------------------------------------------------------+ | **Available forms** | Forward and inverse, spherical projection | +---------------------+----------------------------------------------------------+ | **Defined area** | Global, but best used near the equator | +---------------------+----------------------------------------------------------+ -| **Options** | Neither lat_0, lon_0, lat_ts or k_0 should be used. | +| **Alias** | webmerc | ++---------------------+----------------------------------------------------------+ +| **Domain** | 2D | +---------------------+----------------------------------------------------------+ +| **Input type** | Geodetic coordinates | ++---------------------+----------------------------------------------------------+ +| **Output type** | Projected coordinates | ++---------------------+----------------------------------------------------------+ + Usage ######## @@ -39,6 +46,17 @@ Example:: $ echo 2 49 | proj +proj=webmerc +datum=WGS84 222638.98 6274861.39 +Parameters +################################################################################ + +.. note:: All parameters for the projection are optional. + +.. include:: ../options/R.rst + +.. include:: ../options/x_0.rst + +.. include:: ../options/y_0.rst + Mathematical definition ####################### diff --git a/docs/source/operations/transformations/deformation.rst b/docs/source/operations/transformations/deformation.rst index f10562dd..f3cb9307 100644 --- a/docs/source/operations/transformations/deformation.rst +++ b/docs/source/operations/transformations/deformation.rst @@ -4,6 +4,8 @@ Kinematic datum shifting utilizing a deformation model ================================================================================ +.. versionadded:: 5.0.0 + Perform datum shifts means of a deformation/velocity model. +-----------------+--------------------------------------------------------------------+ @@ -11,19 +13,14 @@ Perform datum shifts means of a deformation/velocity model. +-----------------+--------------------------------------------------------------------+ | **Output type** | Cartesian coordinates (spatial), decimalyears (temporal). | +-----------------+--------------------------------------------------------------------+ -| **Options** | -+-----------------+--------------------------------------------------------------------+ -| `xy_grids` | Comma-separated list of grids to load. *Required*. | -+-----------------+--------------------------------------------------------------------+ -| `z_grids` | Comma-separated list of grids to load. *Required*. | ++ **Domain** | 4D | +-----------------+--------------------------------------------------------------------+ -| `t_epoch` | Central epoch of transformation. [decimalyear]. *Required*. | +| **Input type** | Geodetic coordinates | +-----------------+--------------------------------------------------------------------+ -| `t_obs` | Observation time of coordinate(s). [decimalyear]. *Optional*. | -| | If not specified, will be get from the t component of 4D input | -| | points. | +| **Output type** | Geodetic coordinates | +-----------------+--------------------------------------------------------------------+ + The deformation operation is used to adjust coordinates for intraplate deformations. Usually the transformation parameters for regional plate-fixed reference frames such as the ETRS89 does not take intraplate deformation into account. It is assumed that @@ -49,6 +46,7 @@ official ETRS89 transformations so in order to get accurate transformations in t countries it is necessary to apply the deformation model. The transformation from ITRF2008 to the Danish realisation of ETRS89 is in PROJ described as:: + proj = pipeline ellps = GRS80 # ITRF2008@t_obs -> ITRF2000@t_obs step init = ITRF2008:ITRF2000 @@ -81,8 +79,46 @@ model. The first use of the deformation operation is:: Here we set the central epoch of the transformation, 2000.0. The observation epoch is expected as part of the input coordinate tuple. The deformation model is -described by two grids, specified with *xy_grids* and *z_grids*. The first is -the horizontal part of the model and the second is the vertical component. +described by two grids, specified with :option:`+xy_grids` and :option:`+z_grids`. +The first is the horizontal part of the model and the second is the vertical +component. + +Parameters +------------------------------------------------------------------------------- + +Required +################################################################################ + + +.. option:: +xy_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 for the horizontla component of a deformation model is expected to be + in CTable2 format. + +.. option:: +z_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 for the vertical component of a deformation model is expected to be + in either GTX format. + +.. option:: +t_epoch=<value> + + Central epoch of transformation given in decimalyears. + +Optional +################################################################################ + +.. option:: +t_obs=<value> + + Observation time of coordinate(s) given in decimalyears. If not specified, + the observation time from the temporal component of 4D input points is used. Mathematical description ------------------------------------------------------------------------------- @@ -122,7 +158,7 @@ Coordinates of the gridded model are in ENU (east, north, up) space because it w otherwise require an enormous 3 dimensional grid to handle the corrections in cartesian space. Keeping the correction in lat/long space reduces the complexity of the grid significantly. Consequently though, the input coordinates needs to be converted to -lat/long space when searching for corrections in the grid. This is done with *cart* +lat/long space when searching for corrections in the grid. This is done with the *cart* operation. The converted grid corrections can then be applied to the input coordinates in cartesian space. The conversion from ENU space to cartesian space is done in the following way: diff --git a/docs/source/operations/transformations/helmert.rst b/docs/source/operations/transformations/helmert.rst index 941fc676..a3e43c13 100644 --- a/docs/source/operations/transformations/helmert.rst +++ b/docs/source/operations/transformations/helmert.rst @@ -4,59 +4,26 @@ Helmert transform ================================================================================ +.. versionadded:: 5.0.0 + The Helmert transformation changes coordinates from one reference frame to anoether by means of 3-, 4-and 7-parameter shifts, or one of their 6-, 8- and 14-parameter kinematic counterparts. + ++-----------------+-------------------------------------------------------------------+ +| **Alias** | helmert | ++-----------------+-------------------------------------------------------------------+ ++ **Domain** | 2D, 3D and 4D | +-----------------+-------------------------------------------------------------------+ | **Input type** | Cartesian coordinates (spatial), decimalyears (temporal). | +-----------------+-------------------------------------------------------------------+ | **Output type** | Cartesian coordinates (spatial), decimalyears (temporal). | +-----------------+-------------------------------------------------------------------+ -| **Options** | -+----------------+--------------------------------------------------------------------+ -| `x` | Translation of the x-axis [m]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `y` | Translation of the y-axis [m]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `z` | Translation of the z-axis. [m]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `s` | Scale factor [ppm]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `rx` | X-axis rotation in the 3D Helmert [arc seconds]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `ry` | Y-axis rotation in the 3D Helmert [arc seconds]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `rz` | Z-axis rotation in the 3D Helmert [arc seconds]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `theta` | Rotation angle in the 2D Helmert. [arc seconds]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `dx` | Translation rate of the x-axis. [m/year]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `dy` | Translation rate of the y-axis. [m/year]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `dz` | Translation rate of the z-axis. [m/year]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `ds` | Scale rate factor [ppm/year]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `drx` | Rotation rate of the x-axis [arc seconds/year]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `dry` | Rotation rate of the y-axis [arc seconds/year]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `drz` | Rotation rate of the y-axis [arc seconds/year]. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `t_epoch` | Central epoch of transformation. [decimalyear]. Only used in | -| | spatiotemporal transformations. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `t_obs` | Observation time of coordinate(s). Mostly useful in 2D and 3D | -| | transformations. [decimalyear]. *Optional*. | -| | If not specified, will be get from the t component of 4D input | -| | points. | -+----------------+--------------------------------------------------------------------+ -| `exact` | Use exact transformation equations. *Optional*. | -+----------------+--------------------------------------------------------------------+ -| `transpose` | Transpose rotation matrix. *Optional*. | -+----------------+--------------------------------------------------------------------+ +| **Input type** | Cartesian coordinates | ++-----------------+-------------------------------------------------------------------+ +| **Output type** | Cartesian coordinates | ++-----------------+-------------------------------------------------------------------+ The Helmert transform, in all it's various incarnations, is used to perform reference frame shifts. The transformation operates in cartesian space. It can be used to transform @@ -107,6 +74,102 @@ Transformation from `ITRF2000@2017.0` to `ITRF93@2017.0` using 15 parameters: drx=-0.00011 dry=-0.00019 drz=0.00007 epoch=1988.0 tobs=2017.0 transpose +Parameters ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. note:: + + All parameters are optional but at least one should be used, otherwise the + operation will return the coordinates unchanged. + +.. option:: +x=<value> + + Translation of the x-axis given in meters. + +.. option:: +y=<value> + + Translation of the x-axis given in meters. + +.. option:: +z=<value> + + Translation of the z-axis given in meters. + +.. option:: +s=<value> + + Scale factor given in ppm. + +.. option:: +rx=<value> + + X-axis rotation in the 3D Helmert given arc seconds. + + +.. option:: +ry=<value> + + Y-axis rotation in the 3D Helmert given in arc seconds. + +.. option:: +rz=<value> + + Z-axis rotation in the 3D Helmert given in arc seconds. + + +.. option:: +theta=<value> + + Rotation angle in the 2D Helmert given in arc seconds. + +.. option:: +dx=<value> + + Translation rate of the x-axis given in m/year. + +.. option:: +dy=<value> + + Translation rate of the y-axis given in m/year. + +.. option:: +dz=<value> + + Translation rate of the z-axis given in m/year. + +.. option:: +ds=<value> + + Scale rate factor given in ppm/year. + +.. option:: +drx=<value> + + Rotation rate of the x-axis given in arc seconds/year. + +.. option:: +dry=<value> + + Rotation rate of the y-axis given in arc seconds/year. + +.. option:: +drz=<value> + + Rotation rate of the y-axis given in arc seconds/year. + +.. option:: +t_epoch=<value> + + Central epoch of transformation given in decimalyear. Only used + spatiotemporal transformations. + +.. option:: +t_obs=<value> + + Observation time of coordinate(s) given in decicalyear. Mostly useful + in 2D and 3D transformations where the observation time is not passed + as part of the input coordinate. Can be used to override the observation + time from the input coordinate. + +.. option:: +exact + + Use exact transformation equations. + + See :eq:`rot_exact` + +.. option:: +transpose + + Transpose rotation matrix and follow the **Cordinate Frame** rotation + convention. If :option:`+transpose` is not added the **Position Vector** + rotation convention is used. + + + Mathematical description +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ @@ -244,6 +307,7 @@ The three rotation matrices can be combined in one: \mathbf{R} = \mathbf{R_X} \mathbf{R_Y} \mathbf{R_Y} \end{align} + For :math:`\mathbf{R}`, this yields: .. math:: @@ -302,9 +366,10 @@ using the approximated rotation matrix: If the rotation matrix is transposed the transformation is effectively reversed. This is cause for some confusion since there is no correct way of defining the -rotation matrix. Two conventions exists and they seem to be equally popular. -In PROJ the rotation matrix can be transposed by adding the `transpose` flag in -the transformation setup. +rotation matrix. Two conventions exists and they seem to be equally popular. PROJ +uses the **Position Vector** rotation convention. The rotation matrix can be transposed by +adding the :option:`+transpose` flag in the transformation setup which makes PROJ +follow the **Coordinate Frame** rotation convention. Applying :eq:`propagation` we get the kinematic version of the approximated 3D Helmert: diff --git a/docs/source/operations/transformations/hgridshift.rst b/docs/source/operations/transformations/hgridshift.rst index 63fa5122..35c84919 100644 --- a/docs/source/operations/transformations/hgridshift.rst +++ b/docs/source/operations/transformations/hgridshift.rst @@ -4,17 +4,18 @@ Horizontal grid shift ================================================================================ +.. versionadded:: 5.0.0 + Change of horizontal datum by grid shift. + ++-----------------+--------------------------------------------------------------------+ +| **Domain** | 2D | +-----------------+--------------------------------------------------------------------+ | **Input type** | Geodetic coordinates. | +-----------------+--------------------------------------------------------------------+ | **Output type** | Geodetic coordinates. | +-----------------+--------------------------------------------------------------------+ -| **Options** | -+-----------------+--------------------------------------------------------------------+ -| `+grids` | Comma-separated list of grids to load. | -+-----------------+--------------------------------------------------------------------+ The horizontal grid shift is done by offsetting the planar input coordinates by a specific amount determined by the loaded grids. The simplest use case of the @@ -37,3 +38,15 @@ list. PROJ supports CTable2, NTv1 and NTv2 files for horizontal grid corrections. Details about all three formats can be found in the GDAL documentation. GDAL reads and writes all three formats. 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 CTable2, NTv1 or NTv2 format. diff --git a/docs/source/operations/transformations/molodensky.rst b/docs/source/operations/transformations/molodensky.rst index d4ff3e79..a90828cd 100644 --- a/docs/source/operations/transformations/molodensky.rst +++ b/docs/source/operations/transformations/molodensky.rst @@ -4,6 +4,8 @@ Molodensky transform ================================================================================ +.. versionadded:: 5.0.0 + The Molodensky transformation resembles a :ref:`Helmert` with zero rotations and a scale of unity, but converts directly from geodetic coordinates to geodetic coordinates, without the intermediate shifts to and from cartesian @@ -17,28 +19,13 @@ reasons, but nevertheless indispensable due to the large amount of data that has already been transformed that way [EversKnudsen2017]_. +---------------------+----------------------------------------------------------+ -| **Input type** | Geodetic coordinates. | -+---------------------+----------------------------------------------------------+ -| **Output type** | Geodetic coordinates. | -+---------------------+----------------------------------------------------------+ -| **Options** | -+---------------------+----------------------------------------------------------+ -| `+da` | Difference in semimajor axis of the defining ellipsoids. | -+---------------------+----------------------------------------------------------+ -| `+df` | Difference in flattening of the defining ellipsoids. | -+---------------------+----------------------------------------------------------+ -| `+dx` | Offset of the X-axes of the defining ellipsoids. | +| **Alias** | molodensky | +---------------------+----------------------------------------------------------+ -| `+dy` | Offset of the Y-axes of the defining ellipsoids. | +| **Domain** | 3D | +---------------------+----------------------------------------------------------+ -| `+dz` | Offset of the Z-axes of the defining ellipsoids. | +| **Input type** | Geodetic coordinates (horizontal), meters (vertical) | +---------------------+----------------------------------------------------------+ -| `+ellps` | Ellipsoid definition of source coordinates. | -| | Any specification can be used (e.g. `+a`, `+rf`, etc). | -| | If not specified, default ellipsoid is used. | -+---------------------+----------------------------------------------------------+ -| `+abridged` | Use the abridged version of the Molodensky transform. | -| | Optional. | +| **output type** | Geodetic coordinates (horizontal), meters (vertical) | +---------------------+----------------------------------------------------------+ The Molodensky transform can be used to perform a datum shift from coordinate @@ -72,3 +59,38 @@ The same transformation using the standard Molodensky:: proj=molodensky a=6378160 rf=298.25 da=-23 df=-8.120449e-8 dx=-134 dy=-48 dz=149 + +Parameters +################################################################################ + +Required +------------------------------------------------------------------------------- + +.. option:: +da=<value> + + Difference in semimajor axis of the defining ellipsoids. + +.. option:: +df=<value> + + Difference in flattening of the defining ellipsoids. + +.. option:: +dx=<value> + + Offset of the X-axes of the defining ellipsoids. + +.. option:: +dy=<value> + + Offset of the Y-axes of the defining ellipsoids. + +.. option:: +dz=<value> + + Offset of the Z-axes of the defining ellipsoids. + +.. include:: ../options/ellps.rst + +Optional +------------------------------------------------------------------------------- + +.. option:: +abridged + + Use the abridged version of the Molodensky transform. 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. |