Copilot commented on code in PR #2529:
URL: https://github.com/apache/sedona/pull/2529#discussion_r3612236279
##########
python/sedona/spark/geopandas/base.py:
##########
@@ -712,19 +712,25 @@ def centroid(self):
return _delegate_to_geometry_column("centroid", self)
def concave_hull(self, ratio=0.0, allow_holes=False):
- """Return the concave hull of each geometry.
+ """Return a ``GeoSeries`` of geometries representing the concave hull
+ of vertices of each geometry.
- The concave hull of a geometry is a possibly concave geometry that
- encloses the input geometry.
+ A concave hull is a concave or convex `Polygon` containing all the
+ vertices in each geometry. For two vertices, the hull collapses to a
+ `LineString`; for one vertex, it collapses to a `Point`.
+
+ The hull is constructed by removing border triangles of the Delaunay
+ triangulation while their size is larger than the maximum edge length
+ ratio. The ratio is a fraction of the difference between the longest
+ and shortest edges in the triangulation.
Review Comment:
The docstring describes `ratio` as “a fraction of the difference between the
longest and shortest edges in the triangulation”, but Sedona passes `ratio`
directly to JTS `ConcaveHull.setMaximumEdgeLengthRatio(...)` (see
common/src/main/java/org/apache/sedona/common/Functions.java). This wording is
likely incorrect/misleading for users; consider aligning it with Sedona’s
existing ST_ConcaveHull docs (pctConvex/max edge length ratio in [0, 1]).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
