Public Member Functions | List of all members
PointIndexLeaf Class Reference

object representing a spatial leaf within a point index More...

Public Member Functions

def __init__
def addPoint
def build
def clear
def estimatePointDensity
def getIndexLimit
 get index based bounding box (if no index bounding available the points based bounding box is returned)
def getLimit
 get points based bounding box
def id
def indexDim
def isChanged
def points
 iterate over all points
def points
 iterate over all points with a specific layout
def points
 iterate over subselected points based on a given filter
def points
 iterate over subselected points based on a given filter with a specific layout
def searchPoint
def searchPoint
def searchPoint
def searchPoint
def searchPoint
def searchPoint
def searchPoint
def setChanged
def sizePoint

Detailed Description

object representing a spatial leaf within a point index

Whereas IPointIndexLeaf objects are fully kept in memory, IPointIndex objects may consists of multiple IPointIndexLeaf objects that can be swapped to disk. For details see Internal Structure of the Datamanager

Constructor & Destructor Documentation

def __init__ (   self,
  arg1,
  arg2,
  arg3 
)
Parameters
self(type: object) self pointer
arg1(type: IndexType) mandatory parameter
arg2(type: int) mandatory parameter
arg3(type: bool) mandatory parameter
Returns
(type: object)

Member Function Documentation

def addPoint (   self,
  arg1 
)
Parameters
self(type: PointIndexLeaf) self pointer
arg1(type: Point) mandatory parameter
def build (   self)
Parameters
self(type: PointIndexLeaf) self pointer
def clear (   self)
Parameters
self(type: PointIndexLeaf) self pointer
def estimatePointDensity (   self)
Parameters
self(type: PointIndexLeaf) self pointer
Returns
(type: float)
def getIndexLimit (   self)

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

def getLimit (   self)

get points based bounding box

def id (   self)
Parameters
self(type: PointIndexLeaf) self pointer
Returns
(type: int)
def indexDim (   self)
Parameters
self(type: PointIndexLeaf) self pointer
Returns
(type: int)
def isChanged (   self)
Parameters
self(type: PointIndexLeaf) self pointer
Returns
(type: bool)
def points (   self)

iterate over all points

Parameters
self(type: PointIndexLeaf) self pointer
Returns
(type: collections.Iterable[Point])

Referenced by PointIndexLeaf.points().

def points (   self,
  layout,
  readOnly = False 
)

iterate over all points with a specific layout

see DM::IAddInfo::setView for further details

Parameters
selfself pointer
layouta view of the corresponding layout will be set onto each point
readOnlyflag if the layout of storage object should be changed, in case the view layout is not a true subset of the storage layout
Returns
python iterator object

References PointIndexLeaf.points().

def points (   self,
  filter 
)

iterate over subselected points based on a given filter

see DM::IFilter for further details

Parameters
selfself pointer
filterfilter object for subselection
Returns
python iterator object

References PointIndexLeaf.points().

def points (   self,
  filter,
  layout,
  readOnly = False 
)

iterate over subselected points based on a given filter with a specific layout

see DM::IFilter and DM::IAddInfo::setView for further details

Parameters
selfself pointer
filterfilter object for subselection
layouta view of the corresponding layout will be set onto each point
readOnlyflag if the layout of storage object should be changed, in case the view layout is not a true subset of the storage layout
Returns
python iterator object

References PointIndexLeaf.points().

def searchPoint (   self,
  arg1,
  arg2 
)
Parameters
self(type: PointIndexLeaf) self pointer
arg1(type: Window) mandatory parameter
arg2(type: bool) mandatory parameter
Returns
(type: list)

Referenced by PointIndexLeaf.searchPoint().

def searchPoint (   self,
  arg1,
  arg2 
)
Parameters
self(type: PointIndexLeaf) self pointer
arg1(type: Box) mandatory parameter
arg2(type: bool) mandatory parameter
Returns
(type: list)

References PointIndexLeaf.searchPoint().

def searchPoint (   self,
  arg1 
)
Parameters
self(type: PointIndexLeaf) self pointer
arg1(type: Polygon) mandatory parameter
Returns
(type: list)

References PointIndexLeaf.searchPoint().

def searchPoint (   self,
  arg1 
)
Parameters
self(type: PointIndexLeaf) self pointer
arg1(type: Circle) mandatory parameter
Returns
(type: list)

References PointIndexLeaf.searchPoint().

def searchPoint (   self,
  arg1 
)
Parameters
self(type: PointIndexLeaf) self pointer
arg1(type: Sphere) mandatory parameter
Returns
(type: list)

References PointIndexLeaf.searchPoint().

def searchPoint (   self,
  arg1 
)
Parameters
self(type: PointIndexLeaf) self pointer
arg1(type: Cylinder) mandatory parameter
Returns
(type: list)

References PointIndexLeaf.searchPoint().

def searchPoint (   self,
  arg1,
  arg2,
  arg3,
  arg4 
)
Parameters
self(type: PointIndexLeaf) self pointer
arg1(type: int) mandatory parameter
arg2(type: Point) mandatory parameter
arg3(type: float) mandatory parameter
arg4(type: object) mandatory parameter
Returns
(type: list)

References PointIndexLeaf.searchPoint().

def setChanged (   self,
  arg1 
)
Parameters
self(type: PointIndexLeaf) self pointer
arg1(type: bool) mandatory parameter
def sizePoint (   self)
Parameters
self(type: PointIndexLeaf) self pointer
Returns
(type: int)