gdf.pc.clip() or PointCloud.clip()

gdf.pc.clip() or PointCloud.clip()#

GeometryPointCloudBase.clip(mask, keep_geom_type=False, sort=False, mp_config=None)[source]#

Remove points outside an exact clipping geometry.

Parameters:

  • mask (Any) – Clipping geometry, vector, point cloud, raster or bounding box. Georeferenced masks are reprojected to this point cloud’s CRS.

  • keep_geom_type (bool) – Whether to remove intersections with a different geometry type than the input.

  • sort (bool) – Whether to sort clipped points by their original index within each partition.

  • mp_config (MultiprocConfig | None) – Worker configuration with an integer number of points per chunk. The output format is inferred from outfile or selected by driver (GPKG, LAS or LAZ), defaulting to GeoPackage. Cannot be combined with a Dask input.

Return type:

GeometryPointCloudBaseType | GeoDataFrame

Returns:

Clipped PointCloud or GeoDataFrame matching the input interface. Dask GeoDataFrame results stay lazy, and multiprocessing PointCloud results are unloaded.