diff options
Diffstat (limited to 'docs/source/operations/conversions')
| -rw-r--r-- | docs/source/operations/conversions/axisswap.rst | 31 | ||||
| -rw-r--r-- | docs/source/operations/conversions/cart.rst | 29 | ||||
| -rw-r--r-- | docs/source/operations/conversions/latlon.rst | 33 | ||||
| -rw-r--r-- | docs/source/operations/conversions/unitconvert.rst | 67 |
4 files changed, 121 insertions, 39 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 | |