momepy.SharedWallsRatio

class momepy.SharedWallsRatio(gdf, unique_id=None, perimeters=None)

Calculate shared walls ratio of adjacent elements (typically buildings)

\[\textit{length of shared walls} \over perimeter\]

Note that data needs to be topologically correct. Overlapping polygons will lead to incorrect results.

Adapted from [HLM12].

Parameters

gdfGeoDataFrame

GeoDataFrame containing gdf to analyse

unique_id(deprecated)

perimetersstr, list, np.array, pd.Series (default None)

the name of the dataframe column, np.array, or pd.Series where is stored perimeter value

Examples

>>> buildings_df['swr'] = momepy.SharedWallsRatio(buildings_df).series
>>> buildings_df['swr'][10]
0.3424804411228673

Attributes

seriesSeries

Series containing resulting values

gdfGeoDataFrame

original GeoDataFrame

perimetersGeoDataFrame

Series containing used perimeters values

__init__(gdf, unique_id=None, perimeters=None)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(gdf[, unique_id, perimeters])

Initialize self.

momepy.Orientation momepy.StreetAlignment