From 4b4ec85c4d88a895b31b56e4a3577da5a2290c98 Mon Sep 17 00:00:00 2001 From: Daniel Sparing Date: Sat, 13 Jan 2024 14:12:19 +0100 Subject: [PATCH] fix docstring so that edgeratio=0 is not boundingbox --- python/mosaic/api/functions.py | 14 +++++++------- .../expressions/geometry/ST_ConcaveHull.scala | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/python/mosaic/api/functions.py b/python/mosaic/api/functions.py index 47c2e75df..9819caa5f 100644 --- a/python/mosaic/api/functions.py +++ b/python/mosaic/api/functions.py @@ -159,13 +159,13 @@ def st_concavehull(geom: ColumnOrName, concavity: ColumnOrName, has_holes: Any = """ Compute the concave hull of a geometry or multi-geometry object. It uses lengthRatio and - allowHoles to determine the concave hull. lengthRatio is the ratio of the - length of the concave hull to the length of the convex hull. If set to 1, - this is the same as the convex hull. If set to 0, this is the same as the - bounding box. AllowHoles is a boolean that determines whether the concave - hull can have holes. If set to true, the concave hull can have holes. If set - to false, the concave hull will not have holes. (For PostGIS, the default is - false.) + allowHoles to determine the concave hull. lengthRatio is the fraction of the + difference between the longest and shortest edge lengths in the Delaunay + Triangulation. If set to 1, this is the same as the convex hull. If set to + 0, it produces produces maximum concaveness. AllowHoles is a boolean that + determines whether the concave hull can have holes. If set to true, the + concave hull can have holes. If set to false, the concave hull will not have + holes. (For PostGIS, the default is false.) Parameters ---------- diff --git a/src/main/scala/com/databricks/labs/mosaic/expressions/geometry/ST_ConcaveHull.scala b/src/main/scala/com/databricks/labs/mosaic/expressions/geometry/ST_ConcaveHull.scala index 6bf602a5b..0a4cc88d5 100644 --- a/src/main/scala/com/databricks/labs/mosaic/expressions/geometry/ST_ConcaveHull.scala +++ b/src/main/scala/com/databricks/labs/mosaic/expressions/geometry/ST_ConcaveHull.scala @@ -12,13 +12,13 @@ import org.apache.spark.sql.types.DataType /** * Returns the concave hull for a given geometry. It uses lengthRatio and - * allowHoles to determine the concave hull. lengthRatio is the ratio of the - * length of the concave hull to the length of the convex hull. If set to 1, - * this is the same as the convex hull. If set to 0, this is the same as the - * bounding box. AllowHoles is a boolean that determines whether the concave - * hull can have holes. If set to true, the concave hull can have holes. If set - * to false, the concave hull will not have holes. (For PostGIS, the default is - * false.) + * allowHoles to determine the concave hull. lengthRatio is the fraction of the + * difference between the longest and shortest edge lengths in the Delaunay + * Triangulation. If set to 1, this is the same as the convex hull. If set to + * 0, it produces produces maximum concaveness. AllowHoles is a boolean that + * determines whether the concave hull can have holes. If set to true, the + * concave hull can have holes. If set to false, the concave hull will not have + * holes. (For PostGIS, the default is false.) * @param inputGeom * The input geometry. * @param expressionConfig