Ponca  6f9f1b59d7c8c4654a710cfcef7342f4f5c79ba1
Point Cloud Analysis library
Loading...
Searching...
No Matches
Ponca::NeighborGraphDefaultTraits< _DataPoint > Struct Template Reference

The default traits type used by the neighbor graph. More...

#include <neighborGraphTraits.h>

+ Collaboration diagram for Ponca::NeighborGraphDefaultTraits< _DataPoint >:

Public Types

using DataPoint = _DataPoint
 The type used to store point data.
 
using AabbType = Eigen::AlignedBox< Scalar, DataPoint::Dim >
 The type used to calculate node bounding boxes.
 
using IndexType = int
 
using PointContainer = const std::vector< DataPoint > &
 Type used to store the external Point container in AbstractNeighborGraph::Buffers.
 
using PointContainerConstRef = PointContainer
 Convenience alias used to convey the constness and the absence of copy of the container.
 
using IndexContainer = std::vector< IndexType >
 Type used to store the index container in the AbstractNeighborGraph::Buffers.
 
using IndexContainerRef = IndexContainer &
 Type to be used to send the index container as function parameter.
 
using KnnGraphRangeSet = std::set< int >
 A Set dynamic in memory, used by NeighborGraphRangeQuery.
 
using KnnGraphRangeStack = std::stack< int >
 A Stack dynamic in memory, used by NeighborGraphRangeQuery.
 

Static Public Member Functions

static IndexTypegetIndexRawPtr (IndexContainer &idx)
 Provides access to the raw pointer where indices are stored.
 
static const IndexTypegetIndexRawPtr (const IndexContainer &idx)
 Provides access to the raw pointer where indices are stored.
 

Detailed Description

template<typename _DataPoint>
struct Ponca::NeighborGraphDefaultTraits< _DataPoint >

The default traits type used by the neighbor graph.

Definition at line 23 of file neighborGraphTraits.h.

Member Typedef Documentation

◆ AabbType

template<typename _DataPoint >
using Ponca::NeighborGraphDefaultTraits< _DataPoint >::AabbType = Eigen::AlignedBox<Scalar, DataPoint::Dim>

The type used to calculate node bounding boxes.

Must provide min(), max(), and center() functions, all returning a VectorType.

Definition at line 46 of file neighborGraphTraits.h.

◆ DataPoint

The type used to store point data.

Must provide Scalar and VectorType aliases.

VectorType must provide a squaredNorm() function returning a Scalar, as well as a maxCoeff(int*) function returning the dimension index of its largest scalar in its output parameter (e.g. 0 for x, 1 for y, etc.).

Definition at line 34 of file neighborGraphTraits.h.

◆ IndexContainer

template<typename _DataPoint >
using Ponca::NeighborGraphDefaultTraits< _DataPoint >::IndexContainer = std::vector<IndexType>

Type used to store the index container in the AbstractNeighborGraph::Buffers.

Definition at line 55 of file neighborGraphTraits.h.

◆ IndexContainerRef

Type to be used to send the index container as function parameter.

Definition at line 57 of file neighborGraphTraits.h.

◆ IndexType

Definition at line 49 of file neighborGraphTraits.h.

◆ KnnGraphRangeSet

template<typename _DataPoint >
using Ponca::NeighborGraphDefaultTraits< _DataPoint >::KnnGraphRangeSet = std::set<int>

A Set dynamic in memory, used by NeighborGraphRangeQuery.

Warning
Not compatible with CUDA

Definition at line 62 of file neighborGraphTraits.h.

◆ KnnGraphRangeStack

template<typename _DataPoint >
using Ponca::NeighborGraphDefaultTraits< _DataPoint >::KnnGraphRangeStack = std::stack<int>

A Stack dynamic in memory, used by NeighborGraphRangeQuery.

Warning
Not compatible with CUDA

Definition at line 66 of file neighborGraphTraits.h.

◆ PointContainer

template<typename _DataPoint >
using Ponca::NeighborGraphDefaultTraits< _DataPoint >::PointContainer = const std::vector<DataPoint>&

Type used to store the external Point container in AbstractNeighborGraph::Buffers.

Definition at line 51 of file neighborGraphTraits.h.

◆ PointContainerConstRef

Convenience alias used to convey the constness and the absence of copy of the container.

Definition at line 53 of file neighborGraphTraits.h.

Member Function Documentation

◆ getIndexRawPtr() [1/2]

Provides access to the raw pointer where indices are stored.

Definition at line 71 of file neighborGraphTraits.h.

◆ getIndexRawPtr() [2/2]

template<typename _DataPoint >
static IndexType * Ponca::NeighborGraphDefaultTraits< _DataPoint >::getIndexRawPtr ( IndexContainer idx)
inlinestatic

Provides access to the raw pointer where indices are stored.

Definition at line 69 of file neighborGraphTraits.h.