diff options
| author | Kristian Evers <kristianevers@gmail.com> | 2020-12-21 17:28:48 +0100 |
|---|---|---|
| committer | Kristian Evers <kristianevers@gmail.com> | 2020-12-21 17:28:48 +0100 |
| commit | 5aad0d25f8423b8b88a716d0333c7bd19f6184c7 (patch) | |
| tree | f0a248ef08fb51ef0ec29178ef41fd4168d4c85d /docs/source/development/reference/functions.rst | |
| parent | c3efbd23a5bf26f1dfd5bc55ae3488d5665ace98 (diff) | |
| parent | 1cafe3e602d3f697c8d2daaa9b634f3ad23b0d53 (diff) | |
| download | PROJ-5aad0d25f8423b8b88a716d0333c7bd19f6184c7.tar.gz PROJ-5aad0d25f8423b8b88a716d0333c7bd19f6184c7.zip | |
Merge remote-tracking branch 'osgeo/master'
Diffstat (limited to 'docs/source/development/reference/functions.rst')
| -rw-r--r-- | docs/source/development/reference/functions.rst | 36 |
1 files changed, 35 insertions, 1 deletions
diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst index b37eacdd..34fe59ed 100644 --- a/docs/source/development/reference/functions.rst +++ b/docs/source/development/reference/functions.rst @@ -195,6 +195,11 @@ paragraph for more details. If authority is a non-empty string different of ``any``, then coordinate operations will be searched only in that authority namespace (e.g ``EPSG``). + - ACCURACY=value: to set the minimum desired accuracy (in metres) of the + candidate coordinate operations. + + - ALLOW_BALLPARK=YES/NO: can be set to NO to disallow the use of + :term:`Ballpark transformation` in the candidate coordinate operations. .. doxygenfunction:: proj_normalize_for_visualization :project: doxygen_api @@ -368,13 +373,22 @@ Coordinate transformation Batch transform an array of :c:type:`PJ_COORD`. + Performs transformation on all points, even if errors occur on some points + (new to 8.0. Previous versions would exit early in case of failure on a given point) + + Individual points that fail to transform will have their components set to + ``HUGE_VAL`` + :param P: Transformation object :type P: :c:type:`PJ` * :param `direction`: Transformation direction. :type `direction`: PJ_DIRECTION :param n: Number of coordinates in :c:data:`coord` :type n: `size_t` - :returns: `int` 0 if all observations are transformed without error, otherwise returns error number + :returns: `int` 0 if all observations are transformed without error, otherwise returns error number. + This error number will be a precise error number if all coordinates that fail to transform + for the same reason, or a generic error code if they fail for different + reasons. Error reporting @@ -388,6 +402,8 @@ Error reporting context is read. A text representation of the error number can be retrieved with :c:func:`proj_errno_string`. + Consult :ref:`error_codes` for the list of error codes (PROJ >= 8.0) + :param P: Transformation object :type P: :c:type:`PJ` * @@ -400,6 +416,8 @@ Error reporting transformation. A text representation of the error number can be retrieved with :c:func:`proj_errno_string`. + Consult :ref:`error_codes` for the list of error codes (PROJ >= 8.0) + :param ctx: threading context. :type ctx: :c:type:`PJ_CONTEXT` * @@ -464,6 +482,22 @@ Error reporting Get a text representation of an error number. + .. deprecated:: This function is potentially thread-unsafe, replaced by :c:func:`proj_context_errno_string`. + + :param err: Error number. + :type err: `int` + + :returns: `const char*` String with description of error. + +.. c:function:: const char* proj_context_errno_string(PJ_CONTEXT* ctx, int err) + + .. versionadded:: 8.0.0 + + Get a text representation of an error number. + + :param ctx: threading context. + :type ctx: :c:type:`PJ_CONTEXT` * + :param err: Error number. :type err: `int` |
