From 970d708ff9d796f7d9ec00b22023e835fbdc7f2d Mon Sep 17 00:00:00 2001 From: Kristian Evers Date: Mon, 30 Apr 2018 22:42:59 +0200 Subject: Refactor operation doc pages Extended the use of the :option: directive to all currently written operation doc pages. In the process several more default parameters were added for easy inclusion in other doc pages. Expanded the info tables for each operation with "domain", "alias", "input type" and "output type". Corrected various errors along the way. Mainly formatting errors and references to invalid parameters such as +sym in hatano. --- docs/source/operations/conversions/unitconvert.rst | 67 ++++++++++++++++------ 1 file changed, 49 insertions(+), 18 deletions(-) (limited to 'docs/source/operations/conversions/unitconvert.rst') 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= + + Horizontal input units. See :ref:`distance_units` for a list of available + units. + +.. option:: +xy_out= + + Horizontal output units. See :ref:`distance_units` for a list of available + units. + +.. option:: +z_in= + + Vertical output units. See :ref:`distance_units` for a list of available + units. + +.. option:: +z_out= + + Vertical output units. See :ref:`distance_units` for a list of available + units. + +.. option:: +t_in= + + Temporal input units. See :ref:`time_units` for a list of available units. + +.. option:: +t_out= + + 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,12 +124,15 @@ by adding the `-lu` flag when calling the utility. | ind-ch | Indian Chain | +----------+---------------------------------+ +.. _time_units: Time units ############################################################################### In the table below all time units supported by PROJ is listed. ++--------------+-----------------------------+ +| **label** | **Name** | +--------------+-----------------------------+ | mjd | Modified Julian date | +--------------+-----------------------------+ -- cgit v1.2.3