momepy.MeanInterbuildingDistance

class momepy.MeanInterbuildingDistance(gdf, spatial_weights, unique_id, spatial_weights_higher=None, order=3, verbose=True)

Calculate the mean interbuilding distance

Interbuilding distances are calculated between buildings on adjacent cells based on spatial_weights, while the extent is defined as order of contiguity.

\[\]

Parameters

gdfGeoDataFrame

GeoDataFrame containing objects to analyse

unique_idstr

name of the column with unique id used as spatial_weights index

spatial_weightslibpysal.weights

spatial weights matrix

orderint

Order of contiguity defining the extent

verbosebool (default True)

if True, shows progress bars in loops and indication of steps

Notes

Fix UserWarning.

Examples

>>> buildings_df['mean_interbuilding_distance'] = momepy.MeanInterbuildingDistance(
...     buildings_df,
...     sw,
...     'uID'
... ).series
Computing mean interbuilding distances...
100%|██████████| 144/144 [00:00<00:00, 317.42it/s]
>>> buildings_df['mean_interbuilding_distance'][0]
29.305457092042744

Attributes

seriesSeries

Series containing resulting values

gdfGeoDataFrame

original GeoDataFrame

swlibpysal.weights

spatial weights matrix

idSeries

Series containing used unique ID

sw_higherlibpysal.weights

Spatial weights matrix of higher order

orderint

Order of contiguity.

__init__(gdf, spatial_weights, unique_id, spatial_weights_higher=None, order=3, verbose=True)

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

Methods

__init__(gdf, spatial_weights, unique_id[, …])

Initialize self.

momepy.CellAlignment momepy.NeighborDistance