momepy.VolumeFacadeRatio#
- class momepy.VolumeFacadeRatio(gdf, heights, volumes=None, perimeters=None)[source]#
Calculates the volume/facade ratio of each object in a given GeoDataFrame.
\[volume \over perimeter * height\]Adapted from [Schirmer and Axhausen, 2015].
- Parameters:
- gdfGeoDataFrame
A GeoDataFrame containing objects.
- heightsstr, list, np.array, pd.Series (default None)
The name of the dataframe column,
np.array
, orpd.Series
where height values are stored.- volumesstr, list, np.array, pd.Series (default None)
The name of the dataframe column,
np.array
, orpd.Series
where volume values are stored.- perimeters, list, np.array, pd.Series (default None)
The name of the dataframe column,
np.array
, orpd.Series
where perimeter values are stored.
Examples
>>> buildings_df['vfr'] = momepy.VolumeFacadeRatio(buildings_df, 'height').series >>> buildings_df.vfr[0] 5.310715735236504
- Attributes:
- seriesSeries
A Series containing resulting values.
- gdfGeoDataFrame
The original GeoDataFrame.
- perimetersSeries
A Series containing used perimeter values.
- volumesSeries
A Series containing used volume values.
Methods
__init__
(gdf, heights[, volumes, perimeters])