GeoDataFrame.clip - Wherobots

Parameters

GeoDataFrame, GeoSeries, Polygon, MultiPolygon, or list-like

required

Polygonal mask, or four rectangle bounds. Distributed masks are dissolved into one geometry using ST_Union_Aggr.

bool

default:"False"

If True, retain only the input geometry family when clipping creates lower-dimensional geometries.

bool

default:"False"

If True, return matching rows in their original positional order.

Returns

GeoDataFrame or GeoSeries

Clipped data of the same type as the caller. Index values, non-geometry columns, active geometry, CRS, and SRID are preserved.

See also

GeoSeries.clip_by_rect

geopandas.clip

Sedona does not expose a separate fast ClipByBox operation. Four-value rectangle masks therefore use native ST_MakeEnvelope and ST_Intersection. Boundary-only intersections can consequently differ from GeoPandas’ fast, possibly dirty rectangle path.

Examples

>>> from sedona.spark.geopandas import GeoDataFrame
>>> from shapely.geometry import LineString, Point, box
>>> gdf = GeoDataFrame(
...     {
...         "name": ["line", "point"],
...         "geometry": [
...             LineString([(0, 0), (2, 2)]),
...             Point(3, 3),
...         ],
...     }
... )
>>> gdf.clip(box(0, 0, 1, 1))
   name               geometry
0  line  LINESTRING (0 0, 1 1)

Rectangle bounds can be supplied directly:

>>> gdf.geometry.clip((0, 0, 1, 1))
0    LINESTRING (0 0, 1 1)
Name: geometry, dtype: geometry

​Signature

​Parameters

​Returns

​Examples

Signature

Parameters

Returns

Examples