Skip to content

Commit

Permalink
Doc: add preliminary documentation of suffix based specification of u…
Browse files Browse the repository at this point in the history
…nits (#3346)

Fixes #3345
  • Loading branch information
sval-dev authored Sep 27, 2022
1 parent 56b3de5 commit aa18b0b
Show file tree
Hide file tree
Showing 6 changed files with 68 additions and 2 deletions.
8 changes: 8 additions & 0 deletions docs/source/operations/options/lat_0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,11 @@
Latitude of projection center.

*Defaults to 0.0.*

.. note::
The default convention is to interpret this value as decimal degrees. To
specify radians instead, follow the value with the "r" character.

Example: `+lat_0=1.5708r`

See :ref:`Projection Units <projection_units>` for more information.
8 changes: 8 additions & 0 deletions docs/source/operations/options/lat_1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,11 @@
First standard parallel.

*Defaults to 0.0.*

.. note::
The default convention is to interpret this value as decimal degrees. To
specify radians instead, follow the value with the "r" character.

Example: `+lat_1=1.5708r`

See :ref:`Projection Units <projection_units>` for more information.
8 changes: 8 additions & 0 deletions docs/source/operations/options/lat_2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,11 @@
Second standard parallel.

*Defaults to 0.0.*

.. note::
The default convention is to interpret this value as decimal degrees. To
specify radians instead, follow the value with the "r" character.

Example: `+lat_2=1.5708r`

See :ref:`Projection Units <projection_units>` for more information.
8 changes: 8 additions & 0 deletions docs/source/operations/options/lat_ts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,11 @@
Takes precedence over ``+k_0`` if both options are used together.

*Defaults to 0.0.*

.. note::
The default convention is to interpret this value as decimal degrees. To
specify radians instead, follow the value with the "r" character.

Example: `+lat_ts=1.5708r`

See :ref:`Projection Units <projection_units>` for more information.
8 changes: 8 additions & 0 deletions docs/source/operations/options/lon_0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,11 @@
Longitude of projection center.

*Defaults to 0.0.*

.. note::
The default convention is to interpret this value as decimal degrees. To
specify radians instead, follow the value with the "r" character.

Example: `+lon_0=1.5708r`

See :ref:`Projection Units <projection_units>` for more information.
30 changes: 28 additions & 2 deletions docs/source/usage/projections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ documenting the individual :doc:`projections<../operations/projections/index>`.

In the sections below most of the parameters are explained in details.

.. _projection_units:

Units
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Expand All @@ -64,6 +66,32 @@ Scaling of output units can be done by applying the ``+k_0`` argument. The
returned coordinates are scaled by the value assigned with the ``+k_0``
parameter.

Input units for parameters that can be understood to be either decimal degrees or
radians are interpreted to be decimal degrees by convention.

Explict specification of input units can be accomplished by adding the appropriate
suffix to input values.


+----------------+---------------------+
| Suffix | Unit |
+================+=====================+
| d | Decimal degrees |
+----------------+ +
| D | |
+----------------+ +
| ° | |
+----------------+---------------------+
| r | Radians |
+----------------+ +
| R | |
+----------------+---------------------+

Example of use. The longitude of the central meridian ``+lon_0=90``, can also be expressed more explictly
with units of decimal degrees as ``+lon_0=90d`` or in radian
units as ``+lon_0=1.5708r`` (approximately).


False Easting/Northing
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Expand Down Expand Up @@ -159,5 +187,3 @@ They can be combined in +axis in forms like:

The ``+axis`` argument does not work with the :program:`proj` command line
utility.


0 comments on commit aa18b0b

Please sign in to comment.