libpysal.cg.PointLocator

class libpysal.cg.PointLocator(points)[source]

An abstract representation of a point indexing data structure.

Methods

nearest(self, query_point)

Returns the nearest point indexed to a query point.

overlapping(self, region_rect)

Returns the indexed points located inside a rectangular query region.

polygon(self, polygon)

Returns the indexed points located inside a polygon

proximity(self, origin, r)

Returns the indexed points located within some distance of an origin point.

region(self, region_rect)

Returns the indexed points located inside a rectangular query region.

__init__(self, points)[source]

Returns a point locator object.

__init__(Point list) -> PointLocator

Parameters
pointsa list of points to index

Examples

>>> points = [Point((0, 0)), Point((1, 6)), Point((5.4, 1.4))]
>>> pl = PointLocator(points)

Methods

__init__(self, points)

Returns a point locator object.

nearest(self, query_point)

Returns the nearest point indexed to a query point.

overlapping(self, region_rect)

Returns the indexed points located inside a rectangular query region.

polygon(self, polygon)

Returns the indexed points located inside a polygon

proximity(self, origin, r)

Returns the indexed points located within some distance of an origin point.

region(self, region_rect)

Returns the indexed points located inside a rectangular query region.