aboutsummaryrefslogtreecommitdiff
path: root/docs/source/usage/apps/cct.rst
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2018-03-17 20:50:15 +0100
committerKristian Evers <kristianevers@gmail.com>2018-03-17 20:50:15 +0100
commit5324937759b602a9eba8314daa1ac40f2ffcaa8e (patch)
tree1fe591bc0abe3d7e50337626674a231ff9d1aed0 /docs/source/usage/apps/cct.rst
parentdb3e0ae30446498cec7e7f931d9be2ed65547691 (diff)
downloadPROJ-5324937759b602a9eba8314daa1ac40f2ffcaa8e.tar.gz
PROJ-5324937759b602a9eba8314daa1ac40f2ffcaa8e.zip
Reformat doc pages for cct, cs2cs, geod and proj
The doc pages are reformatted to better use the features of the Sphinx documentation system. All four pages has been formatted such that they can serve as the basis for both the website and UNIX man-pages. This will make it easier to keep the man-pages aligned with the main documentation in the future.
Diffstat (limited to 'docs/source/usage/apps/cct.rst')
-rw-r--r--docs/source/usage/apps/cct.rst163
1 files changed, 95 insertions, 68 deletions
diff --git a/docs/source/usage/apps/cct.rst b/docs/source/usage/apps/cct.rst
index 014e7732..9153e29b 100644
--- a/docs/source/usage/apps/cct.rst
+++ b/docs/source/usage/apps/cct.rst
@@ -4,135 +4,162 @@
cct
================================================================================
-
.. Index:: cct
+.. only:: html
+ Coordinate Conversion and Transformation.
+Synopsis
+********
-``cct`` a 4D equivalent to the ``proj`` projection
-program, performs transformation coordinate systems on a set of input points.
-The coordinate system transformation can include translation between
-projected and geographic coordinates as well as the application of datum shifts.
+ **cct** [ **-cotvz** [ args ] ] *+opts[=arg]* file[s]
-cct is an acronym meaning *Coordinate Conversion and Transformation*.
+Description
+***********
-The acronym refers to definitions given in the OGC 08-015r2/ISO-19111
-standard "Geographical Information -- Spatial Referencing by Coordinates",
-which defines two different classes of *coordinate operations*:
+:program:`cct` a 4D equivalent to the :program:`proj` projection program,
+performs transformation coordinate systems on a set of input points. The
+coordinate system transformation can include translation between projected
+and geographic coordinates as well as the application of datum shifts.
-*Coordinate Conversions*, which are coordinate operations where input
-and output datum are identical (e.g. conversion from geographical to
-cartesian coordinates) and
-*Coordinate Transformations*, which are coordinate operations where
-input and output datums differ (e.g. change of reference frame).
+The following control parameters can appear in any order:
-``cct``, however, also refers to Carl Christian Tscherning (1942--2014),
-professor of Geodesy at the University of Copenhagen, mentor and advisor
-for a generation of Danish geodesists, colleague and collaborator for
-two generations of global geodesists, Secretary General for the
-International Association of Geodesy, IAG (1995--2007), fellow of the
-American Geophysical Union (1991), recipient of the IAG Levallois Medal
-(2007), the European Geosciences Union Vening Meinesz Medal (2008), and
-of numerous other honours.
+.. program:: cct
-cct, or Christian, as he was known to most of us, was recognized for his
-good mood, his sharp wit, his tireless work, and his great commitment to
-the development of geodesy -- both through his scientific contributions,
-comprising more than 250 publications, and by his mentoring and teaching
-of the next generations of geodesists.
+.. option:: -c <x,y,z,t>
-As Christian was an avid Fortran programmer, and a keen Unix connoisseur,
-he would have enjoyed to know that his initials would be used to name a
-modest Unix style transformation filter, hinting at the tireless aspect
-of his personality, which was certainly one of the reasons he accomplished
-so much, and meant so much to so many people.
+ Specify input columns for (up to) 4 input parameters. Defaults to 1,2,3,4.
-Hence, in honour of cct (the geodesist) this is cct (the program).
+.. option:: -o <output file name>, --output=<output file name>
+ Specify the name of the output file.
+.. option:: -t <time>, --time=<time>
-Synopsis
-********
+ Specify a fixed observation time to be used for all input data.
-::
+.. option:: -z <height>, --height=<height>
- cct [ -cotvz [ args ] ]... +opts[=arg]... file...
+ Specify a fixed observation height to be used for all input data.
-Description
-***********
-The following control parameters can appear in any order:
+.. option:: -v, --verbose
-::
+ Write non-essential, but potentially useful, information to stderr.
+ Repeat for additional information (``-vv``, ``-vvv``, etc.)
- -c x,y,z,t
- --columns=x,y,z,t
- Specify input columns for (up to) 4 input parameters. Defaults to 1,2,3,4
+The *+args* arguments are associated with coordinate operation parameters.
+Usage varies with operation.
- -o <output file name>
- --output=<output file name>
- Specify the name of the output file.
+.. only:: html
- -t <time>
- --time=<time>
- Specify a fixed observation time to be used for all input data.
+ For a complete description consult the :ref:`projection pages <projections>`.
- -z <height>
- --height=<height>
- Specify a fixed observation height to be used for all input data.
- -v
- --verbose
- Write non-essential, but potentially useful, information to stderr.
- Repeat for additional information (-vv, -vvv, etc.)
+:program:`cct` is an acronym meaning *Coordinate Conversion and Transformation*.
+
+The acronym refers to definitions given in the OGC 08-015r2/ISO-19111
+standard "Geographical Information -- Spatial Referencing by Coordinates",
+which defines two different classes of *coordinate operations*:
-The ``+args`` arguments are associated with coordinate operation parameters. Usage varies with
-operation. For a complete description consult the `projection pages <../projections/index.html>`_
+*Coordinate Conversions*, which are coordinate operations where input
+and output datum are identical (e.g. conversion from geographical to
+cartesian coordinates) and
+*Coordinate Transformations*, which are coordinate operations where
+input and output datums differ (e.g. change of reference frame).
Examples
********
-1. The operator specs describe the action to be performed by cct. So the following script
+1. The operator specs describe the action to be performed by :program:`cct`. So
+ the following script
-::
+.. code-block:: console
echo 12 55 0 0 | cct +proj=utm +zone=32 +ellps=GRS80
will transform the input geographic coordinates into UTM zone 32 coordinates.
Hence, the command
-::
+.. code-block:: console
echo 12 55 | cct -z0 -t0 +proj=utm +zone=32 +ellps=GRS80
Should give results comparable to the classic proj command
-::
+.. code-block:: console
echo 12 55 | proj +proj=utm +zone=32 +ellps=GRS80
2. Convert geographical input to UTM zone 32 on the GRS80 ellipsoid:
-::
+.. code-block:: console
cct +proj=utm +ellps=GRS80 +zone=32
3. Roundtrip accuracy check for the case above:
-::
+.. code-block:: console
cct +proj=pipeline +proj=utm +ellps=GRS80 +zone=32 +step +step +inv
4. As (2) but specify input columns for longitude, latitude, height and time:
-::
+.. code-block:: console
cct -c 5,2,1,4 +proj=utm +ellps=GRS80 +zone=32
-5. As (2) but specify fixed height and time, hence needing only 2 cols in input:
+5. As (2) but specify fixed height and time, hence needing only 2 cols in
+ input:
-::
+.. code-block:: console
cct -t 0 -z 0 +proj=utm +ellps=GRS80 +zone=32
+
+
+Background
+**********
+
+:program:`cct` also refers to Carl Christian Tscherning (1942--2014),
+professor of Geodesy at the University of Copenhagen, mentor and advisor
+for a generation of Danish geodesists, colleague and collaborator for
+two generations of global geodesists, Secretary General for the
+International Association of Geodesy, IAG (1995--2007), fellow of the
+American Geophysical Union (1991), recipient of the IAG Levallois Medal
+(2007), the European Geosciences Union Vening Meinesz Medal (2008), and
+of numerous other honours.
+
+*cct*, or Christian, as he was known to most of us, was recognized for his
+good mood, his sharp wit, his tireless work, and his great commitment to
+the development of geodesy -- both through his scientific contributions,
+comprising more than 250 publications, and by his mentoring and teaching
+of the next generations of geodesists.
+
+As Christian was an avid Fortran programmer, and a keen Unix connoisseur,
+he would have enjoyed to know that his initials would be used to name a
+modest Unix style transformation filter, hinting at the tireless aspect
+of his personality, which was certainly one of the reasons he accomplished
+so much, and meant so much to so many people.
+
+Hence, in honour of *cct* (the geodesist) this is :program:`cct` (the program).
+
+
+.. only:: man
+
+ See also
+ ********
+
+ **proj(1)**, **cs2cs(1)**, **geod(1)**, **gie(1)**
+
+ Bugs
+ ****
+
+ A list of know bugs can be found at http://github.com/OSGeo/proj.4/issues
+ where new bug reports can be submitted to.
+
+ Home page
+ *********
+
+ http://proj4.org/