geopandas.sjoin
How GeoPandas runs Spatial join: geopandas.sjoin.
| Engine | GeoPandas |
|---|---|
| Tool name | geopandas.sjoin |
| Interface | python |
| Implements | Spatial join |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
left_df | any | yes | Not stated | Not stated | Not stated |
right_df | any | yes | Not stated | Not stated | Not stated |
how | string | no | inner | Not stated | Not stated |
predicate | string | no | intersects | Not stated | Not stated |
lsuffix | string | no | left | Not stated | Not stated |
rsuffix | string | no | right | Not stated | Not stated |
distance | any | no | Not stated | Not stated | Not stated |
on_attribute | any | no | Not stated | Not stated | Not stated |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
left | left_df | Not stated |
right | right_df | Not stated |
predicate | predicate | Not stated |
how | how | Not stated |
Differences from the operation
- Defaults to an inner join (unmatched left features dropped); Columbus defaults to left.
Harvested by the python-libs harvester from engine version
1.2.0. Names can change when an engine is harvested again.