You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sedona.apache.org by ji...@apache.org on 2023/05/20 09:06:18 UTC
[sedona] branch geodestic-distance updated: Update docs

This is an automated email from the ASF dual-hosted git repository.

jiayu pushed a commit to branch geodestic-distance
in repository https://gitbox.apache.org/repos/asf/sedona.git


The following commit(s) were added to refs/heads/geodestic-distance by this push:
     new e06f39f9 Update docs
e06f39f9 is described below

commit e06f39f9b46e11c5aec97bb2849946e97bba9e3f
Author: Jia Yu <ji...@apache.org>
AuthorDate: Sat May 20 02:06:12 2023 -0700

    Update docs
---
 docs/api/flink/Function.md | 4 ++--
 docs/api/sql/Function.md   | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/api/flink/Function.md b/docs/api/flink/Function.md
index 7733fadb..813ed1c1 100644
--- a/docs/api/flink/Function.md
+++ b/docs/api/flink/Function.md
@@ -280,7 +280,7 @@ FROM polygondf
 
 Introduction: Return the haversine / great-circle distance of A using a given earth radius (default radius: 6378137.0). Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` + `ST_Transform`. It is equivalent to PostGIS `ST_Distance(geography, use_spheroid=false)` and `ST_DistanceSphere` function and produces nearly identical results. It provides faster but less accurate result compared to `ST_DistanceSpheroid`.
 
-Geometry must be in EPSG:4326 (WGS84) projection and must be in lat/lon order. You can use ==ST_FlipCoordinates== to swap lat and lon.
+Geometry must be in EPSG:4326 (WGS84) projection and must be in lat/lon order. You can use ==ST_FlipCoordinates== to swap lat and lon. For non-point data, we first take the centroids of both geometries and then compute the distance.
 
 Format: `ST_DistanceSphere (A:geometry)`
 
@@ -306,7 +306,7 @@ Output: `544405.4459192449`
 
 Introduction: Return the geodesic distance of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` + `ST_Transform`. It is equivalent to PostGIS `ST_Distance(geography, use_spheroid=true)` and `ST_DistanceSpheroid` function and produces nearly identical results. It provides slower but more accurate result compared to `ST_DistanceSphere`.
 
-Geometry must be in EPSG:4326 (WGS84) projection and must be in ==lat/lon== order. You can use ==ST_FlipCoordinates== to swap lat and lon.
+Geometry must be in EPSG:4326 (WGS84) projection and must be in ==lat/lon== order. You can use ==ST_FlipCoordinates== to swap lat and lon. For non-point data, we first take the centroids of both geometries and then compute the distance.
 
 Format: `ST_DistanceSpheroid (A:geometry)`
 
diff --git a/docs/api/sql/Function.md b/docs/api/sql/Function.md
index cbb39841..b8643268 100644
--- a/docs/api/sql/Function.md
+++ b/docs/api/sql/Function.md
@@ -418,7 +418,7 @@ FROM polygondf
 
 Introduction: Return the haversine / great-circle distance of A using a given earth radius (default radius: 6378137.0). Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` + `ST_Transform`. It is equivalent to PostGIS `ST_Distance(geography, use_spheroid=false)` and `ST_DistanceSphere` function and produces nearly identical results. It provides faster but less accurate result compared to `ST_DistanceSpheroid`.
 
-Geometry must be in EPSG:4326 (WGS84) projection and must be in lat/lon order. You can use ==ST_FlipCoordinates== to swap lat and lon.
+Geometry must be in EPSG:4326 (WGS84) projection and must be in ==lat/lon== order. You can use ==ST_FlipCoordinates== to swap lat and lon. For non-point data, we first take the centroids of both geometries and then compute the distance.
 
 Format: `ST_DistanceSphere (A:geometry)`
 
@@ -443,7 +443,7 @@ Output: `544405.4459192449`
 
 Introduction: Return the geodesic distance of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` + `ST_Transform`. It is equivalent to PostGIS `ST_Distance(geography, use_spheroid=true)` and `ST_DistanceSpheroid` function and produces nearly identical results. It provides slower but more accurate result compared to `ST_DistanceSphere`.
 
-Geometry must be in EPSG:4326 (WGS84) projection and must be in ==lat/lon== order. You can use ==ST_FlipCoordinates== to swap lat and lon.
+Geometry must be in EPSG:4326 (WGS84) projection and must be in ==lat/lon== order. You can use ==ST_FlipCoordinates== to swap lat and lon. For non-point data, we first take the centroids of both geometries and then compute the distance.
 
 Format: `ST_DistanceSpheroid (A:geometry)`