PointIndex Class Reference

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

Public Member Functions

def estimatePointDensity
def getAddInfoStatistics
def getIndexLimit
 get index based bounding box (if no index bounding available the points based bounding box is returned)
def getIndexStatistics
def getLeaf
 get leaf by its id
def getLimit
 get points based bounding box
def getPoint
 get point by its id
def leafs
 iterate over all index leafs
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 sizeLeaf
def sizePoint
def sizePointCache
def sizePointCache

Detailed Description

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

Member Function Documentation

def estimatePointDensity (   self,
  fastEstimation = True 
)
Parameters
self(type: PointIndex) self pointer
fastEstimation(type: bool) optional parameter
Returns
(type: float)
def getAddInfoStatistics (   self)
Parameters
self(type: PointIndex) self pointer
Returns
(type: AddInfoStatistics)
def getIndexLimit (   arg1)

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

def getIndexStatistics (   self)
Parameters
self(type: PointIndex) self pointer
Returns
(type: IndexStats)
def getLeaf (   self,
  arg1 
)

get leaf by its id

Parameters
self(type: PointIndex) self pointer
arg1(type: long) mandatory parameter
Returns
(type: PointIndexLeaf)
def getLimit (   self)

get points based bounding box

def getPoint (   self,
  arg1 
)

get point by its id

Parameters
self(type: PointIndex) self pointer
arg1(type: long) mandatory parameter
Returns
(type: Point)
def leafs (   self)

iterate over all index leafs

Parameters
self(type: PointIndex) self pointer
Returns
(type: collections.Iterable[PointIndexLeaf])
def points (   self)

iterate over all points

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

Referenced by PointIndex.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 PointIndex.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 PointIndex.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 PointIndex.points().

def searchPoint (   self,
  win,
  includeRightBoundary = True 
)
Parameters
self(type: PointIndex) self pointer
win(type: Window) mandatory parameter
includeRightBoundary(type: bool) optional parameter
Returns
(type: list)

Referenced by PointIndex.searchPoint().

def searchPoint (   self,
  box,
  includeRightBoundary = True 
)
Parameters
self(type: PointIndex) self pointer
box(type: Box) mandatory parameter
includeRightBoundary(type: bool) optional parameter
Returns
(type: list)

References PointIndex.searchPoint().

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

References PointIndex.searchPoint().

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

References PointIndex.searchPoint().

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

References PointIndex.searchPoint().

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

References PointIndex.searchPoint().

def sizeLeaf (   self)
Parameters
self(type: PointIndex) self pointer
Returns
(type: int)
def sizePoint (   self)
Parameters
self(type: PointIndex) self pointer
Returns
(type: int)
def sizePointCache (   self)
Parameters
self(type: PointIndex) self pointer
Returns
(type: int)

Referenced by PointIndex.sizePointCache().

def sizePointCache (   self,
  arg1 
)
Parameters
self(type: PointIndex) self pointer
arg1(type: long) mandatory parameter

References PointIndex.sizePointCache().