PointIndex Class Reference

Interface to a point index object managing the point objects within the datamanager. More...

Inheritance diagram for PointIndex:

Public Member Functions
def	estimatePointDensity (self, fastEstimation=True)
def	getAddInfoStatistics (self)
def	getIndexStatistics (self)
def	getLeaf (self, arg1)
	get leaf by its id More...
def	getLimit (self)
	get points based bounding box More...
def	getPoint (self, arg1)
	get point by its id More...
def	leafs (self)
	iterate over all index leafs More...
def	points (self, *args, **kwargs)
	possible calls: More...
def	searchPoint (self, *args, **kwargs)
	possible calls: More...
def	sizeLeaf (self)
def	sizePoint (self)
def	sizePointCache (self, *args, **kwargs)
	possible calls: More...

Static Public Member Functions
def	getIndexLimit (arg1)
	get index based bounding box (if no index bounding available the points based bounding box is returned) More...

Detailed Description

Interface to a point index object managing the point objects within the datamanager.

Member Function Documentation

estimatePointDensity()

def estimatePointDensity	(		self,
			fastEstimation = True
	)

Parameters

self	(type: PointIndex) self pointer
fastEstimation	(type: object) optional parameter

Returns

(type: float)

getAddInfoStatistics()

def getAddInfoStatistics

(

self

)

Parameters

self	(type: PointIndex) self pointer

Returns

(type: AddInfoStatistics)

getIndexLimit()

def getIndexLimit (   arg1 )

static

get index based bounding box (if no index bounding available the points based bounding box is returned)

getIndexStatistics()

def getIndexStatistics

(

self

)

Parameters

self	(type: PointIndex) self pointer

Returns

(type: IndexStats)

getLeaf()

def getLeaf	(		self,
			arg1
	)

get leaf by its id

Parameters

self	(type: PointIndex) self pointer
arg1	(type: object) mandatory parameter

Returns

(type: PointIndexLeaf)

getLimit()

def getLimit

(

self

)

get points based bounding box

getPoint()

def getPoint	(		self,
			arg1
	)

get point by its id

Parameters

self	(type: PointIndex) self pointer
arg1	(type: object) mandatory parameter

Returns

(type: Point)

leafs()

def leafs

(

self

)

iterate over all index leafs

Parameters

self	(type: PointIndex) self pointer

Returns

(type: collections.Iterable[PointIndexLeaf])

points()

def points	(		self,
		*	args,
		**	kwargs
	)

possible calls:

• points(self)
• points(self, layout: AddInfoLayout, readOnly: object)
• points(self, filter: Filter)
• points(self, filter: Filter, layout: AddInfoLayout, readOnly: object)

Parameters

self	(type: object) self pointer
*args	(type: list) mandatory parameter
**kwargs	(type: dict) mandatory parameter

Returns

(type: PointFilterIteratorRange)

searchPoint()

def searchPoint	(		self,
		*	args,
		**	kwargs
	)

possible calls:

• searchPoint(self, win: Window, filter: Filter, includeRightBoundary: object)
• searchPoint(self, box: Box, filter: Filter, includeRightBoundary: object)
• searchPoint(self, polygon: Polygon, filter: Filter)
• searchPoint(self, circle: Circle, filter: Filter)
• searchPoint(self, sphere: Sphere, filter: Filter)
• searchPoint(self, cylinder: Cylinder, filter: Filter)

Parameters

self	(type: object) self pointer
*args	(type: list) mandatory parameter
**kwargs	(type: dict) mandatory parameter

Returns

(type: list)

sizeLeaf()

def sizeLeaf

(

self

)

Parameters

self	(type: PointIndex) self pointer

Returns

(type: int)

sizePoint()

def sizePoint

(

self

)

Parameters

self	(type: PointIndex) self pointer

Returns

(type: int)

sizePointCache()

def sizePointCache	(		self,
		*	args,
		**	kwargs
	)

possible calls:

• sizePointCache(self)
• sizePointCache(self, arg1: object)

Parameters

self	(type: object) self pointer
*args	(type: list) mandatory parameter
**kwargs	(type: dict) mandatory parameter