momepy.EquivalentRectangularIndex¶

class momepy.EquivalentRectangularIndex(gdf, areas=None, perimeters=None)[source]¶

Calculates equivalent rectangular index of each object in given GeoDataFrame.

\[\sqrt{{area} \over \textit{area of bounding rectangle}} * {\textit{perimeter of bounding rectangle} \over {perimeter}}\]

Based on [BC17].

Parameters

gdfGeoDataFrame: GeoDataFrame containing objects
areasstr, list, np.array, pd.Series (default None): the name of the dataframe column, np.array, or pd.Series where is stored area value. If set to None, function will calculate areas during the process without saving them separately.
perimetersstr, list, np.array, pd.Series (default None): the name of the dataframe column, np.array, or pd.Series where is stored perimeter value. If set to None, function will calculate perimeters during the process without saving them separately.

Examples

>>> buildings_df['eri'] = momepy.EquivalentRectangularIndex(buildings_df,
...                                                         'area',
...                                                         'peri').series
>>> buildings_df['eri'][0]
0.7879229963118455

Attributes

seriesSeries: Series containing resulting values
gdfGeoDataFrame: original GeoDataFrame
areasSeries: Series containing used area values
perimetersSeries: Series containing used perimeter values

__init__(gdf, areas=None, perimeters=None)[source]¶: Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(gdf[, areas, perimeters])

Initialize self.

momepy.Elongation momepy.FormFactor