GeoDataFrame.sjoin_nearest
How GeoPandas runs Nearest Join: geopandas.GeoDataFrame.sjoin_nearest.
| Engine | GeoPandas |
|---|---|
| Tool name | geopandas.GeoDataFrame.sjoin_nearest |
| Interface | python |
| Implements | Nearest Join |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
right | GeoDataFrame | yes | Not stated | Not stated | Not stated |
how | Literal['left', 'right', 'inner'] | no | inner | Not stated | Not stated |
max_distance | float | None | no | Not stated | Not stated | Not stated |
lsuffix | str | no | left | Not stated | Not stated |
rsuffix | str | no | right | Not stated | Not stated |
distance_col | str | None | no | Not stated | Not stated | Not stated |
exclusive | bool | no | no | Not stated | Not stated |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
right | right | Not stated |
max_distance | max_distance | Not stated |
distance_field | distance_col | Not stated |
how | how | Not stated |
Differences from the operation
- Called on the left GeoDataFrame; defaults to an inner join.
Harvested by the python-libs harvester from engine version
1.2.0. Names can change when an engine is harvested again.