Skip to content

[GH-2504] Geopandas: Implement force_3d #2512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jiayuasu merged 5 commits into from
Dec 4, 2025
Merged

[GH-2504] Geopandas: Implement force_3d #2512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e9fe11a
initial draft for force 3d
chay0112 Nov 18, 2025
c0ee218
refactored test cases
chay0112 Nov 20, 2025
9d62bad
addressed testcases and few nits
chay0112 Nov 20, 2025
819a3ee
modified tests according to changes in source code
chay0112 Nov 24, 2025
52f268b
Refactored the structure of tests
chay0112 Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 64 additions & 2 deletions python/sedona/spark/geopandas/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -949,8 +949,70 @@ def force_2d(self):
"""
return _delegate_to_geometry_column("force_2d", self)

# def force_3d(self, z=0):
# raise NotImplementedError("This method is not implemented yet.")
def force_3d(self, z=0.0):
"""Force the dimensionality of a geometry to 3D.

2D geometries will get the provided Z coordinate; 3D geometries
are unchanged (unless their Z coordinate is ``np.nan``).
Comment on lines +955 to +956
Copy link
Collaborator

@petern48 petern48 Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a test for this in test_geoseries.py? I see that this is from the original geopandas docstring, so I'm not entirely sure if we follow the same behavior naturally in Sedona. If we don't let me know, and we can figure out what to do next.

We could test something like whether Point(1, 1, np.nan) becomes Point(1, 1, 3) when calling .force_3d(3)

Copy link
Collaborator

@petern48 petern48 Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
are unchanged (unless their Z coordinate is ``np.nan``).
are unchanged (unless their Z coordinate is ``np.nan``).
Note: Sedona's behavior may differ from Geopandas' for M and ZM geometries.
For M geometries, Sedona will replace the M coordinate and add the Z coordinate.
For ZM geometries, Sedona will drop the M coordinate and retain the Z coordinate.


Note: Sedona's behavior may differ from Geopandas' for M and ZM geometries.
For M geometries, Sedona will replace the M coordinate and add the Z coordinate.
For ZM geometries, Sedona will drop the M coordinate and retain the Z coordinate.

Parameters
----------
z : float | array_like (default 0)
Z coordinate to be assigned

Returns
-------
GeoSeries

Examples
--------
>>> from shapely import Polygon, LineString, Point
>>> from sedona.spark.geopandas import GeoSeries
>>> s = GeoSeries(
... [
... Point(1, 2),
... Point(0.5, 2.5, 2),
... LineString([(1, 1), (0, 1), (1, 0)]),
... Polygon([(0, 0), (0, 10), (10, 10)]),
... ],
... )
>>> s
0 POINT (1 2)
1 POINT Z (0.5 2.5 2)
2 LINESTRING (1 1, 0 1, 1 0)
3 POLYGON ((0 0, 0 10, 10 10, 0 0))
dtype: geometry

>>> s.force_3d()
0 POINT Z (1 2 0)
1 POINT Z (0.5 2.5 2)
2 LINESTRING Z (1 1 0, 0 1 0, 1 0 0)
3 POLYGON Z ((0 0 0, 0 10 0, 10 10 0, 0 0 0))
dtype: geometry

Z coordinate can be specified as scalar:

>>> s.force_3d(4)
0 POINT Z (1 2 4)
1 POINT Z (0.5 2.5 2)
2 LINESTRING Z (1 1 4, 0 1 4, 1 0 4)
3 POLYGON Z ((0 0 4, 0 10 4, 10 10 4, 0 0 4))
dtype: geometry

Or as an array-like (one value per geometry):

>>> s.force_3d(range(4))
0 POINT Z (1 2 0)
1 POINT Z (0.5 2.5 2)
2 LINESTRING Z (1 1 2, 0 1 2, 1 0 2)
3 POLYGON Z ((0 0 3, 0 10 3, 10 10 3, 0 0 3))
dtype: geometry
"""
return _delegate_to_geometry_column("force_3d", self, z)

# def line_merge(self, directed=False):
# raise NotImplementedError("This method is not implemented yet.")
Expand Down
14 changes: 11 additions & 3 deletions python/sedona/spark/geopandas/geoseries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1093,9 +1093,17 @@ def force_2d(self) -> "GeoSeries":
spark_expr = stf.ST_Force_2D(self.spark.column)
return self._query_geometry_column(spark_expr, returns_geom=True)

def force_3d(self, z=0):
# Implementation of the abstract method.
raise NotImplementedError("This method is not implemented yet.")
def force_3d(self, z=0.0) -> "GeoSeries":
other_series, extended = self._make_series_of_val(z)
align = not extended

spark_expr = stf.ST_Force3D(F.col("L"), F.col("R"))
return self._row_wise_operation(
spark_expr,
other_series,
align=align,
returns_geom=True,
)

def line_merge(self, directed=False):
# Implementation of the abstract method.
Expand Down
90 changes: 89 additions & 1 deletion python/tests/geopandas/test_geoseries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1520,7 +1520,95 @@ def test_force_2d(self):
self.check_sgpd_equals_gpd(df_result, expected)

def test_force_3d(self):
pass
# 1. 2D geometries promoted to 3D with default z=0.0
s = sgpd.GeoSeries(
[
Point(1, 2),
Point(0.5, 2.5, 2),
Point(1, 1, np.nan),
LineString([(1, 1), (0, 1), (1, 0)]),
Polygon([(0, 0), (0, 10), (10, 10)]),
GeometryCollection(
[
Point(1, 1),
LineString([(1, 1), (0, 1), (1, 0)]),
]
),
]
)
# Promote 2D to 3D with z=0, keep 3D as is
expected = gpd.GeoSeries(
[
Point(1, 2, 0),
Point(0.5, 2.5, 2),
Point(1, 1, 0),
LineString([(1, 1, 0), (0, 1, 0), (1, 0, 0)]),
Polygon([(0, 0, 0), (0, 10, 0), (10, 10, 0), (0, 0, 0)]),
GeometryCollection(
[
Point(1, 1, 0),
LineString([(1, 1, 0), (0, 1, 0), (1, 0, 0)]),
]
),
]
)
result = s.force_3d()
self.check_sgpd_equals_gpd(result, expected)

# 2. 2D geometries promoted to 3D with scalar z
expected = gpd.GeoSeries(
[
Point(1, 2, 4),
Point(0.5, 2.5, 2),
Point(1, 1, 4),
LineString([(1, 1, 4), (0, 1, 4), (1, 0, 4)]),
Polygon([(0, 0, 4), (0, 10, 4), (10, 10, 4), (0, 0, 4)]),
GeometryCollection(
[
Point(1, 1, 4),
LineString([(1, 1, 4), (0, 1, 4), (1, 0, 4)]),
]
),
]
)
result = s.force_3d(4)
self.check_sgpd_equals_gpd(result, expected)

# 3. Array-like z: use ps.Series
z = [0, 2, 2, 3, 4, 5]
expected = gpd.GeoSeries(
[
Point(1, 2, 0),
Point(0.5, 2.5, 2),
Point(1, 1, 2),
LineString([(1, 1, 3), (0, 1, 3), (1, 0, 3)]),
Polygon([(0, 0, 4), (0, 10, 4), (10, 10, 4), (0, 0, 4)]),
GeometryCollection(
[
Point(1, 1, 5),
LineString([(1, 1, 5), (0, 1, 5), (1, 0, 5)]),
]
),
]
)
result = s.force_3d(z)
self.check_sgpd_equals_gpd(result, expected)
Copy link
Collaborator

@petern48 petern48 Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add these cases below?

ST_Force3D(st_geomfromtext('POINT M (1 2 3)'), 7.5)
-- Result: POINT Z(1 2 7.5)

ST_Force3D(st_geomfromtext('POINT ZM (1 2 3 4)'), 7.5)
-- Result: POINT Z(1 2 3)

Copy link
Collaborator

@petern48 petern48 Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For those curious about the difference in behavior, Geopandas returns the following instead. It's strange and inconsistent imo... I would guess it's unintentional and just a result of adding M support later on.

gpd.GeoSeries([shapely.wkt.loads("POINT M (1 2 3)")]).force_3d(7.5)
0    POINT M (1 2 3)

gpd.GeoSeries([shapely.wkt.loads("POINT ZM (1 2 3 4)")]).force_3d(7.5)
0    POINT Z (1 2 7.5)


# 4. Ensure M and ZM geometries are handled correctly
s = sgpd.GeoSeries(
[
shapely.wkt.loads("POINT M (1 2 3)"),
shapely.wkt.loads("POINT ZM (1 2 3 4)"),
]
)
result = s.force_3d(7.5)
expected = gpd.GeoSeries(
[
shapely.wkt.loads("POINT Z (1 2 7.5)"),
shapely.wkt.loads("POINT Z (1 2 3)"),
]
)
self.check_sgpd_equals_gpd(result, expected)

def test_line_merge(self):
pass
Expand Down
43 changes: 42 additions & 1 deletion python/tests/geopandas/test_match_geopandas_series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -878,7 +878,48 @@ def test_force_2d(self):
self.check_sgpd_equals_gpd(sgpd_3d, gpd_3d)

def test_force_3d(self):
pass
# force_3d was added from geopandas 1.0.0
if parse_version(gpd.__version__) < parse_version("1.0.0"):
pytest.skip("geopandas force_3d requires version 1.0.0 or higher")
# 1) Promote 2D to 3D with z = 4
for geom in self.geoms:
if isinstance(geom[0], (LinearRing)):
continue
sgpd_result = GeoSeries(geom).force_3d(4)
gpd_result = gpd.GeoSeries(geom).force_3d(4)
self.check_sgpd_equals_gpd(sgpd_result, gpd_result)

# 2) Minimal sample for various geometry types with custom z=7.5
data = [
Point(1, 2), # 2D
Point(0.5, 2.5, 2), # 3D (Z)
LineString([(1, 1), (0, 1), (1, 0)]), # 2D
Polygon([(0, 0), (0, 10), (10, 10)]), # 2D
]
sgpd_result = GeoSeries(data).force_3d(7.5)
gpd_result = gpd.GeoSeries(data).force_3d(7.5)
self.check_sgpd_equals_gpd(sgpd_result, gpd_result)

# 3) Array-like z tests
geoms = self.polygons
lst = list(range(1, len(geoms) + 1))

# Traditional python list
sgpd_result = GeoSeries(geoms).force_3d(lst)
gpd_result = gpd.GeoSeries(geoms).force_3d(lst)
self.check_sgpd_equals_gpd(sgpd_result, gpd_result)

# numpy array
np_array = np.array(lst)
sgpd_result = GeoSeries(geoms).force_3d(np_array)
gpd_result = gpd.GeoSeries(geoms).force_3d(np_array)
self.check_sgpd_equals_gpd(sgpd_result, gpd_result)

# pandas-on-Spark Series
psser = ps.Series(lst)
sgpd_result = GeoSeries(geoms).force_3d(psser)
gpd_result = gpd.GeoSeries(geoms).force_3d(psser.to_pandas())
self.check_sgpd_equals_gpd(sgpd_result, gpd_result)

def test_line_merge(self):
pass
Expand Down
Loading