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 2024/05/29 03:01:50 UTC
(sedona) 01/03: [TASK-278] Add ST_PointM (#145)
This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch SEDONA-569
in repository https://gitbox.apache.org/repos/asf/sedona.git
commit 7a01d86d106119811323dd67d921f4dbfd79e2ca
Author: Pranav Toggi <pr...@gmail.com>
AuthorDate: Mon Apr 1 00:15:03 2024 -0400
[TASK-278] Add ST_PointM (#145)
* init
* Implement ST_PointM
* Update docs
* remove snowflake test
* update snowflake docs
* Remove snowflake registration for ST_PointM
* Add dataframe api tests
* fix test
* fix test
---
.../org/apache/sedona/common/Constructors.java | 14 ++++++++++++
.../org/apache/sedona/common/ConstructorsTest.java | 9 ++++++++
docs/api/flink/Constructor.md | 25 ++++++++++++++++++++++
docs/api/sql/Constructor.md | 25 ++++++++++++++++++++++
.../main/java/org/apache/sedona/flink/Catalog.java | 1 +
.../sedona/flink/expressions/Constructors.java | 12 +++++++++++
.../org/apache/sedona/flink/ConstructorTest.java | 25 ++++++++++++++++++++++
python/sedona/sql/st_constructors.py | 18 ++++++++++++++++
python/tests/sql/test_constructor_test.py | 4 ++++
python/tests/sql/test_dataframe_api.py | 1 +
.../scala/org/apache/sedona/sql/UDF/Catalog.scala | 1 +
.../sql/sedona_sql/expressions/Constructors.scala | 13 +++++++++++
.../sedona_sql/expressions/st_constructors.scala | 10 +++++++++
.../apache/sedona/sql/constructorTestScala.scala | 10 +++++++++
.../apache/sedona/sql/dataFrameAPITestScala.scala | 8 +++++++
15 files changed, 176 insertions(+)
diff --git a/common/src/main/java/org/apache/sedona/common/Constructors.java b/common/src/main/java/org/apache/sedona/common/Constructors.java
index 0d28c1405..7ee0e0650 100644
--- a/common/src/main/java/org/apache/sedona/common/Constructors.java
+++ b/common/src/main/java/org/apache/sedona/common/Constructors.java
@@ -136,6 +136,20 @@ public class Constructors {
return geometryFactory.createPoint(new Coordinate(x, y, z));
}
+ /**
+ * Creates a point from the given coordinate.
+ *
+ * @param x the x value
+ * @param y the y value
+ * @param m the m value
+ * @param srid Set to 0 if unknown
+ * @return The point geometry
+ */
+ public static Geometry pointM(double x, double y, double m, int srid) {
+ GeometryFactory geometryFactory = new GeometryFactory(new PrecisionModel(), srid);
+ return geometryFactory.createPoint(new CoordinateXYZM(x, y, 0, m));
+ }
+
/**
* Creates a point from the given coordinate.
*
diff --git a/common/src/test/java/org/apache/sedona/common/ConstructorsTest.java b/common/src/test/java/org/apache/sedona/common/ConstructorsTest.java
index a9abb84de..7abbcb306 100644
--- a/common/src/test/java/org/apache/sedona/common/ConstructorsTest.java
+++ b/common/src/test/java/org/apache/sedona/common/ConstructorsTest.java
@@ -144,6 +144,15 @@ public class ConstructorsTest {
assertEquals("POINT Z(0 1 2)", Functions.asWKT(point));
}
+ @Test
+ public void pointM() {
+ Geometry point = Constructors.pointM(0.0d, 1.0d, 2.0d, 4326);
+
+ assertTrue(point instanceof Point);
+ assertEquals(4326, point.getSRID());
+ assertEquals("SRID=4326;POINT ZM(0 1 0 2)", Functions.asEWKT(point));
+ }
+
@Test
public void pointZM() {
Geometry point = Constructors.pointZM(0.0d, 1.0d, 2.0d, 10.0, 4326);
diff --git a/docs/api/flink/Constructor.md b/docs/api/flink/Constructor.md
index a2d717b70..762f5ef55 100644
--- a/docs/api/flink/Constructor.md
+++ b/docs/api/flink/Constructor.md
@@ -480,6 +480,31 @@ Output:
POINT Z(1.2345 2.3456 3.4567)
```
+## ST_PointM
+
+Introduction: Construct a Point from X, Y and M and an optional srid. If srid is not set, it defaults to 0 (unknown).
+Must use ST_AsEWKT function to print the Z and M coordinates.
+
+Format:
+
+`ST_PointM (X: Double, Y: Double, M: Double)`
+
+`ST_PointM (X: Double, Y: Double, M: Double, srid: Integer)`
+
+Since: `vTBD`
+
+Example:
+
+```sql
+SELECT ST_AsEWKT(ST_PointM(1.2345, 2.3456, 3.4567))
+```
+
+Output:
+
+```
+POINT ZM(1.2345 2.3456 0 3.4567)
+```
+
## ST_PointZM
Introduction: Construct a Point from X, Y, Z, M and an optional srid. If srid is not set, it defaults to 0 (unknown).
diff --git a/docs/api/sql/Constructor.md b/docs/api/sql/Constructor.md
index 901063402..e1b8d4d20 100644
--- a/docs/api/sql/Constructor.md
+++ b/docs/api/sql/Constructor.md
@@ -542,6 +542,31 @@ Output:
POINT Z(1.2345 2.3456 3.4567)
```
+## ST_PointM
+
+Introduction: Construct a Point from X, Y and M and an optional srid. If srid is not set, it defaults to 0 (unknown).
+Must use ST_AsEWKT function to print the Z and M coordinates.
+
+Format:
+
+`ST_PointM (X: Double, Y: Double, M: Double)`
+
+`ST_PointM (X: Double, Y: Double, M: Double, srid: Integer)`
+
+Since: `vTBD`
+
+Example:
+
+```sql
+SELECT ST_AsEWKT(ST_PointM(1.2345, 2.3456, 3.4567))
+```
+
+Output:
+
+```
+POINT ZM(1.2345 2.3456 0 3.4567)
+```
+
## ST_PointZM
Introduction: Construct a Point from X, Y, Z, M and an optional srid. If srid is not set, it defaults to 0 (unknown).
diff --git a/flink/src/main/java/org/apache/sedona/flink/Catalog.java b/flink/src/main/java/org/apache/sedona/flink/Catalog.java
index 101037435..4ff5d5c97 100644
--- a/flink/src/main/java/org/apache/sedona/flink/Catalog.java
+++ b/flink/src/main/java/org/apache/sedona/flink/Catalog.java
@@ -24,6 +24,7 @@ public class Catalog {
new Aggregators.ST_Union_Aggr(),
new Constructors.ST_Point(),
new Constructors.ST_PointZ(),
+ new Constructors.ST_PointM(),
new Constructors.ST_PointZM(),
new Constructors.ST_PointFromText(),
new Constructors.ST_MakePoint(),
diff --git a/flink/src/main/java/org/apache/sedona/flink/expressions/Constructors.java b/flink/src/main/java/org/apache/sedona/flink/expressions/Constructors.java
index a4ce11727..ed017b454 100644
--- a/flink/src/main/java/org/apache/sedona/flink/expressions/Constructors.java
+++ b/flink/src/main/java/org/apache/sedona/flink/expressions/Constructors.java
@@ -54,6 +54,18 @@ public class Constructors {
}
}
+ public static class ST_PointM extends ScalarFunction {
+ @DataTypeHint(value = "RAW", bridgedTo = org.locationtech.jts.geom.Geometry.class)
+ public Geometry eval(@DataTypeHint("Double") Double x, @DataTypeHint("Double") Double y, @DataTypeHint("Double") Double m) throws ParseException {
+ return eval(x, y, m, 0);
+ }
+
+ @DataTypeHint(value = "RAW", bridgedTo = org.locationtech.jts.geom.Geometry.class)
+ public Geometry eval(@DataTypeHint("Double") Double x, @DataTypeHint("Double") Double y, @DataTypeHint("Double") Double m, @DataTypeHint("Integer") Integer srid) throws ParseException {
+ return org.apache.sedona.common.Constructors.pointM(x, y, m, srid);
+ }
+ }
+
public static class ST_PointZM extends ScalarFunction {
@DataTypeHint(value = "RAW", bridgedTo = org.locationtech.jts.geom.Geometry.class)
public Geometry eval(@DataTypeHint("Double") Double x, @DataTypeHint("Double") Double y, @DataTypeHint("Double") Double z, @DataTypeHint("Double") Double m) throws ParseException {
diff --git a/flink/src/test/java/org/apache/sedona/flink/ConstructorTest.java b/flink/src/test/java/org/apache/sedona/flink/ConstructorTest.java
index 811ab6f81..d78c84f64 100644
--- a/flink/src/test/java/org/apache/sedona/flink/ConstructorTest.java
+++ b/flink/src/test/java/org/apache/sedona/flink/ConstructorTest.java
@@ -99,6 +99,31 @@ public class ConstructorTest extends TestBase{
assertEquals(5.0, result.getCoordinate().getZ(), 1e-6);
}
+ @Test
+ public void testPointM() {
+ List<Row> data = new ArrayList<>();
+ data.add(Row.of(2.0, 2.0, 5.0, "point"));
+ String[] colNames = new String[]{"x", "y", "m", "name_point"};
+
+ TypeInformation<?>[] colTypes = {
+ BasicTypeInfo.DOUBLE_TYPE_INFO,
+ BasicTypeInfo.DOUBLE_TYPE_INFO,
+ BasicTypeInfo.DOUBLE_TYPE_INFO,
+ BasicTypeInfo.STRING_TYPE_INFO};
+ RowTypeInfo typeInfo = new RowTypeInfo(colTypes, colNames);
+ DataStream<Row> ds = env.fromCollection(data).returns(typeInfo);
+ Table pointTable = tableEnv.fromDataStream(ds);
+
+ Table geomTable = pointTable
+ .select(call(Constructors.ST_PointM.class.getSimpleName(), $(colNames[0]), $(colNames[1]), $(colNames[2]))
+ .as(colNames[3]));
+
+ Point result = first(geomTable)
+ .getFieldAs(colNames[3]);
+
+ assertEquals(5.0, result.getCoordinate().getM(), 1e-6);
+ }
+
@Test
public void testPointZM() {
List<Row> data = new ArrayList<>();
diff --git a/python/sedona/sql/st_constructors.py b/python/sedona/sql/st_constructors.py
index d73be2260..be011b9c7 100644
--- a/python/sedona/sql/st_constructors.py
+++ b/python/sedona/sql/st_constructors.py
@@ -205,6 +205,24 @@ def ST_PointZ(x: ColumnOrNameOrNumber, y: ColumnOrNameOrNumber, z: ColumnOrNameO
args = (x, y, z) if srid is None else (x, y, z, srid)
return _call_constructor_function("ST_PointZ", args)
+@validate_argument_types
+def ST_PointM(x: ColumnOrNameOrNumber, y: ColumnOrNameOrNumber, m: ColumnOrNameOrNumber, srid: Optional[ColumnOrNameOrNumber] = None) -> Column:
+ """Generates a 3D point geometry column from numeric values.
+
+ :param x: Either a number or numeric column representing the X coordinate of a point.
+ :type x: ColumnOrNameOrNumber
+ :param y: Either a number or numeric column representing the Y coordinate of a point.
+ :type y: ColumnOrNameOrNumber
+ :param z: Either a number or numeric column representing the Z coordinate of a point, if None then a 2D point is generated, defaults to None
+ :type z: ColumnOrNameOrNumber
+ :param srid: The srid of the point. Defaults to 0 (unknown).
+ :type srid: Optional[ColumnOrNameOrNumber], optional
+ :return: Point geometry column generated from the coordinate values.
+ :rtype: Column
+ """
+ args = (x, y, m) if srid is None else (x, y, m, srid)
+ return _call_constructor_function("ST_PointM", args)
+
@validate_argument_types
def ST_PointZM(x: ColumnOrNameOrNumber, y: ColumnOrNameOrNumber, z: ColumnOrNameOrNumber, m: ColumnOrNameOrNumber,srid: Optional[ColumnOrNameOrNumber] = None) -> Column:
"""Generates a 3D point geometry column from numeric values.
diff --git a/python/tests/sql/test_constructor_test.py b/python/tests/sql/test_constructor_test.py
index 2180972cd..cdcf114da 100644
--- a/python/tests/sql/test_constructor_test.py
+++ b/python/tests/sql/test_constructor_test.py
@@ -37,6 +37,10 @@ class TestConstructors(TestBase):
point_df = self.spark.sql("SELECT ST_PointZ(1.2345, 2.3456, 3.4567)")
assert point_df.count() == 1
+ def test_st_point_m(self):
+ point_df = self.spark.sql("SELECT ST_PointM(1.2345, 2.3456, 3.4567)")
+ assert point_df.count() == 1
+
def test_st_makepoint(self):
point_csv_df = self.spark.read.format("csv").\
option("delimiter", ",").\
diff --git a/python/tests/sql/test_dataframe_api.py b/python/tests/sql/test_dataframe_api.py
index e193efa1a..f82f2f4fc 100644
--- a/python/tests/sql/test_dataframe_api.py
+++ b/python/tests/sql/test_dataframe_api.py
@@ -58,6 +58,7 @@ test_configurations = [
(stc.ST_MPolyFromText, ("mpoly", 4326), "constructor", "" , "MULTIPOLYGON (((0 0, 20 0, 20 20, 0 20, 0 0), (5 5, 5 7, 7 7, 7 5, 5 5)))"),
(stc.ST_MLineFromText, ("mline", ), "constructor", "" , "MULTILINESTRING ((1 2, 3 4), (4 5, 6 7))"),
(stc.ST_MLineFromText, ("mline", 4326), "constructor", "" , "MULTILINESTRING ((1 2, 3 4), (4 5, 6 7))"),
+ (stc.ST_PointM, ("x", "y", "m", "srid"), "x_y_z_m_srid", "ST_AsEWKT(geom)", "SRID=4326;POINT ZM(1 2 0 100.9)"),
(stc.ST_PointZM, ("x", "y", "z", "m", "srid"), "x_y_z_m_srid", "", "POINT Z (1 2 3)"),
(stc.ST_PointFromText, ("single_point", lambda: f.lit(',')), "constructor", "", "POINT (0 1)"),
(stc.ST_MakePoint, ("x", "y", "z"), "constructor", "", "POINT Z (0 1 2)"),
diff --git a/spark/common/src/main/scala/org/apache/sedona/sql/UDF/Catalog.scala b/spark/common/src/main/scala/org/apache/sedona/sql/UDF/Catalog.scala
index 6de69808e..4067f8ade 100644
--- a/spark/common/src/main/scala/org/apache/sedona/sql/UDF/Catalog.scala
+++ b/spark/common/src/main/scala/org/apache/sedona/sql/UDF/Catalog.scala
@@ -53,6 +53,7 @@ object Catalog {
function[ST_Point](),
function[ST_MakePoint](null, null),
function[ST_PointZ](0),
+ function[ST_PointM](0),
function[ST_PointZM](0),
function[ST_PolygonFromEnvelope](),
function[ST_Contains](),
diff --git a/spark/common/src/main/scala/org/apache/spark/sql/sedona_sql/expressions/Constructors.scala b/spark/common/src/main/scala/org/apache/spark/sql/sedona_sql/expressions/Constructors.scala
index 1f4966dd9..016b68253 100644
--- a/spark/common/src/main/scala/org/apache/spark/sql/sedona_sql/expressions/Constructors.scala
+++ b/spark/common/src/main/scala/org/apache/spark/sql/sedona_sql/expressions/Constructors.scala
@@ -246,6 +246,19 @@ case class ST_PointZ(inputExpressions: Seq[Expression])
}
}
+/**
+ * Return a Point from X, Y, M and srid
+ *
+ * @param inputExpressions This function takes 4 parameter which are point x, y, m and srid (default 0).
+ */
+case class ST_PointM(inputExpressions: Seq[Expression])
+ extends InferredExpression(Constructors.pointM _) {
+
+ protected def withNewChildrenInternal(newChildren: IndexedSeq[Expression]) = {
+ copy(inputExpressions = newChildren)
+ }
+}
+
case class ST_PointZM(inputExpressions: Seq[Expression])
extends InferredExpression(Constructors.pointZM _) {
diff --git a/spark/common/src/main/scala/org/apache/spark/sql/sedona_sql/expressions/st_constructors.scala b/spark/common/src/main/scala/org/apache/spark/sql/sedona_sql/expressions/st_constructors.scala
index 51eaadab9..7b7fda1c6 100644
--- a/spark/common/src/main/scala/org/apache/spark/sql/sedona_sql/expressions/st_constructors.scala
+++ b/spark/common/src/main/scala/org/apache/spark/sql/sedona_sql/expressions/st_constructors.scala
@@ -81,6 +81,16 @@ object st_constructors extends DataFrameAPI {
def ST_PointZ(x: Double, y: Double, z: Double, srid: Int): Column = wrapExpression[ST_PointZ](x, y, z, srid)
+ def ST_PointM(x: Column, y: Column, m: Column): Column = wrapExpression[ST_PointM](x, y, m, 0)
+ def ST_PointM(x: String, y: String, m: String): Column = wrapExpression[ST_PointM](x, y, m, 0)
+ def ST_PointM(x: Double, y: Double, m: Double): Column = wrapExpression[ST_PointM](x, y, m, 0)
+
+ def ST_PointM(x: Column, y: Column, m: Column, srid: Column): Column = wrapExpression[ST_PointM](x, y, m, srid)
+
+ def ST_PointM(x: String, y: String, m: String, srid: Column): Column = wrapExpression[ST_PointM](x, y, m, srid)
+
+ def ST_PointM(x: Double, y: Double, m: Double, srid: Int): Column = wrapExpression[ST_PointM](x, y, m, srid)
+
def ST_PointZM(x: Column, y: Column, z: Column, m: Column): Column = wrapExpression[ST_PointZM](x, y, z, m, 0)
def ST_PointZM(x: String, y: String, z: String, m: String): Column = wrapExpression[ST_PointZM](x, y, z, m, 0)
def ST_PointZM(x: Double, y: Double, z: Double, m: Double): Column = wrapExpression[ST_PointZM](x, y, z, m, 0)
diff --git a/spark/common/src/test/scala/org/apache/sedona/sql/constructorTestScala.scala b/spark/common/src/test/scala/org/apache/sedona/sql/constructorTestScala.scala
index c77a392c3..aa822c6f5 100644
--- a/spark/common/src/test/scala/org/apache/sedona/sql/constructorTestScala.scala
+++ b/spark/common/src/test/scala/org/apache/sedona/sql/constructorTestScala.scala
@@ -86,6 +86,16 @@ class constructorTestScala extends TestBaseScala {
assert(pointDf.count() == 1)
}
+ it("Passed ST_PointM") {
+ val pointDf = sparkSession.sql("SELECT ST_PointM(1.2345, 2.3456, 3.4567)")
+ assert(pointDf.count() == 1)
+ }
+
+ it("Passed ST_PointM null safety") {
+ val pointDf = sparkSession.sql("SELECT ST_PointM(null, null, null)")
+ assert(pointDf.count() == 1)
+ }
+
it("Passed ST_PolygonFromEnvelope") {
val polygonDF = sparkSession.sql("select ST_PolygonFromEnvelope(double(1.234),double(2.234),double(3.345),double(3.345))")
assert(polygonDF.count() == 1)
diff --git a/spark/common/src/test/scala/org/apache/sedona/sql/dataFrameAPITestScala.scala b/spark/common/src/test/scala/org/apache/sedona/sql/dataFrameAPITestScala.scala
index 842fc0e70..619c2017e 100644
--- a/spark/common/src/test/scala/org/apache/sedona/sql/dataFrameAPITestScala.scala
+++ b/spark/common/src/test/scala/org/apache/sedona/sql/dataFrameAPITestScala.scala
@@ -58,6 +58,14 @@ class dataFrameAPITestScala extends TestBaseScala {
assert(actual == 40.0)
}
+ it("Passed st_pointm") {
+ val pointDf = sparkSession.sql("SELECT ST_PointM(1,2,100) as point1, ST_PointM(1,2,100,4326) as point2")
+ val point1 = pointDf.select(ST_AsEWKT("point1")).take(1)(0).getString(0)
+ val point2 = pointDf.select(ST_AsEWKT("point2")).take(1)(0).getString(0)
+ assertEquals("POINT ZM(1 2 0 100)", point1)
+ assertEquals("SRID=4326;POINT ZM(1 2 0 100)", point2)
+ }
+
it("passed st_makepoint") {
val df = sparkSession.sql("SELECT 0.0 AS x, 1.0 AS y, 2.0 AS z").select(ST_AsText(ST_MakePoint("x", "y", "z")))
val actualResult = df.take(1)(0).get(0).asInstanceOf[String]