Ponca::KnnGraphBase< Traits > Class Template Reference

Customizable base class for KnnGraph datastructure. More...

#include <knnGraph.h>

Collaboration diagram for Ponca::KnnGraphBase< Traits >:

Public Types
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
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	KNearestIndexQuery = KnnGraphKNearestQuery< Traits >
using	RangeIndexQuery = KnnGraphRangeQuery< Traits >

Public Member Functions
template<typename KdTreeTraits >
	KnnGraphBase (const KdTreeBase< KdTreeTraits > &kdtree, int k=6)
	Build a KnnGraph from a KdTreeDense.
KNearestIndexQuery	kNearestNeighbors (int index) const
	Computes a Query object to iterate over the k-nearest neighbors of a point.
RangeIndexQuery	rangeNeighbors (int index, Scalar r) const
	Computes a Query object to iterate over the neighbors that are inside a given radius.
KNearestIndexQuery	kNearestNeighborsIndexQuery () const
	Convenience function that provides a k-nearest neighbors Query object.
RangeIndexQuery	rangeNeighborsIndexQuery () const
	Convenience function that provides an empty range neighbors Query object.
int	k () const
	Number of neighbor per vertex.
size_t	size () const
	Number of vertices in the neighborhood graph.

Protected Member Functions
const IndexContainer &	index_data () const

Protected Attributes
const PointContainer &	m_kdTreePoints

Friends
class	KnnGraphKNearestQuery< Traits >
class	KnnGraphRangeQuery< Traits >

Detailed Description

template<typename Traits>
class Ponca::KnnGraphBase< Traits >

Customizable base class for KnnGraph datastructure.

See also

Ponca::KnGraph

Template Parameters

Traits

Traits type providing the types and constants used by the KnnGraph. Must have the same interface as the default traits type.

See also

KnnGraphDefaultTraits for the trait interface documentation.

Definition at line 44 of file knnGraph.h.

Member Typedef Documentation

DataPoint

template<typename Traits >

using Ponca::KnnGraphBase< Traits >::DataPoint = typename Traits::DataPoint

DataPoint given by user via Traits.

Definition at line 47 of file knnGraph.h.

IndexContainer

template<typename Traits >

using Ponca::KnnGraphBase< Traits >::IndexContainer = typename Traits::IndexContainer

Container for indices used inside the KdTree.

Definition at line 53 of file knnGraph.h.

IndexType

template<typename Traits >

using Ponca::KnnGraphBase< Traits >::IndexType = typename Traits::IndexType

Definition at line 51 of file knnGraph.h.

KNearestIndexQuery

template<typename Traits >

using Ponca::KnnGraphBase< Traits >::KNearestIndexQuery = KnnGraphKNearestQuery<Traits>

Definition at line 55 of file knnGraph.h.

PointContainer

template<typename Traits >

using Ponca::KnnGraphBase< Traits >::PointContainer = typename Traits::PointContainer

Container for DataPoint used inside the KdTree.

Definition at line 52 of file knnGraph.h.

RangeIndexQuery

template<typename Traits >

using Ponca::KnnGraphBase< Traits >::RangeIndexQuery = KnnGraphRangeQuery<Traits>

Definition at line 56 of file knnGraph.h.

Scalar

template<typename Traits >

using Ponca::KnnGraphBase< Traits >::Scalar = typename DataPoint::Scalar

Scalar given by user via DataPoint.

Definition at line 48 of file knnGraph.h.

VectorType

template<typename Traits >

using Ponca::KnnGraphBase< Traits >::VectorType = typename DataPoint::VectorType

VectorType given by user via DataPoint.

Definition at line 49 of file knnGraph.h.

Constructor & Destructor Documentation

KnnGraphBase()

template<typename Traits >

template<typename KdTreeTraits >

Ponca::KnnGraphBase< Traits >::KnnGraphBase ( const KdTreeBase< KdTreeTraits > &  kdtree, int  k = 6  )

inline

Build a KnnGraph from a KdTreeDense.

Parameters

k	Number of requested neighbors. Might be reduced if k is larger than the kdtree size - 1 (query point is not included in query output, thus -1)

Warning

Stores a const reference to kdtree.point_data()

KdTreeTraits compatibility is checked with static assertion

Definition at line 71 of file knnGraph.h.

Member Function Documentation

index_data()

template<typename Traits >

const IndexContainer & Ponca::KnnGraphBase< Traits >::index_data ( ) const

inlineprotected

Definition at line 178 of file knnGraph.h.

k()

template<typename Traits >

int Ponca::KnnGraphBase< Traits >::k ( ) const

inline

Number of neighbor per vertex.

Definition at line 167 of file knnGraph.h.

kNearestNeighbors()

template<typename Traits >

KNearestIndexQuery Ponca::KnnGraphBase< Traits >::kNearestNeighbors ( int  index ) const

inline

Computes a Query object to iterate over the k-nearest neighbors of a point.

As k was set during the construction of the KnnGraphBase, it doesn't need to be provided.

The returned object can be reset and reused with the () operator, to compute a new result (also takes an index as parameter).

Parameters

index

Index of the point that the query evaluates

Returns

The KNearestIndexQuery mutable object to iterate over the search results.

Definition at line 117 of file knnGraph.h.

kNearestNeighborsIndexQuery()

template<typename Traits >

KNearestIndexQuery Ponca::KnnGraphBase< Traits >::kNearestNeighborsIndexQuery ( ) const

inline

Convenience function that provides a k-nearest neighbors Query object.

Same as KnnGraphBase::kNearestNeighbors (0).

Warning

Unlike KdTreeBase::kNearestNeighborsIndexQuery, this function doesn't really return an empty query. This is due to the fact that the KnnGraphBase::kNearestNeighbors query can't set the k value to zero, as it is a value that is managed by the KnnGraphBase structure. Therefore, this function returns the k-nearest neighbors query made with the evaluation point set to 0.

Returns

The KNearestIndexQuery mutable object that can be called with the operator () with an index as argument, to fetch the k-nearest neighbors of a point.

See also

kNearestNeighbors

Definition at line 145 of file knnGraph.h.

rangeNeighbors()

template<typename Traits >

RangeIndexQuery Ponca::KnnGraphBase< Traits >::rangeNeighbors ( int  index, Scalar  r  ) const

inline

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, to compute a new result (also takes an index and a radius as parameters).

Parameters

index	Index of the point that the query evaluates
r	Radius around where to search the neighbors

Returns

The RangeIndexQuery mutable object to iterate over the search results.

Definition at line 129 of file knnGraph.h.

rangeNeighborsIndexQuery()

template<typename Traits >

RangeIndexQuery Ponca::KnnGraphBase< Traits >::rangeNeighborsIndexQuery ( ) const

inline

Convenience function that provides an empty range neighbors Query object.

The returned object can be called with the arguments (i, r) to fetch the neighbors that are in range r of the point of index i.

Same as KnnGraphBase::rangeNeighbors (0, 0).

Returns

The empty KNearestIndexQuery mutable object to iterate over the search results.

See also

rangeNeighbors

Definition at line 159 of file knnGraph.h.

size()

template<typename Traits >

size_t Ponca::KnnGraphBase< Traits >::size ( ) const

inline

Number of vertices in the neighborhood graph.

Definition at line 169 of file knnGraph.h.

Friends And Related Symbol Documentation

KnnGraphKNearestQuery< Traits >

template<typename Traits >

friend class KnnGraphKNearestQuery< Traits >

friend

Definition at line 1 of file knnGraph.h.

KnnGraphRangeQuery< Traits >

template<typename Traits >

friend class KnnGraphRangeQuery< Traits >

friend

Definition at line 1 of file knnGraph.h.

Member Data Documentation

m_kdTreePoints

template<typename Traits >

const PointContainer& Ponca::KnnGraphBase< Traits >::m_kdTreePoints

protected

Definition at line 177 of file knnGraph.h.