momepy.Courtyards

class momepy.Courtyards(gdf, block_id=None, spatial_weights=None, verbose=True)[source]

Calculate the number of courtyards within the joined structure.

Adapted from [SA15].

Parameters
gdfGeoDataFrame

GeoDataFrame containing objects to analyse

block_id(deprecated)
spatial_weightslibpysal.weights, optional

spatial weights matrix - If None, Queen contiguity matrix will be calculated based on objects. It is to denote adjacent buildings (note: based on integer index).

verbosebool (default True)

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

Examples

>>> buildings_df['courtyards'] = mm.Courtyards(buildings_df).series
Calculating spatial weights...
Attributes
seriesSeries

Series containing resulting values

gdfGeoDataFrame

original GeoDataFrame

swlibpysal.weights

spatial weights matrix

__init__(gdf, block_id=None, spatial_weights=None, verbose=True)[source]

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

Methods

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

Initialize self.