diff options
Diffstat (limited to 'docs/source/usage')
| -rw-r--r-- | docs/source/usage/apps/index.rst | 2 | ||||
| -rw-r--r-- | docs/source/usage/environmentvars.rst | 10 | ||||
| -rw-r--r-- | docs/source/usage/index.rst | 4 | ||||
| -rw-r--r-- | docs/source/usage/operations/conversions/index.rst | 2 | ||||
| -rw-r--r-- | docs/source/usage/operations/conversions/unitconvert.rst | 4 | ||||
| -rw-r--r-- | docs/source/usage/operations/index.rst | 4 | ||||
| -rw-r--r-- | docs/source/usage/operations/projections/geos.rst | 2 | ||||
| -rw-r--r-- | docs/source/usage/operations/projections/index.rst | 2 | ||||
| -rw-r--r-- | docs/source/usage/operations/transformations/hgridshift.rst | 2 | ||||
| -rw-r--r-- | docs/source/usage/operations/transformations/vgridshift.rst | 2 | ||||
| -rw-r--r-- | docs/source/usage/projections.rst | 8 | ||||
| -rw-r--r-- | docs/source/usage/quickstart.rst | 6 | ||||
| -rw-r--r-- | docs/source/usage/resource_files.rst | 12 | ||||
| -rw-r--r-- | docs/source/usage/transformation.rst | 18 |
14 files changed, 39 insertions, 39 deletions
diff --git a/docs/source/usage/apps/index.rst b/docs/source/usage/apps/index.rst index 73c5c63c..0d818682 100644 --- a/docs/source/usage/apps/index.rst +++ b/docs/source/usage/apps/index.rst @@ -4,7 +4,7 @@ Applications ================================================================================ -Bundled with PROJ.4 comes a set of small command line utilities. The +Bundled with PROJ comes a set of small command line utilities. The ``proj`` program is limited to converting between geographic and projection coordinates within one datum. The ``cs2cs`` program operates similarly, but allows translation between any pair of definable coordinate systems, including diff --git a/docs/source/usage/environmentvars.rst b/docs/source/usage/environmentvars.rst index 38cb46de..0d5d06a8 100644 --- a/docs/source/usage/environmentvars.rst +++ b/docs/source/usage/environmentvars.rst @@ -4,7 +4,7 @@ Environment variables ================================================================================ -PROJ.4 can be crontrolled by setting environment variables. Most users will +PROJ can be crontrolled by setting environment variables. Most users will have a use for the :envvar:`PROJ_LIB`. On UNIX systems environment variables can be set for a shell-session with:: @@ -30,14 +30,14 @@ done by setting the variable with no content:: .. envvar:: PROJ_LIB - The location of PROJ.4 :doc:`resource files<resource_files>`. + The location of PROJ :doc:`resource files<resource_files>`. It is only possible to specify a single library in :envvar:`PROJ_LIB`; e.g. it - does not behave like PATH. PROJ.4 is hardcoded to look for resource files + does not behave like PATH. PROJ is hardcoded to look for resource files in other locations as well, amongst those are the users home directory, ``/usr/share/proj`` and the current folder. .. envvar:: PROJ_DEBUG - Set the debug level of PROJ.4. The default debug level is zero, which results - in no debug output when using PROJ.4. A number from 1-3, whit 3 being the most + Set the debug level of PROJ. The default debug level is zero, which results + in no debug output when using PROJ. A number from 1-3, whit 3 being the most verbose setting. diff --git a/docs/source/usage/index.rst b/docs/source/usage/index.rst index 81ea4b6b..d59296d0 100644 --- a/docs/source/usage/index.rst +++ b/docs/source/usage/index.rst @@ -1,10 +1,10 @@ .. _usage: ================================================================================ -Using PROJ.4 +Using PROJ ================================================================================ -The main purpose of PROJ.4 is to transform coordinates from one coordinate +The main purpose of PROJ is to transform coordinates from one coordinate reference system to another. This can be achieved either with the included command line applications or the C API that is a part of the software package. diff --git a/docs/source/usage/operations/conversions/index.rst b/docs/source/usage/operations/conversions/index.rst index 54324ec4..af27e2fd 100644 --- a/docs/source/usage/operations/conversions/index.rst +++ b/docs/source/usage/operations/conversions/index.rst @@ -5,7 +5,7 @@ Conversions ================================================================================ Conversions are coordinate operations in which both coordinate reference systems -are based on the same datum. In PROJ.4 projections are differentiated from +are based on the same datum. In PROJ projections are differentiated from conversions. .. toctree:: diff --git a/docs/source/usage/operations/conversions/unitconvert.rst b/docs/source/usage/operations/conversions/unitconvert.rst index ad848207..73e517bd 100644 --- a/docs/source/usage/operations/conversions/unitconvert.rst +++ b/docs/source/usage/operations/conversions/unitconvert.rst @@ -46,7 +46,7 @@ expected to be in units of decimalyears. This can be fixed with `unitconvert`:: Distance units ############################################################################### -In the table below all distance units supported by PROJ.4 is listed. +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. @@ -100,7 +100,7 @@ by adding the `-lu` flag when calling the utility. Time units ############################################################################### -In the table below all time units supported by PROJ.4 is listed. +In the table below all time units supported by PROJ is listed. +--------------+-----------------------------+ | mjd | Modfied Julian date | diff --git a/docs/source/usage/operations/index.rst b/docs/source/usage/operations/index.rst index d78f8947..87bfdc40 100644 --- a/docs/source/usage/operations/index.rst +++ b/docs/source/usage/operations/index.rst @@ -4,11 +4,11 @@ Coordinate operations ================================================================================ -Coordinate operations in PROJ.4 are divided into three groups: +Coordinate operations in PROJ are divided into three groups: Projections, conversions and transformations. Projections are purely cartographic mappings of the sphere onto the plane. Technically projections are conversions (according to ISO standards), though in -PROJ.4 projections are distinguished from conversions. Conversions are coordinate +PROJ projections are distinguished from conversions. Conversions are coordinate operations that do not exert a change in reference frame. Operations that do exert a change in reference frame are called transformations. diff --git a/docs/source/usage/operations/projections/geos.rst b/docs/source/usage/operations/projections/geos.rst index 3b24e1f7..28b96736 100644 --- a/docs/source/usage/operations/projections/geos.rst +++ b/docs/source/usage/operations/projections/geos.rst @@ -66,7 +66,7 @@ This example represents the scanning geometry of the Meteosat series satellite. However, the GOES satellite series use the opposite scanning geometry, with the E/W axis (``x``) as the sweep-angle axis, and the N/S (``y``) as the fixed-angle axis. -The sweep argument is used to tell PROJ.4 which on which axis the outer-gimbal +The sweep argument is used to tell PROJ which on which axis the outer-gimbal is rotating. The possible values are x or y, y being the default. Thus, the scanning geometry of the Meteosat series satellite should take sweep as x, and GOES should take sweep as y. diff --git a/docs/source/usage/operations/projections/index.rst b/docs/source/usage/operations/projections/index.rst index f7eb0c67..904dc9e6 100644 --- a/docs/source/usage/operations/projections/index.rst +++ b/docs/source/usage/operations/projections/index.rst @@ -5,7 +5,7 @@ Projections ================================================================================ Projections are coordinate operations that are technically conversions but since -projections are so fundamental to PROJ.4 we differentiate them from conversions. +projections are so fundamental to PROJ we differentiate them from conversions. Projections map the spherical 3D space to a flat 2D space. diff --git a/docs/source/usage/operations/transformations/hgridshift.rst b/docs/source/usage/operations/transformations/hgridshift.rst index a9690260..7f3c9895 100644 --- a/docs/source/usage/operations/transformations/hgridshift.rst +++ b/docs/source/usage/operations/transformations/hgridshift.rst @@ -30,7 +30,7 @@ of the continental US, Alaska and Canada is loaded at the same time:: +hgridshift +grids=@conus,@alaska,@ntv2_0.gsb,@ntv_can.dat The ``@`` in the above example states that the grid is optional, in case the grid -is not found in the PROJ.4 search path. The list of grids is prioritized so that +is not found in the PROJ search path. The list of grids is prioritized so that grids in the start of the list takes presedence over the grids in the back of the list. diff --git a/docs/source/usage/operations/transformations/vgridshift.rst b/docs/source/usage/operations/transformations/vgridshift.rst index 31b3e56e..e9f78310 100644 --- a/docs/source/usage/operations/transformations/vgridshift.rst +++ b/docs/source/usage/operations/transformations/vgridshift.rst @@ -32,7 +32,7 @@ the global model:: +vgridshift +grids=@dvr90.gtx,egm96_16.gtx The ``@`` in the above example states that the grid is optional, in case the grid -is not found in the PROJ.4 search path. The list of grids is prioritized so that +is not found in the PROJ search path. The list of grids is prioritized so that grids in the start of the list takes presedence over the grids in the back of the list. diff --git a/docs/source/usage/projections.rst b/docs/source/usage/projections.rst index 8f0b3586..645c1eb1 100644 --- a/docs/source/usage/projections.rst +++ b/docs/source/usage/projections.rst @@ -4,12 +4,12 @@ Cartographic projection ================================================================================ -The foundation of PROJ.4 is the large number of +The foundation of PROJ is the large number of :doc:`projections<operations/projections/index>` available in the library. This section is devoted to the generic parameters that can be used on any projection in the -PROJ.4 library. +PROJ library. -Below is a list of PROJ.4 parameters which can be applied to most coordinate +Below is a list of PROJ parameters which can be applied to most coordinate system definitions. This table does not attempt to describe the parameters particular to particular projection types. These can be found on the pages documenting the individual :doc:`projections<operations/projections/index>`. @@ -76,7 +76,7 @@ systems (such as UTM) have implicit false easting and northing values. Longitude Wrapping +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -By default PROJ.4 wraps output longitudes in the range -180 to 180. The ``+over`` +By default PROJ wraps output longitudes in the range -180 to 180. The ``+over`` switch can be used to disable the default wrapping which is done at a low level in ``pj_inv()``. This is particularly useful with projections like the :doc:`equidistant cylindrical<operations/projections/eqc>` diff --git a/docs/source/usage/quickstart.rst b/docs/source/usage/quickstart.rst index 96bfbba1..2cf66122 100644 --- a/docs/source/usage/quickstart.rst +++ b/docs/source/usage/quickstart.rst @@ -4,7 +4,7 @@ Quick start ================================================================================ -Coordinate transformations are defined by, what in PROJ.4 terminology is +Coordinate transformations are defined by, what in PROJ terminology is known as, "proj-strings". A proj-string describes any transformation regardless of how simple or complicated it might be. The simplest case is projection of geodetic coordinates. This section focuses on the simpler cases and introduces the basic @@ -22,7 +22,7 @@ parameters that applies to the projection and, if needed, a description of a datum shift. In the example above geodetic coordinates are transformed to projected space with the :doc:`Mercator projection<operations/projections/merc>` with the latitude of true scale at 56.5 degrees north on the GRS80 ellipsoid. Every -projection in PROJ.4 is identified by a shorthand such as ``merc`` in the above +projection in PROJ is identified by a shorthand such as ``merc`` in the above example. By using the above projection definition as parameters for the command line @@ -43,7 +43,7 @@ the utility, for instance by using the ``echo`` command: 3399483.80 752085.60 -PROJ.4 also comes bundled with the ``cs2cs`` utility which is used to transform +PROJ also comes bundled with the ``cs2cs`` utility which is used to transform from onecoordinate reference system to another. Say we want to convert the above Mercator coordinates to UTM, we can do that with ``cs2cs``: diff --git a/docs/source/usage/resource_files.rst b/docs/source/usage/resource_files.rst index 9a202879..7a1dea8b 100644 --- a/docs/source/usage/resource_files.rst +++ b/docs/source/usage/resource_files.rst @@ -5,7 +5,7 @@ Resource files ================================================================================ A number of files containing preconfigured transformations and default parameters -for certain projections are bundled with the PROJ.4 distribution. Init files +for certain projections are bundled with the PROJ distribution. Init files contains preconfigured proj-strings for various coordinate reference systems and the defaults file contains default values for parameters of select projections. @@ -21,8 +21,8 @@ it easy to transformations between any two coordinate reference systems with have to follow the *cs2cs* paradigm where WGS84 is used as a pivot datum. The ITRF init file is a good example of that. -A number of init files come pre-bundled with PROJ.4 but it is also possible to -add your own custom init files. PROJ.4 looks for the init files in the directoty +A number of init files come pre-bundled with PROJ but it is also possible to +add your own custom init files. PROJ looks for the init files in the directoty listed in the ``PROJ_LIB`` environment variable. The format of init files made up of a identifier in angled brackets and a @@ -84,7 +84,7 @@ which then expands to +epoch=2000.0 +transpose +tobs=2010.5 -Below is a list of the init files that are packaged with PROJ.4. +Below is a list of the init files that are packaged with PROJ. ======== ================================================================ Name Description @@ -108,12 +108,12 @@ Below is a list of the init files that are packaged with PROJ.4. Defaults file ------------------------------------------------------------------------------- -The ``proj_def.dat`` file supplies default parameters for PROJ.4. It uses the same +The ``proj_def.dat`` file supplies default parameters for PROJ. It uses the same syntax as the init files described above. The identifiers in the defaults file describe to what the parameters should apply. If the ``<general>`` identifier is used, then all parameters in that section applies for all proj-strings. Otherwise the identifier is connected to a specific projection. With the defaults file -supplied with PROJ.4 the default ellipsoid is set to WGS84 (for all proj-strings). +supplied with PROJ the default ellipsoid is set to WGS84 (for all proj-strings). Apart from that only the Albers Equal Area, :doc:`Lambert Conic Conformal<operations/projections/lcc>` and the :doc:`Lagrange<operations/projections/lagrng>` projections have default parameters. diff --git a/docs/source/usage/transformation.rst b/docs/source/usage/transformation.rst index 98e607a7..2f5ee880 100644 --- a/docs/source/usage/transformation.rst +++ b/docs/source/usage/transformation.rst @@ -4,17 +4,17 @@ Geodetic transformation ================================================================================ -PROJ.4 can do everything from the most simple projection to very complex +PROJ can do everything from the most simple projection to very complex transformations across many reference frames. While originally developed as a -tool for cartographic projections, PROJ.4 has over time evolved into a powerfull +tool for cartographic projections, PROJ has over time evolved into a powerfull generic coordinate transformation engine that makes it possible to do both large scale cartographic projections as well as coordinate transformation at a geodetic high precision level. This chapter delves into the details of how geodetec transformations of varying complexity can be performed. -In PROJ.4, two frameworks for geodetic transformations exists, the *cs2cs* +In PROJ, two frameworks for geodetic transformations exists, the *cs2cs* framework and the *transformation pipelines* framework. The first is the original, -and limited, framework for doing geodetic transforms in PROJ.4 The latter is a +and limited, framework for doing geodetic transforms in PROJ The latter is a newer addition that aims to be a more complete transformation framework. Both are described in the sections below. Large portions of the text are based on [EversKnudsen2017]_. @@ -60,7 +60,7 @@ of 3 steps (geodetic-to-cartesian → Helmert → cartesian-to-geodetic), pipeli The pipeline driver, makes this kind of chained transformations possible. The implementation is compact, consisting of just one pseudo-projection, called ``pipeline``, which takes as its arguments strings of elementary projections -(note: "projection" is the, slightly misleading, PROJ.4 term used for any kind of +(note: "projection" is the, slightly misleading, PROJ term used for any kind of transformation). The pipeline pseudo projection is supplemented by a number of elementary transformations, all in all providing a framework for building high accuracy @@ -69,7 +69,7 @@ solutions for a wide spectrum of geodetic tasks. As a first example, let us take a look at the iconic *geodetic → Cartesian → Helmert → geodetic* case (steps 2 to 4 in the example in -the itroduction). In PROJ.4 it can be implemented as +the itroduction). In PROJ it can be implemented as :: @@ -108,7 +108,7 @@ deprecated system with decimeter level tensions. step proj=utm ellps=GRS80 zone=33 With the pipeline framework spatiotemporal transformation is possible. This is -possible by leveraging the time dimension in PROJ.4 that enables 4D coordinates +possible by leveraging the time dimension in PROJ that enables 4D coordinates (three spatial components and one temporal component) to be passed through a transformation pipeline. In the example below a transformation from ITRF93 to ITRF2000 is defined. The temporal component is given as GPS weeks in the input @@ -209,8 +209,8 @@ such as NAD27 to NAD83. These grid shift files include a shift to be applied at each grid location. Actually grid shifts are normally computed based on an interpolation between the containing four grid points. -PROJ.4 supports use of grid files for shifting between various reference frames. -The grid shift table formats are ctable (the binary format produced by the PROJ.4 +PROJ supports use of grid files for shifting between various reference frames. +The grid shift table formats are ctable (the binary format produced by the PROJ ``nad2bin`` program), NTv1 (the old Canadian format), and NTv2 (``.gsb`` - the new Canadian and Australian format). |