Public Member Functions | Static Public Member Functions | List of all members
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)
 
def getLimit (self)
 
def getPoint (self, arg1)
 
def leafs (self)
 
def sizeLeaf (self)
 
def sizePoint (self)
 

Static Public Member Functions

def getIndexLimit (arg1)
 
def points (self, *args, **kwargs)
 
def searchPoint (self, *args, **kwargs)
 
def sizePointCache (self, *args, **kwargs)
 

Detailed Description

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

Member Function Documentation

◆ estimatePointDensity()

def estimatePointDensity (   self,
  fastEstimation = True 
) 
  @param self (type: PointIndex) self pointer
  @param fastEstimation (type: bool) optional parameter
  @return (type: float)

◆ getAddInfoStatistics()

def getAddInfoStatistics (   self) 
  @param self (type: PointIndex) self pointer
  @return (type: AddInfoStatistics)

◆ getIndexLimit()

def getIndexLimit (   arg1)
static 
  @copydoc DM::IPointIndex::getIndexLimit

◆ getIndexStatistics()

def getIndexStatistics (   self) 
  @param self (type: PointIndex) self pointer
  @return (type: IndexStats)

◆ getLeaf()

def getLeaf (   self,
  arg1 
) 
  get leaf by its id
  @param self (type: PointIndex) self pointer
  @param arg1 (type: int) mandatory parameter
  @return (type: PointIndexLeaf)

◆ getLimit()

def getLimit (   self) 
  @copydoc DM::IPointIndex::getLimit

◆ getPoint()

def getPoint (   self,
  arg1 
) 
  get point by its id
  @param self (type: PointIndex) self pointer
  @param arg1 (type: int) mandatory parameter
  @return (type: Point)

◆ leafs()

def leafs (   self) 
  iterate over all index leafs
  @param self (type: PointIndex) self pointer
  @return (type: collections.Iterable[PointIndexLeaf])

◆ points()

def points (   self,
*  args,
**  kwargs 
)
static 
  possible calls:
  points(self)
  points(self, layout: AddInfoLayout, readOnly: bool)
  points(self, filter: Filter)
  points(self, filter: Filter, layout: AddInfoLayout, readOnly: bool)

  @param self (type: object) self pointer
  @param *args  (type: list) mandatory parameter
  @param ** kwargs  (type: dict) mandatory parameter
  @return (type: PointFilterIteratorRange)

◆ searchPoint()

def searchPoint (   self,
*  args,
**  kwargs 
)
static 
  possible calls:
  searchPoint(self, win: Window, includeRightBoundary: bool)
  searchPoint(self, box: Box, includeRightBoundary: bool)
  searchPoint(self, arg1: Polygon)
  searchPoint(self, arg1: Circle)
  searchPoint(self, arg1: Sphere)
  searchPoint(self, arg1: Cylinder)

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

◆ sizeLeaf()

def sizeLeaf (   self) 
  @param self (type: PointIndex) self pointer
  @return (type: int)

◆ sizePoint()

def sizePoint (   self) 
  @param self (type: PointIndex) self pointer
  @return (type: int)

◆ sizePointCache()

def sizePointCache (   self,
*  args,
**  kwargs 
)
static 
  possible calls:
  sizePointCache(self)
  sizePointCache(self, arg1: int)

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