[1062] The function of geopandas.sjoin

ref: https://geopandas.org/en/stable/docs/reference/api/geopandas.sjoin.html

---

geopandas.sjoin

geopandas.sjoin(left_df, right_df, how='inner', predicate='intersects', lsuffix='left', rsuffix='right', distance=None, on_attribute=None, **kwargs)

Spatial join of two GeoDataFrames.

See the User Guide page Merging data for details.

Parameters:

left_df, right_dfGeoDataFrames

howstring, default ‘inner’

The type of join:

• ‘left’: use keys from left_df; retain only left_df geometry column

• ‘right’: use keys from right_df; retain only right_df geometry column

• ‘inner’: use intersection of keys from both dfs; retain only left_df geometry column

predicatestring, default ‘intersects’

Binary predicate. Valid values are determined by the spatial index used. You can check the valid values in left_df or right_df as left_df.sindex.valid_query_predicates or right_df.sindex.valid_query_predicates Replaces deprecated op parameter.

lsuffixstring, default ‘left’

Suffix to apply to overlapping column names (left GeoDataFrame).

rsuffixstring, default ‘right’

Suffix to apply to overlapping column names (right GeoDataFrame).

distancenumber or array_like, optional

Distance(s) around each input geometry within which to query the tree for the ‘dwithin’ predicate. If array_like, must be one-dimesional with length equal to length of left GeoDataFrame. Required if predicate='dwithin'.

on_attributestring, list or tuple

Column name(s) to join on as an additional join restriction on top of the spatial predicate. These must be found in both DataFrames. If set, observations are joined only if the predicate applies and values in specified columns match.