momepy.DistanceBand#
- class momepy.DistanceBand(gdf, threshold, centroid=True, ids=None)[source]#
On demand distance-based spatial weights-like class.
Mimic the behavior of
libpysal.weights.DistanceBand
but do not compute all neighbors at once but only on demand. OnlyDistanceBand.neighbors[key]
is implemented. Once user asks forDistanceBand.neighbors[key]
, neighbors for specified key will be computed using rtree. The algorithm is significantly slower thanlibpysal.weights.DistanceBand
but allows for large number of neighbors which may cause memory issues in libpysal.Use
libpysal.weights.DistanceBand
if possible.momepy.weights.DistanceBand
only when necessary.DistanceBand.neighbors[key]
should yield same results asmomepy.DistanceBand
.- Parameters
- gdfGeoDataFrame or GeoSeries
GeoDataFrame containing objects to be used
- thresholdfloat
distance band to be used as buffer
- centroidbool (default True)
use centroid of geometry (as in
libpysal.weights.DistanceBand
). IfFalse
, works with the geometry as it is.- idsstr
column to be used as geometry ids. If not set, integer position is used.
- Attributes
- neighbors[key]list
list of ids of neighboring features
Methods
fetch_items
Methods
__init__
(gdf, threshold[, centroid, ids])fetch_items
(key)