momepy.VolumeFacadeRatio

class momepy.VolumeFacadeRatio(gdf, heights, volumes=None, perimeters=None)

Calculates volume/facade ratio of each object in given GeoDataFrame.

\[volume \over perimeter * height\]

Adapted from [Schirmer and Axhausen, 2015].

Parameters

gdfGeoDataFrame

GeoDataFrame containing objects

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

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

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

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

perimeters, 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['vfr'] = momepy.VolumeFacadeRatio(buildings_df, 'height').series
>>> buildings_df.vfr[0]
5.310715735236504

Attributes

seriesSeries

Series containing resulting values

gdfGeoDataFrame

original GeoDataFrame

perimetersSeries

Series containing used perimeter values

volumesSeries

Series containing used volume values

__init__(gdf, heights, volumes=None, perimeters=None)

Methods

__init__(gdf, heights[, volumes, perimeters])