geopandas.clip
How GeoPandas runs Clip: geopandas.clip.
| Engine | GeoPandas |
|---|---|
| Tool name | geopandas.clip |
| Interface | python |
| Implements | Clip |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
gdf | any | yes | Not stated | Not stated | Not stated |
mask | any | yes | Not stated | Not stated | Not stated |
keep_geom_type | boolean | no | no | Not stated | Not stated |
sort | boolean | no | no | Not stated | Not stated |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
layer | gdf | Not stated |
mask | mask | Not stated |
Differences from the operation
- The mask may also be a shapely geometry or a bounding box.
Harvested by the python-libs harvester from engine version
1.2.0. Names can change when an engine is harvested again.