aboutsummaryrefslogtreecommitdiff
path: root/docs/source/apps/cs2cs.rst
blob: 1003940de7e88c1f72031d230f506e25a4aa38fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
.. _cs2cs:

================================================================================
cs2cs
================================================================================

.. only:: html

    Filter for transformations between two coordinate reference systems.

Synopsis
********

    **cs2cs** [**-eEfIlrstvwW** [args]] [*+opt[=arg]* ...] [+to *+opt[=arg]* ...] file ...

or

    **cs2cs** [**-eEfIlrstvwW** [args]] {source_crs} +to {target_crs} file ...

    where {source_crs} or {target_crs} is a PROJ string, a WKT string or a AUTHORITY:CODE
    (where AUTHORITY is the name of a CRS authority and CODE the code of a CRS
    found in the proj.db database), expressing a coordinate reference system.

.. versionadded:: 6.0.0

or

    **cs2cs** [**-eEfIlrstvwW** [args]] {source_crs} {target_crs}

.. versionadded:: 6.0.0

Description
***********

:program:`cs2cs` performs transformation between the source and destination
cartographic coordinate reference system on a set of input points. The coordinate
reference system transformation can include translation between projected and
geographic coordinates as well as the application of datum shifts.

The following control parameters can appear in any order:

.. program:: cs2cs

.. option:: -I

    Method to specify inverse translation, convert from *+to* coordinate system to
    the primary coordinate system defined.

.. option:: -t<a>

    Where *a* specifies a character employed as the first character to denote a control
    line to be passed through without processing. This option applicable to
    ASCII input only. (# is the default value).

.. option:: -d <n>

.. versionadded:: 5.2.0

    Specify the number of decimals in the output.

.. option:: -e <string>

    Where *string* is an arbitrary string to be output if an error is detected during
    data transformations. The default value is a three character string: ``*\t*``.

.. option:: -E

    Causes the input coordinates to be copied to the output line prior to
    printing the converted values.

.. option:: -l<[=id]>

    List projection identifiers that can be selected with *+proj*. ``cs2cs -l=id``
    gives expanded description of projection *id*, e.g. ``cs2cs -l=merc``.

.. option:: -lp

    List of all projection id that can be used with the *+proj* parameter.
    Equivalent to ``cs2cs -l``.

.. option:: -lP

    Expanded description of all projections that can be used with the *+proj*
    parameter.

.. option:: -le

    List of all ellipsoids that can be selected with the *+ellps* parameters.

.. option:: -lu

    List of all distance units that can be selected with the *+units* parameter.

.. option:: -r

    This options reverses the order of the expected input from
    longitude-latitude or x-y to latitude-longitude or y-x.

.. option:: -s

    This options reverses the order of the output from x-y or longitude-latitude
    to y-x or latitude-longitude.

.. option:: -f <format>

    Where *format* is a printf format string to control the form of the output values.
    For inverse projections, the output will be in degrees when this option is
    employed. If a format is specified for inverse projection the output data
    will be in decimal degrees. The default format is ``"%.2f"`` for forward
    projection and DMS for inverse.

.. option:: -w<n>

    Where *n* is the number of significant fractional digits to employ for seconds
    output (when the option is not specified, ``-w3`` is assumed).

.. option:: -W<n>

    Where *n* is the number of significant fractional digits to employ for seconds
    output. When ``-W`` is employed the fields will be constant width
    with leading zeroes.

.. option:: -v

    Causes a listing of cartographic control parameters tested for and used by
    the program to be printed prior to input data.


.. only:: man

    The *+opt* run-line arguments are associated with cartographic
    parameters.

.. only:: html

    The *+opt* run-line arguments are associated with cartographic
    parameters. Usage varies with projection and for a complete description
    consult the :ref:`projection pages <projections>`.

The :program:`cs2cs` program requires two coordinate reference system (CRS) definitions. The first (or
primary is defined based on all projection parameters not appearing after the
*+to* argument. All projection parameters appearing after the *+to* argument
are considered the definition of the second CRS. If there is no
second CRS defined, a geographic CRS based on the
datum and ellipsoid of the source CRS is assumed. Note that the
source and destination CRS can both of same or different nature (geographic,
projected, compound CRS), or one of each and may have the same or different datums.

When using a WKT definition or a AUTHORITY:CODE, the axis order of the CRS will
be enforced. So for example if using EPSG:4326, the first value expected (or
returned) will be a latitude.

Internally, :program:`cs2cs` uses the :c:func:`proj_create_crs_to_crs` function
to compute the appropriate coordinate operation, so implementation details of
this function directly impact the results returned by the program.

The environment parameter :envvar:`PROJ_LIB` establishes the
directory for resource files (database, datum shift grids, etc.)

One or more files (processed in left to right order) specify the source of
data to be transformed. A ``-`` will specify the location of processing standard
input. If no files are specified, the input is assumed to be from stdin.
For input data the two data values must be in the first two white space
separated fields and when both input and output are ASCII all trailing portions
of the input line are appended to the output line.

Input geographic data (longitude and latitude) must be in DMS or decimal
degrees format and input cartesian data must be in units consistent with the
ellipsoid major axis or sphere radius units. Output geographic coordinates will
normally be in DMS format (use ``-f %.12f`` for decimal degrees with 12 decimal
places), while projected (cartesian) coordinates will be in linear
(meter, feet) units.

Use of remote grids
-------------------

.. versionadded:: 7.0.0

If the :envvar:`PROJ_NETWORK` environment variable is set to ``ON``,
:program:`cs2cs` will attempt to use remote grids stored on CDN (Content
Delivery Network) storage, when they are not available locally.

Examples
********

Using PROJ strings
------------------

The following script

::

    cs2cs +proj=latlong +datum=NAD83 +to +proj=utm +zone=10 +datum=NAD27 -r <<EOF
    45d15'33.1" 111.5W
    45d15.551666667N -111d30
    +45.25919444444 111d30'000w
    EOF

will transform the input NAD83 geographic coordinates into NAD27 coordinates in
the UTM projection with zone 10 selected. The geographic values of this
example are equivalent and meant as examples of various forms of DMS input.
The x-y output data will appear as three lines of:

::

    1402293.44  5076292.68 0.00


Using EPSG codes
----------------

Transforming from WGS 84 latitude/longitude (in that order) to UTM Zone 31N/WGS 84

::

    cs2cs EPSG:4326 EPSG:32631 <<EOF
    45N 2E
    EOF

outputs

::

    421184.70   4983436.77 0.00

.. only:: man

    See also
    ********

    **proj(1)**, **cct(1)**, **geod(1)**, **gie(1)**, **projinfo(1)**

    Bugs
    ****

    A list of know bugs can be found at https://github.com/OSGeo/PROJ/issues
    where new bug reports can be submitted to.

    Home page
    *********

    https://proj.org/