momepy.
AreaRatio
Calculate covered area ratio or floor area ratio of objects.
Either unique_id or both left_unique_id and right_unique_id are required.
unique_id
left_unique_id
right_unique_id
Adapted from [SA15].
GeoDataFrame containing objects being covered (e.g. land unit)
GeoDataFrame with covering objects (e.g. building)
the name of the left dataframe column, np.array, or pd.Series where is stored area value.
np.array
pd.Series
the name of the right dataframe column, np.array, or pd.Series where is stored area value representing either projected or floor area.
name of the column with unique id shared amongst left and right gdfs. If there is none, it could be generated by :py:func:’momepy.unique_id()’.
the name of the left dataframe column, np.array, or pd.Series where is stored shared unique ID
Examples
>>> tessellation_df['CAR'] = mm.AreaRatio(tessellation_df, ... buildings_df, ... 'area', ... 'area', ... 'uID').series
Series containing resulting values
original left GeoDataFrame
original right GeoDataFrame
Series containing used left areas
Series containing used right areas
Series containing used left ID
Series containing used right ID
__init__
Initialize self. See help(type(self)) for accurate signature.
Methods
__init__(left, right, left_areas, right_areas)
Initialize self.