Ponca  93eea5457c48839cb5d16642765afa89fc7cfe66
Point Cloud Analysis library
Loading...
Searching...
No Matches
Ponca::StaticKdTree< DataPoint > Struct Template Reference

A KdTree type with KdTreeDefaultTraits that doesn't define the build function. More...

#include <kdTree.h>

+ Inheritance diagram for Ponca::StaticKdTree< DataPoint >:
+ Collaboration diagram for Ponca::StaticKdTree< DataPoint >:

Additional Inherited Members

- Public Types inherited from Ponca::StaticKdTreeBase< KdTreeDefaultTraits< DataPoint > >
using DataPoint = typename Traits::DataPoint
 DataPoint given by user via Traits

 
using IndexType = typename Traits::IndexType
 Type used to index points into the PointContainer

 
using LeafSizeType = typename Traits::LeafSizeType
 Type used to store the size of leaf nodes

 
using PointContainer = typename Traits::PointContainer
 Container for DataPoint used inside the KdTree

 
using IndexContainer = typename Traits::IndexContainer
 Container for indices used inside the KdTree

 
using NodeIndexType = typename Traits::NodeIndexType
 Type used to index nodes into the NodeContainer

 
using NodeType = typename Traits::NodeType
 Type of nodes used inside the KdTree

 
using NodeContainer = typename Traits::NodeContainer
 Container for nodes used inside the KdTree

 
using Scalar = typename DataPoint::Scalar
 Scalar given by user via DataPoint

 
using VectorType = typename DataPoint::VectorType
 VectorType given by user via DataPoint

 
using AabbType = typename NodeType::AabbType
 Bounding box type given by user via NodeType

 
- Public Member Functions inherited from Ponca::StaticKdTreeBase< KdTreeDefaultTraits< DataPoint > >
 StaticKdTreeBase (Buffers &buf)
 Constructor that allows the use of prebuilt KdTree containers.
 
NodeIndexType nodeCount () const
 Get the number of nodes in the KdTree.
 
IndexType sampleCount () const
 Get the number of indices.
 
IndexType pointCount () const
 Get the number of points.
 
NodeIndexType leafCount () const
 Get the number of leafs in the KdTree.
 
PointContainerpoints ()
 Get the internal point container.
 
const PointContainerpoints () const
 Get the internal point container.
 
const NodeContainernodes () const
 Get the internal node container.
 
const IndexContainersamples () const
 Get the internal indice container.
 
const Buffers & buffers () const
 Get access to the internal buffer, for instance to prepare GPU binding.
 
LeafSizeType minCellSize () const
 Read leaf min size.
 
void setMinCellSize (LeafSizeType min_cell_size)
 Write leaf min size.
 
IndexType pointFromSample (IndexType sample_index) const
 Return the point index associated with the specified sample index.
 
DataPointpointDataFromSample (IndexType sample_index)
 Return the DataPoint associated with the specified sample index.
 
const DataPointpointDataFromSample (IndexType sample_index) const
 Return the DataPoint associated with the specified sample index.
 
KdTreeKNearestPointQuery< KdTreeDefaultTraits< DataPoint > > kNearestNeighbors (const VectorType &point, IndexType k) const
 Computes a Query object to iterate over the k-nearest neighbors of a point. The returned object can be reset and reused with the () operator (using the same argument types as parameters).
 
KdTreeKNearestIndexQuery< KdTreeDefaultTraits< DataPoint > > kNearestNeighbors (IndexType index, IndexType k) const
 Computes a Query object to iterate over the k-nearest neighbors of a point. The returned object can be reset and reused with the () operator (using the same argument types as parameters).
 
KdTreeKNearestPointQuery< KdTreeDefaultTraits< DataPoint > > kNearestNeighborsQuery () const
 Convenience function that provides an empty k-nearest neighbors Query object.
 
KdTreeKNearestIndexQuery< KdTreeDefaultTraits< DataPoint > > kNearestNeighborsIndexQuery () const
 Convenience function that provides an empty k-nearest neighbors Query object.
 
KdTreeNearestPointQuery< KdTreeDefaultTraits< DataPoint > > nearestNeighbor (const VectorType &point) const
 Computes a Query object that contains the nearest point. The returned object can be reset and reused with the () operator (using the same argument types as parameters).
 
KdTreeNearestIndexQuery< KdTreeDefaultTraits< DataPoint > > nearestNeighbor (IndexType index) const
 Computes a Query object that contains the nearest point. The returned object can be reset and reused with the () operator (using the same argument types as parameters).
 
KdTreeNearestIndexQuery< KdTreeDefaultTraits< DataPoint > > nearestNeighborQuery () const
 Convenience function that provides an empty nearest neighbor Query object.
 
KdTreeNearestIndexQuery< KdTreeDefaultTraits< DataPoint > > nearestNeighborIndexQuery () const
 Convenience function that provides an empty nearest neighbor Query object.
 
KdTreeRangePointQuery< KdTreeDefaultTraits< DataPoint > > rangeNeighbors (const VectorType &point, Scalar r) const
 Computes a Query object to iterate over the neighbors that are inside a given radius. The returned object can be reset and reused with the () operator (using the same argument types as parameters).
 
KdTreeRangeIndexQuery< KdTreeDefaultTraits< DataPoint > > rangeNeighbors (IndexType index, Scalar r) const
 Computes a Query object to iterate over the neighbors that are inside a given radius. The returned object can be reset and reused with the () operator (using the same argument types as parameters).
 
KdTreeRangePointQuery< KdTreeDefaultTraits< DataPoint > > rangeNeighborsQuery () const
 Convenience function that provides an empty range neighbor Query object.
 
KdTreeRangeIndexQuery< KdTreeDefaultTraits< DataPoint > > rangeNeighborsIndexQuery () const
 KdTreeBase::rangeNeighborsQuery.
 
bool valid () const
 
void print (std::ostream &os, bool verbose=false) const
 
- Static Public Attributes inherited from Ponca::StaticKdTreeBase< KdTreeDefaultTraits< DataPoint > >
static constexpr std::size_t MAX_NODE_COUNT
 The maximum number of nodes that the kd-tree can have.
 
static constexpr std::size_t MAX_POINT_COUNT
 The maximum number of points that can be stored in the kd-tree.
 
static constexpr int MAX_DEPTH
 The maximum depth of the kd-tree.
 
static constexpr bool SUPPORTS_SUBSAMPLING
 
- Protected Attributes inherited from Ponca::StaticKdTreeBase< KdTreeDefaultTraits< DataPoint > >
Buffers m_bufs
 Buffers used to store the KdTree.
 
LeafSizeType m_min_cell_size
 Minimal number of points per leaf.
 
NodeIndexType m_leaf_count
 Number of leaves in the Kdtree (computed during construction)
 

Detailed Description

template<typename DataPoint>
struct Ponca::StaticKdTree< DataPoint >

A KdTree type with KdTreeDefaultTraits that doesn't define the build function.

Note
This KdTree type is used to avoid the building process of the KdTree. It exposes a constructor that expect prebuilt kdtree containers using the StaticKdTreeBase::Buffers structure
See also
StaticKdTreeBase::StaticKdTreeBase and StaticKdTreeBase::Buffers for the construction documentation
KdTreeDefaultTraits for the default trait interface documentation.

Definition at line 67 of file kdTree.h.