aboutsummaryrefslogtreecommitdiff
path: root/docs/source/development/reference
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2017-10-09 21:48:24 +0200
committerKristian Evers <kristianevers@gmail.com>2017-10-09 21:48:24 +0200
commitf8d26297de7f6092e78bcd33876510c7082c3f35 (patch)
tree9b63b733beb6a6958195fd0fe4a3b7acf51b76de /docs/source/development/reference
parentc9376a4700ca71605c27fa84e0ad49d043846158 (diff)
downloadPROJ-f8d26297de7f6092e78bcd33876510c7082c3f35.tar.gz
PROJ-f8d26297de7f6092e78bcd33876510c7082c3f35.zip
Add PJ_DIRECTION to API referece [skip ci]
Diffstat (limited to 'docs/source/development/reference')
-rw-r--r--docs/source/development/reference/datatypes.rst29
-rw-r--r--docs/source/development/reference/functions.rst27
2 files changed, 44 insertions, 12 deletions
diff --git a/docs/source/development/reference/datatypes.rst b/docs/source/development/reference/datatypes.rst
index 991fcfc5..7e314dce 100644
--- a/docs/source/development/reference/datatypes.rst
+++ b/docs/source/development/reference/datatypes.rst
@@ -21,6 +21,34 @@ Transformation objects
are created with :c:func:`proj_create` and destroyed with
:c:func:`proj_destroy`.
+.. c:type:: PJ_DIRECTION
+
+ Enumeration that is used to convey in which direction a given transformation
+ should be performed. Used in transformation function call as described in
+ the section on :ref:`transformation functions <coord_trans_functions>`.
+
+ Forward transformations are defined with the :c:
+
+ .. code-block:: C
+
+ typedef enum proj_direction {
+ PJ_FWD = 1, /* Forward */
+ PJ_IDENT = 0, /* Do nothing */
+ PJ_INV = -1 /* Inverse */
+ } PJ_DIRECTION;
+
+ .. c:member:: PJ_FWD
+
+ Perform transformation in the forward direction.
+
+ .. c:member:: PJ_IDENT
+
+ Identity. Do nothing.
+
+ .. c:member:: PJ_INV
+
+ Perform transformation in the inverse direction.
+
.. c:type:: PJ_CONTEXT
Context objects enables safe multi-threaded usage of PROJ.4. Each :c:type:`PJ`
@@ -29,6 +57,7 @@ Transformation objects
:c:type:`PJ_CONTEXT` objects are created with :c:func:`proj_context_create`
and destroyed with :c:func:`proj_context_destroy`.
+
2 dimensional coordinates
--------------------------------------------------------------------------------
diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst
index 3b6d4489..daefce4b 100644
--- a/docs/source/development/reference/functions.rst
+++ b/docs/source/development/reference/functions.rst
@@ -95,33 +95,36 @@ Transformation setup
:param PJ* P:
:returns: :c:type:`PJ*`
+.. _coord_trans_functions:
+
Coordinate transformation
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-.. c:function:: PJ_COORD proj_trans_coord(PJ *P, enum proj_direction direction, PJ_COORD coord)
+
+.. c:function:: PJ_COORD proj_trans_coord(PJ *P, PJ_DIRECTION direction, PJ_COORD coord)
Transform a single :c:type:`PJ_COORD` coordinate.
:param PJ* P:
:param `direction`: Transformation direction.
- :type `direction`: enum proj_direction
+ :type `direction`: PJ_DIRECTION
:param PJ_COORD coord: Coordinate that will be transformed.
:returns: :c:type:`PJ_COORD`
-.. c:function:: PJ_OBS proj_trans_obs(PJ *P, enum proj_direction direction, PJ_OBS obs)
+.. c:function:: PJ_OBS proj_trans_obs(PJ *P, PJ_DIRECTION direction, PJ_OBS obs)
Transform a single :c:type:`PJ_OBS` observation.
:param PJ* P:
:param `direction`: Transformation direction.
- :type `direction`: enum proj_direction
+ :type `direction`: PJ_DIRECTION
:param PJ_OBS obs: Observation data to transform.
:returns: :c:type:`PJ_OBS`
-.. c:function:: size_t proj_transform(PJ *P, enum proj_direction direction, \
+.. c:function:: size_t proj_transform(PJ *P, PJ_DIRECTION direction, \
double *x, size_t sx, size_t nx, double *y, \
size_t sy, size_t ny, double *z, size_t sz, size_t nz, \
double *t, size_t st, size_t nt)
@@ -182,7 +185,7 @@ Coordinate transformation
:param PJ* P: Transformation object
:param `direction`: Transformation direction
- :type `enum proj_direction`:
+ :type `PJ_DIRECTION`:
:param double* x: Array of x-coordinates
:param double* y: Array of y-coordinates
:param double* z: Array of z-coordinates
@@ -199,23 +202,23 @@ Coordinate transformation
-.. c:function:: size_t proj_transform_coord(PJ *P, enum proj_direction direction, size_t n, PJ_COORD *coord)
+.. c:function:: size_t proj_transform_coord(PJ *P, PJ_DIRECTION direction, size_t n, PJ_COORD *coord)
Batch transform an array of :c:type:`PJ_COORD`.
:param PJ* P:
:param `direction`: Transformation direction
- :type `direction`: enum proj_direction
+ :type `direction`: PJ_DIRECTION
:param size_t n: Number of cordinates in :c:data:`coord`
:returns: :c:type:`size_t` 0 if all observations are transformed without error, otherwise returns error number
-.. c:function:: size_t proj_transform_obs(PJ *P, enum proj_direction direction, size_t n, PJ_OBS *obs)
+.. c:function:: size_t proj_transform_obs(PJ *P, PJ_DIRECTION direction, size_t n, PJ_OBS *obs)
Batch transform an array of :c:type:`PJ_OBS`.
:param PJ* P:
:param `direction`: Transformation direction
- :type `direction`: enum proj_direction
+ :type `direction`: PJ_DIRECTION
:param size_t n: Number of observations in :c:data:`obs`
:returns: :c:type:`size_t` 0 if all observations are transformed without error, otherwise returns error number
@@ -426,7 +429,7 @@ Distances
Various
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-.. c:function:: double proj_roundtrip(PJ *P, enum proj_direction direction, int n, PJ_OBS obs)
+.. c:function:: double proj_roundtrip(PJ *P, PJ_DIRECTION direction, int n, PJ_OBS obs)
Measure internal consistency of a given transformation. The function
performs :c:data:`n` round trip transformations starting in either
@@ -436,7 +439,7 @@ Various
:param PJ* P:
:param `direction`: Starting direction of transformation
- :type `direction`: enum proj_direction
+ :type `direction`: PJ_DIRECTION
:param int n: Number of roundtrip transformations
:param PJ_OBS obs: Input coordinate
:returns: :c:type:`double` Distance between original coordinate and the \