From e6472d42b33b7cc2155de82dd561365b16f9ef78 Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sat, 5 May 2018 20:57:23 +1200 Subject: normalise whitespace - most content untouched --- docs/source/apps/cct.rst | 12 +++--- docs/source/apps/cs2cs.rst | 82 +++++++++++++++++------------------ docs/source/apps/geod.rst | 104 ++++++++++++++++++++++----------------------- docs/source/apps/gie.rst | 22 +++++----- docs/source/apps/proj.rst | 75 ++++++++++++++++---------------- 5 files changed, 147 insertions(+), 148 deletions(-) (limited to 'docs/source') diff --git a/docs/source/apps/cct.rst b/docs/source/apps/cct.rst index 20aec06c..3c3f6668 100644 --- a/docs/source/apps/cct.rst +++ b/docs/source/apps/cct.rst @@ -13,18 +13,18 @@ cct Synopsis ******** - **cct** [ **-cotvz** [ args ] ] *+opts[=arg]* file[s] + **cct** [ **-cotvz** [ args ] ] *+opts[=arg]* file[s] Description *********** :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 +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. -The following control parameters can appear in any order: +The following control parameters can appear in any order: .. program:: cct @@ -120,14 +120,14 @@ Should give results comparable to the classic proj command .. code-block:: console - cct -c 5,2,1,4 +proj=utm +ellps=GRS80 +zone=32 + 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: .. code-block:: console - cct -t 0 -z 0 +proj=utm +ellps=GRS80 +zone=32 + cct -t 0 -z 0 +proj=utm +ellps=GRS80 +zone=32 Background diff --git a/docs/source/apps/cs2cs.rst b/docs/source/apps/cs2cs.rst index ba77aadf..45d004bf 100644 --- a/docs/source/apps/cs2cs.rst +++ b/docs/source/apps/cs2cs.rst @@ -11,17 +11,17 @@ cs2cs Synopsis ******** - **cs2cs** [ **-eEfIlrstvwW** [ args ] ] [ *+opts[=arg]* ] [ +to [*+opts[=arg]*] ] file[s] + **cs2cs** [ **-eEfIlrstvwW** [ args ] ] [ *+opts[=arg]* ] [ +to [*+opts[=arg]*] ] file[s] Description *********** :program:`cs2cs` performs transformation between the source and destination -cartographic coordinate system on a set of input points. The coordinate -system transformation can include translation between projected and +cartographic coordinate system 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. -The following control parameters can appear in any order: +The following control parameters can appear in any order: .. program:: cs2cs @@ -33,20 +33,20 @@ The following control parameters can appear in any order: .. option:: -t 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). + line to be passed through without processing. This option applicable to + ascii input only. (# is the default value). .. option:: -e - 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 -b, -i + 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 -b, -i or -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. + printing the converted values. .. option:: -l<[=id]> @@ -89,8 +89,8 @@ The following control parameters can appear in any order: 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 deci- mal degrees. The default format is "%.2f" for forward + 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|W] @@ -113,38 +113,38 @@ The following control parameters can appear in any order: .. only:: html The *+args* run-line arguments are associated with cartographic - parameters. Usage varies with projection and for a complete description + parameters. Usage varies with projection and for a complete description consult the :ref:`projection pages `. -The :program:`cs2cs` program requires two coordinate system 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 coordinate system. If there is no +The :program:`cs2cs` program requires two coordinate system 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 coordinate system. If there is no second coordinate system defined, a geographic coordinate system based on the -datum and ellipsoid of the source coordinate system is assumed. Note that the -source and destination coordinate system can both be projections, both be +datum and ellipsoid of the source coordinate system is assumed. Note that the +source and destination coordinate system can both be projections, both be geographic, or one of each and may have the same or different datums. -Additional projection control parameters may be contained in two auxiliary -control files: the first is optionally referenced with the +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 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. - -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 +projection has been established from either the run-line or the contents of +*+init* file. The environment parameter 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. + +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 +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 +places), while projected (cartesian) coordinates will be in linear (meter, feet) units. @@ -155,18 +155,18 @@ The following script :: - cs2cs +proj=latlong +datum=NAD83 +to +proj=utm +zone=10 +datum=NAD27 -r - <* [ **-afFIlptwW** [ args ] ] [ *+args* ] file[s] + **geod** *+ellps=* [ **-afFIlptwW** [ args ] ] [ *+args* ] file[s] - **invgeod** *+ellps=* [ **-afFIlptwW** [ args ] ] [ *+args* ] file[s] + **invgeod** *+ellps=* [ **-afFIlptwW** [ args ] ] [ *+args* ] file[s] Description *********** -:program:`geod` (direct) and :program:`invgeod` (inverse) perform geodesic -(Great Circle) computations for determining latitude, longitude and back -azimuth of a terminus point given a initial point latitude, longitude, -azimuth and distance (direct) or the forward and back azimuths and distance -between an initial and terminus point latitudes and longitudes (inverse). -The results are accurate to round off for :math:`|f| < 1/50`, where +:program:`geod` (direct) and :program:`invgeod` (inverse) perform geodesic +(Great Circle) computations for determining latitude, longitude and back +azimuth of a terminus point given a initial point latitude, longitude, +azimuth and distance (direct) or the forward and back azimuths and distance +between an initial and terminus point latitudes and longitudes (inverse). +The results are accurate to round off for :math:`|f| < 1/50`, where :math:`f` is flattening. -:program:`invgeod` may not be available on all platforms; in this case +:program:`invgeod` may not be available on all platforms; in this case use :option:`geod -I` instead. The following command-line options can appear in any order: @@ -40,7 +40,7 @@ The following command-line options can appear in any order: .. option:: -a Latitude and longitudes of the initial and terminal points, forward and - back azimuths and distance are output. + back azimuths and distance are output. .. option:: -ta @@ -54,7 +54,7 @@ The following command-line options can appear in any order: .. option:: -lu - Gives a listing of all the units that may be selected with the *+units=* + Gives a listing of all the units that may be selected with the *+units=* option. .. option:: -f @@ -85,15 +85,15 @@ The following command-line options can appear in any order: This option causes the azimuthal values to be output as unsigned DMS numbers between 0 and 360 degrees. Also note :option:`-f`. -The *+args* command-line options are associated with geodetic -parameters for specifying the ellipsoidal or sphere to use. -controls. The options are processed in left to right order -from the command line. Reentry of an option is ignored with +The *+args* command-line options are associated with geodetic +parameters for specifying the ellipsoidal or sphere to use. +controls. The options are processed in left to right order +from the command line. Reentry of an option is ignored with the first occurrence assumed to be the desired value. .. only:: html - See :ref:`projections_intro` for full + See :ref:`projections_intro` for full list of these parameters and controls. .. only:: man @@ -101,88 +101,88 @@ the first occurrence assumed to be the desired value. See the PROJ documentation for a full list of these parameters and controls. -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, +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 direct determinations input data must be in latitude, longitude, +For direct determinations input data must be in latitude, longitude, azimuth and distance order and output will be latitude, -longitude and back azimuth of the terminus point. Latitude, -longitude of the initial and terminus point are input for the -inverse mode and respective forward and back azimuth from the -initial and terminus points are output along with the distance +longitude and back azimuth of the terminus point. Latitude, +longitude of the initial and terminus point are input for the +inverse mode and respective forward and back azimuth from the +initial and terminus points are output along with the distance between the points. -Input geographic coordinates (latitude and longitude) and -azimuthal data must be in decimal degrees or DMS format and +Input geographic coordinates (latitude and longitude) and +azimuthal data must be in decimal degrees or DMS format and input distance data must be in units consistent with the ellipsoid -major axis or sphere radius units. The latitude must lie -in the range [-90d,90d]. Output geographic coordinates will be +major axis or sphere radius units. The latitude must lie +in the range [-90d,90d]. Output geographic coordinates will be in DMS (if the :option:`-f` switch is not employed) to 0.001" with trailing, -zero-valued minute-second fields deleted. Output distance -data will be in the same units as the ellipsoid or sphere +zero-valued minute-second fields deleted. Output distance +data will be in the same units as the ellipsoid or sphere radius. The Earth's ellipsoidal figure may be selected in the same manner as program :program:`proj` by using *+ellps=*, *+a=*, *+es=*, etc. -Geod may also be used to determine intermediate points along -either a geodesic line between two points or along an arc of -specified distance from a geographic point. In both cases an -initial point must be specified with *+lat_1=lat* and *+lon_1=lon* -parameters and either a terminus point *+lat_2=lat* and -*+lon_2=lon* or a distance and azimuth from the initial point +Geod may also be used to determine intermediate points along +either a geodesic line between two points or along an arc of +specified distance from a geographic point. In both cases an +initial point must be specified with *+lat_1=lat* and *+lon_1=lon* +parameters and either a terminus point *+lat_2=lat* and +*+lon_2=lon* or a distance and azimuth from the initial point with *+S=distance* and *+A=azimuth* must be specified. -If points along a geodesic are to be determined then either -*+n_S=integer* specifying the number of intermediate points -and/or *+del_S=distance* specifying the incremental distance +If points along a geodesic are to be determined then either +*+n_S=integer* specifying the number of intermediate points +and/or *+del_S=distance* specifying the incremental distance between points must be specified. -To determine points along an arc equidistant from the initial -point both *+del_A=angle* and *+n_A=integer* must be specified +To determine points along an arc equidistant from the initial +point both *+del_A=angle* and *+n_A=integer* must be specified which determine the respective angular increments and number of points to be determined. Examples ******** -The following script determines the geodesic azimuths and distance in U.S. +The following script determines the geodesic azimuths and distance in U.S. statute miles from Boston, MA, to Portland, OR: .. code-block:: console - geod +ellps=clrk66 < -Parsing of a :program:`gie` file starts at ```` and ends when ```` +Parsing of a :program:`gie` file starts at ```` and ends when ```` is reached. Anything before ```` and after ```` is not considered. Test cases are created by defining an :option:`operation` which :option:`accept` an input coordinate and :option:`expect` an output @@ -143,7 +143,7 @@ gie command language accompanying :option:`expect` is needed. Note that :program:`gie` accepts the underscore ("_") as a thousands - separator. It is not required (in fact, it is entirely ignored by the + separator. It is not required (in fact, it is entirely ignored by the input routine), but it significantly improves the readability of the very long strings of numbers typically required in projected coordinates. @@ -179,7 +179,7 @@ gie command language The :option:`tolerance` command controls how much accepted coordinates can deviate from the expected coordinate. This is handy to test that an operation meets a certain numerical tolerance threshold. Some operations - are expexted to be accurate within milimeters where others might only be + are expexted to be accurate within milimeters where others might only be accurate within a few meters. :option:`tolerance` should .. code-block:: console @@ -251,7 +251,7 @@ gie command language .. code-block:: console - operation proj=hgridshift +grids=nzgd2kgrid0005.gsb ellps=GRS80 + operation proj=hgridshift +grids=nzgd2kgrid0005.gsb ellps=GRS80 tolerance 1 mm ignore pjd_err_failed_to_load_grid accept 172.999892181021551 -45.001620431954613 @@ -307,12 +307,12 @@ Background More importantly than being an acronym for "Geospatial Integrity Investigation Environment", gie were also the initials, user id, and USGS email address of Gerald Ian Evenden (1935--2016), the geospatial visionary, who, already in the -1980s, started what was to become the PROJ of today. +1980s, started what was to become the PROJ of today. Gerald's clear vision was that map projections are *just special functions*. Some of them rather complex, most of them of two variables, but all of them *just special functions*, and not particularly more special than the :c:func:`sin()`, -:c:func:`cos()`, :c:func:`tan()`, and :c:func:`hypot()` already available in the C standard library. +:c:func:`cos()`, :c:func:`tan()`, and :c:func:`hypot()` already available in the C standard library. And hence, according to Gerald, *they should not be particularly much harder to use*, for a programmer, than the :c:func:`sin()`'s, :c:func:`tan()`'s and @@ -322,7 +322,7 @@ Gerald's ingenuity also showed in the implementation of the vision, where he devised a comprehensive, yet simple, system of key-value pairs for parameterising a map projection, and the highly flexible :c:type:`PJ` struct, storing run-time compiled versions of those key-value pairs, hence making a map -projection function call, ``pj_fwd(PJ, point)``, as easy as a traditional function +projection function call, ``pj_fwd(PJ, point)``, as easy as a traditional function call like ``hypot(x,y)``. While today, we may have more formally well defined metadata systems (most diff --git a/docs/source/apps/proj.rst b/docs/source/apps/proj.rst index dee4ea89..19a72a66 100644 --- a/docs/source/apps/proj.rst +++ b/docs/source/apps/proj.rst @@ -19,14 +19,14 @@ Synopsis 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:`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 +: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 +The following control parameters can appear in any order .. program:: proj @@ -53,15 +53,15 @@ The following control parameters can appear in any order .. option:: -t *a* specifies a character employed as the first character to denote a - control line to be passed through without processing. This option + control line to be passed through without processing. This option applicable to ascii input only. (# is the default value). .. option:: -e - 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. + 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 @@ -119,21 +119,21 @@ The following control parameters can appear in any order 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 + projection. If the first two characters of mult are 1/ or 1: then the reciprocal value of mult is employed. .. option:: -f 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 + employed. The default format is "%.2f" for forward projection and DMS for inverse. .. option:: -[w|W] 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. + 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 @@ -149,7 +149,7 @@ The following control parameters can appear in any order .. option:: -T This option creates a set of bivariate Chebyshev polynomial coefficients - that approximate the selected cartographic projection on stdout. The values + 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 @@ -160,13 +160,13 @@ The following control parameters can appear in any order 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 +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. ++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 @@ -174,17 +174,17 @@ also used for supporting files like datum shift files. consult the :ref:`projection pages `. -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 +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 +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 @@ -193,16 +193,15 @@ The following script .. code-block:: console - proj +proj=utm +lon_0=112w +ellps=clrk66 - -r < Date: Sat, 5 May 2018 22:30:15 +1200 Subject: Use formatting similar to used in original manuals Minor rephrasing for better reading. Split -[w|W] into two options. --- docs/source/apps/cct.rst | 10 ++++----- docs/source/apps/cs2cs.rst | 45 +++++++++++++++++++++---------------- docs/source/apps/geod.rst | 20 ++++++++--------- docs/source/apps/gie.rst | 2 +- docs/source/apps/proj.rst | 56 +++++++++++++++++++++++++--------------------- 5 files changed, 72 insertions(+), 61 deletions(-) (limited to 'docs/source') diff --git a/docs/source/apps/cct.rst b/docs/source/apps/cct.rst index 3c3f6668..a6e6e551 100644 --- a/docs/source/apps/cct.rst +++ b/docs/source/apps/cct.rst @@ -38,13 +38,13 @@ The following control parameters can appear in any order: .. option:: -t - A specifies a character employed as the first character to denote a control + 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). + ASCII input only. (# is the default value). .. option:: -e - 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 -b, -i - or -o options are employed, an error is returned as HUGE_VAL value for both + 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*``. + Note that if the -b, -i or -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 + 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``. + gives expanded description of projection *id*, e.g. ``cs2cs -l=merc``. .. option:: -lp @@ -87,21 +87,26 @@ The following control parameters can appear in any order: .. option:: -f - Format is a printf format string to control the form of the output values. + 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 + will be in decimal degrees. The default format is ``"%.2f"`` for forward projection and DMS for inverse. -.. option:: -[w|W] +.. option:: -w - 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. + 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 + + 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 + Causes a listing of cartographic control parameters tested for and used by the program to be printed prior to input data. @@ -129,7 +134,7 @@ 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 PROJ_LIB establishes the default +*+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. @@ -155,9 +160,11 @@ The following script :: - cs2cs +proj=latlong +datum=NAD83 +to +proj=utm +zone=10 +datum=NAD27 -r - < - A specifies a character employed as the first character to denote a control + Where *a* specifies a character employed as the first character to denote a control line to be passed through without processing. .. option:: -le @@ -59,24 +59,24 @@ The following command-line options can appear in any order: .. option:: -f - Format is a printf format string to control the output form of the + Where *format* is a printf format string to control the output form of the geographic coordinate values. The default mode is DMS for geographic - coordinates and "%.3f" for distance. + coordinates and ``"%.3f"`` for distance. .. option:: -F - Format is a printf format string to control the output form of the distance + Where *format* is a printf format string to control the output form of the distance value (``-F``). The default mode is DMS for geographic coordinates and - "%.3f" for distance. + ``"%.3f"`` for distance. .. option:: -w - N is the number of significant fractional digits to employ for seconds + 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 is the number of significant fractional digits to employ for seconds + 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. @@ -127,7 +127,7 @@ radius. The Earth's ellipsoidal figure may be selected in the same manner as program :program:`proj` by using *+ellps=*, *+a=*, *+es=*, etc. -Geod may also be used to determine intermediate points along +:program:`geod` may also be used to determine intermediate points along either a geodesic line between two points or along an arc of specified distance from a geographic point. In both cases an initial point must be specified with *+lat_1=lat* and *+lon_1=lon* diff --git a/docs/source/apps/gie.rst b/docs/source/apps/gie.rst index 35b0ac38..066b4f70 100644 --- a/docs/source/apps/gie.rst +++ b/docs/source/apps/gie.rst @@ -142,7 +142,7 @@ gie command language accepted for one :option:`operation`. For each :option:`accept` an accompanying :option:`expect` is needed. - Note that :program:`gie` accepts the underscore ("_") as a thousands + Note that :program:`gie` accepts the underscore (``_``) as a thousands separator. It is not required (in fact, it is entirely ignored by the input routine), but it significantly improves the readability of the very long strings of numbers typically required in projected coordinates. diff --git a/docs/source/apps/proj.rst b/docs/source/apps/proj.rst index 19a72a66..086617a4 100644 --- a/docs/source/apps/proj.rst +++ b/docs/source/apps/proj.rst @@ -34,7 +34,7 @@ The following control parameters can appear in any order 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 + floating point words. This option is to be used when :program:`proj` is a son process and allows bypassing formatting operations. .. option:: -i @@ -43,8 +43,8 @@ The following control parameters can appear in any order .. option:: -I - alternate method to specify inverse projection. Redundant when used with - invproj. + Alternate method to specify inverse projection. Redundant when used with + :program:`invproj`. .. option:: -o @@ -52,26 +52,26 @@ The following control parameters can appear in any order .. option:: -t - *a* specifies a character employed as the first character to denote 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). + applicable to ASCII input only. (# is the default value). .. option:: -e - 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 + 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*``. + 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 + 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``. + gives expanded description of projection *id*, e.g. ``proj -l=merc``. .. option:: -lp @@ -95,7 +95,6 @@ The following control parameters can appear in any order List of datums that can be selected with the *+datum* parameter. - .. option:: -r This options reverses the order of the expected input from @@ -116,28 +115,33 @@ The following control parameters can appear in any order .. option:: -m - The cartesian data may be scaled by the mult parameter. When processing data + 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. + *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 is a printf format string to control the form of the output values. + 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. The default format is "%.2f" for forward projection and DMS for + employed. The default format is ``"%.2f"`` for forward projection and DMS for inverse. -.. option:: -[w|W] +.. option:: -w + + 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 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. + 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 + 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. @@ -150,11 +154,11 @@ The following control parameters can appear in any order 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 + *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 + inverse projection is selected. The integer *res* is a number specifying the + power of 10 precision of the approximation. For example, a *res* of -3 + specifies an approximation with an accuracy better than 0.001. Optional *umax*, and *vmax* specify maximum degree of the polynomials (default: 15). -- cgit v1.2.3 From 34f4ac6fc5c1190a21a8c9ca08ae121ad6883c43 Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sat, 5 May 2018 22:36:31 +1200 Subject: fix typos --- docs/source/apps/cct.rst | 2 +- docs/source/apps/gie.rst | 6 +++--- docs/source/apps/proj.rst | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/source') diff --git a/docs/source/apps/cct.rst b/docs/source/apps/cct.rst index a6e6e551..8cd6c0c6 100644 --- a/docs/source/apps/cct.rst +++ b/docs/source/apps/cct.rst @@ -48,7 +48,7 @@ The following control parameters can appear in any order: .. versionadded:: 5.1.0 - Skip the first *n* lines of input. This applies to any kind of input, wether + Skip the first *n* lines of input. This applies to any kind of input, whether it comes from ``STDIN``, a file or interactive user input. .. option:: -v, --verbose diff --git a/docs/source/apps/gie.rst b/docs/source/apps/gie.rst index 066b4f70..b6c1c166 100644 --- a/docs/source/apps/gie.rst +++ b/docs/source/apps/gie.rst @@ -163,7 +163,7 @@ gie command language In addition to expecting a coordinate it is also possible to expect a PROJ error code in case an operation can't be created. This is useful when testing that errors are caught and handled correctly. Below is an example of - that tests that the pipeline operator fails correctly when a non-invertable + that tests that the pipeline operator fails correctly when a non-invertible pipeline is constructed. .. code-block:: console @@ -179,7 +179,7 @@ gie command language The :option:`tolerance` command controls how much accepted coordinates can deviate from the expected coordinate. This is handy to test that an operation meets a certain numerical tolerance threshold. Some operations - are expexted to be accurate within milimeters where others might only be + are expected to be accurate within millimeters where others might only be accurate within a few meters. :option:`tolerance` should .. code-block:: console @@ -286,7 +286,7 @@ gie command language .. option:: skip - Skip any test after the first occurence of :option:`skip`. In the example below only + Skip any test after the first occurrence of :option:`skip`. In the example below only the first test will be performed. The second test is skipped. This feature is mostly relevant for debugging when writing new test cases. diff --git a/docs/source/apps/proj.rst b/docs/source/apps/proj.rst index 086617a4..97af0c1d 100644 --- a/docs/source/apps/proj.rst +++ b/docs/source/apps/proj.rst @@ -219,7 +219,7 @@ data will appear as three lines of:: projected coordinates within one datum. The :program:`cs2cs` program operates similarly, but allows translation - between any paor of definable coordinate reference systems, including + between any pair of definable coordinate reference systems, including support for datum translation. See also -- cgit v1.2.3 From 7ec02f43a42cf89957b60f5bb2b03deb90b31f1b Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sat, 5 May 2018 22:44:32 +1200 Subject: proj usage: remove unused 'c', add 'vV' to invproj --- docs/source/apps/proj.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/source') diff --git a/docs/source/apps/proj.rst b/docs/source/apps/proj.rst index 97af0c1d..538bce48 100644 --- a/docs/source/apps/proj.rst +++ b/docs/source/apps/proj.rst @@ -12,9 +12,9 @@ proj Synopsis ******** - **proj** [ **-bceEfiIlmorsStTvVwW** ] [ args ] ] [ *+args* ] file[s] + **proj** [ **-beEfiIlmorsStTvVwW** ] [ args ] ] [ *+args* ] file[s] - **invproj** [ **-bceEfiIlmorsStTwW** ] [ args ] ] [ *+args* ] file[s] + **invproj** [ **-beEfiIlmorsStTvVwW** ] [ args ] ] [ *+args* ] file[s] Description -- cgit v1.2.3 From 526970178627bbf0dfbff04ba783fd3646214fad Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sat, 5 May 2018 22:57:15 +1200 Subject: cct usage: add 'I' to docs, re-order usage to same as docs --- docs/source/apps/cct.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'docs/source') diff --git a/docs/source/apps/cct.rst b/docs/source/apps/cct.rst index 8cd6c0c6..a08f1471 100644 --- a/docs/source/apps/cct.rst +++ b/docs/source/apps/cct.rst @@ -13,7 +13,7 @@ cct Synopsis ******** - **cct** [ **-cotvz** [ args ] ] *+opts[=arg]* file[s] + **cct** [ **-cIostvz** [ args ] ] *+opts[=arg]* file[s] Description *********** @@ -32,6 +32,10 @@ The following control parameters can appear in any order: Specify input columns for (up to) 4 input parameters. Defaults to 1,2,3,4. +.. option:: -I + + Do the inverse transformation. + .. option:: -o , --output= Specify the name of the output file. -- cgit v1.2.3 From b737d92c36f8e2f29d8a7f63931b30f1f9aaf34e Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sat, 5 May 2018 23:01:43 +1200 Subject: cs2cs usage: remove note about non-existant -b -i -o options. --- docs/source/apps/cs2cs.rst | 2 -- 1 file changed, 2 deletions(-) (limited to 'docs/source') diff --git a/docs/source/apps/cs2cs.rst b/docs/source/apps/cs2cs.rst index d5d35028..7256a44c 100644 --- a/docs/source/apps/cs2cs.rst +++ b/docs/source/apps/cs2cs.rst @@ -40,8 +40,6 @@ The following control parameters can appear in any order: 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*``. - Note that if the -b, -i or -o options are employed, an error is returned as HUGE_VAL value for both - return values. .. option:: -E -- cgit v1.2.3 From feb4e98cb856db07b9c2e730eda7073abc4bf48c Mon Sep 17 00:00:00 2001 From: mwtoews Date: Sat, 5 May 2018 23:30:41 +1200 Subject: replace: son -> child --- docs/source/apps/proj.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/source') diff --git a/docs/source/apps/proj.rst b/docs/source/apps/proj.rst index 538bce48..43e2038c 100644 --- a/docs/source/apps/proj.rst +++ b/docs/source/apps/proj.rst @@ -34,7 +34,7 @@ The following control parameters can appear in any order 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 :program:`proj` is a son process + floating point words. This option is to be used when :program:`proj` is a child process and allows bypassing formatting operations. .. option:: -i -- cgit v1.2.3