Ponca  4a9354998d048bf882a3ee9bac8105216fa08d13
Point Cloud Analysis library
Loading...
Searching...
No Matches
Ponca::KnnGraphBuffers< _Traits > Struct Template Reference

Buffer class for StaticKnnGraphBase. More...

#include <knnGraph.h>

+ Inheritance diagram for Ponca::KnnGraphBuffers< _Traits >:
+ Collaboration diagram for Ponca::KnnGraphBuffers< _Traits >:

Public Types

using Traits = _Traits
 Alias to the Traits type

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

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

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

 
using IndexType = typename Traits::IndexType
 Type used to index points into the PointContainer.
 
using PointContainer = typename Traits::PointContainer
 Container for DataPoint used inside the KdTree

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

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

 
using IndexContainerRef = typename Traits::IndexContainerRef
 Ref type to index container.
 
using Base = NeighborGraphBufferBase< _Traits >
 
- Public Types inherited from Ponca::NeighborGraphBufferBase< _Traits >
using Traits = _Traits
 Alias to the Traits type

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

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

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

 
using IndexType = typename Traits::IndexType
 Type used to index points into the PointContainer.
 
using PointContainer = typename Traits::PointContainer
 Container for DataPoint used inside the KdTree

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

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

 
using IndexContainerRef = typename Traits::IndexContainerRef
 Ref type to index container.
 

Public Member Functions

 KnnGraphBuffers (PointContainerConstRef _points, const int _k=DefaultKInKnnGraph())
 
 KnnGraphBuffers (PointContainerConstRef _points, IndexContainerRef _indices, const size_t _points_size, const size_t _indices_size, const int _k)
 
- Public Member Functions inherited from Ponca::NeighborGraphBufferBase< _Traits >
 NeighborGraphBufferBase ()=default
 Default constructor, might be deleted depending on the PointContainer type (e.g. const reference)
 
 NeighborGraphBufferBase (PointContainerConstRef _points)
 Default constructor setting the point container.
 
 NeighborGraphBufferBase (PointContainerConstRef _points, IndexContainerRef _indices, const size_t _points_size, const size_t _indices_size)
 Constructor allowing to set all the attributes.
 

Static Public Member Functions

static constexpr int DefaultKInKnnGraph ()
 Helper constexpr defining the default number of neighbors in Knn graphs.
 

Public Attributes

const int k {DefaultKInKnnGraph()}
 Number of neighbors used to build the graph.
 
- Public Attributes inherited from Ponca::NeighborGraphBufferBase< _Traits >
PointContainer points
 Buffer storing the input points (read only)
 
IndexContainer indices
 Buffer storing the indices associating the input points to the nodes.
 
size_t points_size {0}
 Number of points in the graph.
 
size_t indices_size {0}
 Number of connections in the graph.
 

Detailed Description

template<typename _Traits>
struct Ponca::KnnGraphBuffers< _Traits >

Buffer class for StaticKnnGraphBase.

Extends the NeighborGraphBufferBase with a constant neighborhood size k

Definition at line 23 of file knnGraph.h.

Member Typedef Documentation

◆ Base

Definition at line 26 of file knnGraph.h.

◆ DataPoint

DataPoint given by user via Traits

Definition at line 25 of file knnGraph.h.

◆ IndexContainer

template<typename _Traits >
using Ponca::KnnGraphBuffers< _Traits >::IndexContainer = typename Traits::IndexContainer

Container for indices used inside the KdTree

Definition at line 25 of file knnGraph.h.

◆ IndexContainerRef

template<typename _Traits >
using Ponca::KnnGraphBuffers< _Traits >::IndexContainerRef = typename Traits::IndexContainerRef

Ref type to index container.

Definition at line 25 of file knnGraph.h.

◆ IndexType

template<typename _Traits >
using Ponca::KnnGraphBuffers< _Traits >::IndexType = typename Traits::IndexType

Type used to index points into the PointContainer.

Definition at line 25 of file knnGraph.h.

◆ PointContainer

template<typename _Traits >
using Ponca::KnnGraphBuffers< _Traits >::PointContainer = typename Traits::PointContainer

Container for DataPoint used inside the KdTree

Definition at line 25 of file knnGraph.h.

◆ PointContainerConstRef

template<typename _Traits >
using Ponca::KnnGraphBuffers< _Traits >::PointContainerConstRef = typename Traits::PointContainerConstRef

Container for DataPoint used inside the KdTree

Definition at line 25 of file knnGraph.h.

◆ Scalar

template<typename _Traits >
using Ponca::KnnGraphBuffers< _Traits >::Scalar = typename DataPoint::Scalar

Scalar given by user via DataPoint

Definition at line 25 of file knnGraph.h.

◆ Traits

Alias to the Traits type

Definition at line 25 of file knnGraph.h.

◆ VectorType

template<typename _Traits >
using Ponca::KnnGraphBuffers< _Traits >::VectorType = typename DataPoint::VectorType

VectorType given by user via DataPoint

Definition at line 25 of file knnGraph.h.

Constructor & Destructor Documentation

◆ KnnGraphBuffers() [1/2]

template<typename _Traits >
Ponca::KnnGraphBuffers< _Traits >::KnnGraphBuffers ( PointContainerConstRef  _points,
const int  _k = DefaultKInKnnGraph() 
)
inline

Definition at line 35 of file knnGraph.h.

◆ KnnGraphBuffers() [2/2]

template<typename _Traits >
Ponca::KnnGraphBuffers< _Traits >::KnnGraphBuffers ( PointContainerConstRef  _points,
IndexContainerRef  _indices,
const size_t  _points_size,
const size_t  _indices_size,
const int  _k 
)
inline

Definition at line 39 of file knnGraph.h.

Member Function Documentation

◆ DefaultKInKnnGraph()

template<typename _Traits >
static constexpr int Ponca::KnnGraphBuffers< _Traits >::DefaultKInKnnGraph ( )
inlinestaticconstexpr

Helper constexpr defining the default number of neighbors in Knn graphs.

Definition at line 29 of file knnGraph.h.

Member Data Documentation

◆ k

Number of neighbors used to build the graph.

Definition at line 32 of file knnGraph.h.