aboutsummaryrefslogtreecommitdiff
path: root/docs/source/apps/proj.rst
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2018-03-17 21:07:24 +0100
committerKristian Evers <kristianevers@gmail.com>2018-03-17 21:07:24 +0100
commit97d491d8e2d56ce49aca57c6cf6aa3e5d4306598 (patch)
treeff9fdd2946e2a978434d79f7b05dac64e759d115 /docs/source/apps/proj.rst
parent5324937759b602a9eba8314daa1ac40f2ffcaa8e (diff)
downloadPROJ-97d491d8e2d56ce49aca57c6cf6aa3e5d4306598.tar.gz
PROJ-97d491d8e2d56ce49aca57c6cf6aa3e5d4306598.zip
Move application docs to top level.
The 'Applications' chapter is moved to the top level of the website in order to make it easier for users to find the pages quickly instead of having to search through sub-sections in other chapters.
Diffstat (limited to 'docs/source/apps/proj.rst')
-rw-r--r--docs/source/apps/proj.rst236
1 files changed, 236 insertions, 0 deletions
diff --git a/docs/source/apps/proj.rst b/docs/source/apps/proj.rst
new file mode 100644
index 00000000..dee4ea89
--- /dev/null
+++ b/docs/source/apps/proj.rst
@@ -0,0 +1,236 @@
+.. _proj:
+
+================================================================================
+proj
+================================================================================
+
+.. only:: html
+
+ Cartographic projection filter.
+
+.. Index:: proj
+
+Synopsis
+********
+ **proj** [ **-bceEfiIlmorsStTvVwW** ] [ args ] ] [ *+args* ] file[s]
+
+ **invproj** [ **-bceEfiIlmorsStTwW** ] [ args ] ] [ *+args* ] file[s]
+
+
+Description
+***********
+:program:`proj` and :program:`invproj` perform respective forward and inverse
+transformation of cartographic data to or from cartesian data with a wide
+range of selectable projection functions.
+
+:program:`invproj` may not be available on all platforms; in this case
+use :option:`proj -I` instead.
+
+The following control parameters can appear in any order
+
+.. program:: proj
+
+.. option:: -b
+
+ Special option for binary coordinate data input and output through standard
+ input and standard output. Data is assumed to be in system type double
+ floating point words. This option is to be used when proj is a son process
+ and allows bypassing formatting operations.
+
+.. option:: -i
+
+ Selects binary input only (see :option:`-b`).
+
+.. option:: -I
+
+ alternate method to specify inverse projection. Redundant when used with
+ invproj.
+
+.. option:: -o
+
+ Selects binary output only (see :option:`-b`).
+
+.. option:: -t<a>
+
+ *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:: -e <string>
+
+ String is an arbitrary string to be output if an error is detected during
+ data transformations. The default value is: *\t*. Note that if the
+ :option:`-b`, :option:`-i` or :option:`-o` options are employed, an error
+ is returned as HUGE_VAL value for both return values.
+
+.. 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*. ``proj -l=id``
+ gives expanded description of projection id, e.g. ``proj -l=merc``.
+
+.. option:: -lp
+
+ List of all projection id that can be used with the *+proj* parameter.
+ Equivalent to ``proj -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:: -ld
+
+ List of datums that can be selected with the *+datum* 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:: -S
+
+ Causes estimation of meridional and parallel scale factors, area scale
+ factor and angular distortion, and maximum and minimum scale factors to be
+ listed between <> for each input point. For conformal projections meridional
+ and parallel scales factors will be equal and angular distortion zero. Equal
+ area projections will have an area factor of 1.
+
+.. option:: -m <mult>
+
+ The cartesian data may be scaled by the mult parameter. When processing data
+ in a forward projection mode the cartesian output values are multiplied by
+ mult otherwise the input cartesian values are divided by mult before inverse
+ projection. If the first two characters of mult are 1/ or 1: then the
+ reciprocal value of mult is employed.
+
+.. option:: -f <format>
+
+ 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. The default format is "%.2f" for forward projection and DMS for
+ inverse.
+
+.. option:: -[w|W]<n>
+
+ N is the number of significant fractional digits to employ for seconds
+ output (when the option is not specified, ``-w3`` is assumed). When ``-W``
+ is employed the fields will be constant width and 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. Should not be used with the
+ :option:`-T` option.
+
+.. option:: -V
+
+ This option causes an expanded annotated listing of the characteristics of
+ the projected point. :option:`-v` is implied with this option.
+
+.. option:: -T <ulow,uhi,vlow,vhi,res[,umax,vmax]>
+
+ This option creates a set of bivariate Chebyshev polynomial coefficients
+ that approximate the selected cartographic projection on stdout. The values
+ low and hi denote the range of the input where the u or v prefixes apply to
+ respective longitude-x or latitude-y depending upon whether a forward or
+ inverse projection is selected. Res is an integer number specifying the
+ power of 10 precision of the approximation. For example, a res of -3
+ specifies an approximation with an accuracy better than .001. Umax, and vmax
+ specify maximum degree of the polynomials (default: 15).
+
+
+
+The *+args* run-line arguments are associated with cartographic parameters.
+Additional projection control parameters may be contained in two auxiliary
+control files: the first is optionally referenced with the
+*+init=file:id* and the second is always processed after the name of the
+projection has been established from either the run-line or the contents of
++init file. The environment parameter :envvar:`PROJ_LIB` establishes the
+default directory for a file reference without an absolute path. This is
+also used for supporting files like datum shift files.
+
+.. only:: html
+
+ Usage of *+args* varies with projection and for a complete description
+ consult the :ref:`projection pages <projections>`.
+
+
+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 ASCII 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 format and input
+cartesian data must be in units consistent with the ellipsoid major axis or
+sphere radius units. Output geographic coordinates will be in DMS (if the
+``-w`` switch is not employed) and precise to 0.001" with trailing, zero-valued
+minute-second fields deleted.
+
+Example
+*******
+The following script
+
+.. code-block:: console
+
+ proj +proj=utm +lon_0=112w +ellps=clrk66
+ -r <<EOF
+ 45d15'33.1" 111.5W
+ 45d15.551666667N -111d30
+ +45.25919444444 111d30'000w
+ EOF
+
+will perform UTM forward projection with a standard UTM central meridian
+nearest longitude 112W. 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::
+
+ 460769.27 5011648.45
+
+.. only:: man
+
+ Other programs
+ **************
+
+ The :program:`proj` program is limited to converting between geographic and
+ projected coordinates within one datum.
+
+ The :program:`cs2cs` program operates similarly, but allows translation
+ between any paor of definable coordinate reference systems, including
+ support for datum translation.
+
+ See also
+ ********
+
+ **cs2cs(1)**, **cct(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/