momepy.Alignment

class momepy.Alignment(gdf, spatial_weights, unique_id, orientations)[source]

Calculate the mean deviation of solar orientation of objects on adjacent cells from an object

\[\frac{1}{n}\sum_{i=1}^n dev_i=\frac{dev_1+dev_2+\cdots+dev_n}{n}\]
Parameters
gdfGeoDataFrame

GeoDataFrame containing objects to analyse

spatial_weightslibpysal.weights, optional

spatial weights matrix

orientationsstr, list, np.array, pd.Series

the name of the left dataframe column, np.array, or pd.Series where is stored object orientation value (can be calculated using momepy.Orientation)

unique_idstr

name of the column with unique id used as spatial_weights index.

Examples

>>> buildings_df['alignment'] = momepy.Alignment(buildings_df, sw, 'uID', bl_orient).series
100%|██████████| 144/144 [00:01<00:00, 140.84it/s]
>>> buildings_df['alignment'][0]
18.299481296455237
Attributes
seriesSeries

Series containing resulting values

gdfGeoDataFrame

original GeoDataFrame

orientationsSeries

Series containing used orientation values

swlibpysal.weights

spatial weights matrix

idSeries

Series containing used unique ID

__init__(self, gdf, spatial_weights, unique_id, orientations)[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self, gdf, spatial_weights, …)

Initialize self.