momepy.FloorArea#
- class momepy.FloorArea(gdf, heights, areas=None)[source]#
Calculates floor area of each object based on height and area.
Number of floors is simplified into formula height / 3 (it is assumed that on average one floor is approximately 3 metres)
\[area * \frac{height}{3}\]- Parameters
- gdfGeoDataFrame
GeoDataFrame containing objects to analyse
- heightsstr, list, np.array, pd.Series
the name of the dataframe column,
np.array
, orpd.Series
where is stored height value- areasstr, list, np.array, pd.Series (default None)
the name of the dataframe column,
np.array
, orpd.Series
where is stored area value. If set to None, function will calculate areas during the process without saving them separately.
Examples
>>> buildings['floor_area'] = momepy.FloorArea(buildings, ... heights='height_col').series Calculating floor areas... Floor areas calculated. >>> buildings.floor_area[0] 2185.672484113309
>>> buildings['floor_area'] = momepy.FloorArea(buildings, heights='height_col', ... areas='area_col').series >>> buildings.floor_area[0] 2185.672484113309
- Attributes
- seriesSeries
Series containing resulting values
- gdfGeoDataFrame
original GeoDataFrame
- heightsSeries
Series containing used heights values
- areasGeoDataFrame
Series containing used areas values
Methods
__init__
(gdf, heights[, areas])