Ponca  4d2a58fa5c6375adef5c4b208f4d47e016cecd6d
Point Cloud Analysis library
Loading...
Searching...
No Matches
Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T > Class Template Reference

Internal generic class computing the derivatives of covariance matrix computed by covarianceBase. More...

#include <covariance.h>

+ Inheritance diagram for Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >:
+ Collaboration diagram for Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >:

Public Types

using Scalar = typename DataPoint::Scalar
 Alias to scalar type.
 
using VectorType = typename Base::VectorType
 Alias to vector type.
 
using NeighborFilter = typename Base::NeighborFilter
 Alias to the filter applied on the neighbors.
 
using MatrixType = typename DataPoint::MatrixType
 Alias to matrix type.
 
using ScalarArray = typename Base::ScalarArray
 Alias to scalar derivatives array.
 
using VectorArray = typename Base::VectorArray
 Alias to vector derivatives array.
 

Public Member Functions

CovarianceDer< DataPoint, _NFilter, DiffType, T > & covarianceDer ()
 Explicit conversion to CovarianceDer , to access methods potentially hidden by heritage.
 
const CovarianceDer< DataPoint, _NFilter, DiffType, T > & covarianceDer () const
 Explicit conversion to CovarianceDer , to access methods potentially hidden by heritage.
 
void init ()
 Set the evaluation position and reset the internal states.
 
void addLocalNeighbor (Scalar w, const VectorType &localQ, const DataPoint &attributes, ScalarArray &dw)
 Add a neighbor to perform the fit.
 
FIT_RESULT finalize ()
 Finalize the procedure.
 

Protected Types

using Base = T
 Base class of the procedure.
 

Protected Attributes

MatrixType m_dCov [Base::NbDerivatives]
 Computation data: derivatives of the covariance matrix.
 

Detailed Description

template<class DataPoint, class _NFilter, int DiffType, typename T>
requires ProvidesBasketDiffUnitBase<T>&& ProvidesMeanPositionDerivative<T>&& ProvidesPositionCovariance<T>
class Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >

Internal generic class computing the derivatives of covariance matrix computed by covarianceBase.

Definition at line 146 of file covariance.h.

Member Typedef Documentation

◆ Base

template<class DataPoint , class _NFilter , int DiffType, typename T >
using Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >::Base = T
protected

Base class of the procedure.

Definition at line 148 of file covariance.h.

◆ MatrixType

template<class DataPoint , class _NFilter , int DiffType, typename T >
using Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >::MatrixType = typename DataPoint::MatrixType

Alias to matrix type.

Definition at line 149 of file covariance.h.

◆ NeighborFilter

template<class DataPoint , class _NFilter , int DiffType, typename T >
using Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >::NeighborFilter = typename Base::NeighborFilter

Alias to the filter applied on the neighbors.

Definition at line 148 of file covariance.h.

◆ Scalar

template<class DataPoint , class _NFilter , int DiffType, typename T >
using Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >::Scalar = typename DataPoint::Scalar

Alias to scalar type.

Definition at line 148 of file covariance.h.

◆ ScalarArray

template<class DataPoint , class _NFilter , int DiffType, typename T >
using Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >::ScalarArray = typename Base::ScalarArray

Alias to scalar derivatives array.

Definition at line 150 of file covariance.h.

◆ VectorArray

template<class DataPoint , class _NFilter , int DiffType, typename T >
using Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >::VectorArray = typename Base::VectorArray

Alias to vector derivatives array.

Definition at line 150 of file covariance.h.

◆ VectorType

template<class DataPoint , class _NFilter , int DiffType, typename T >
using Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >::VectorType = typename Base::VectorType

Alias to vector type.

Definition at line 148 of file covariance.h.

Member Function Documentation

◆ addLocalNeighbor()

template<class DataPoint , class _NFilter , int DiffType, typename T >
void CovarianceDer::addLocalNeighbor ( Scalar  w,
const VectorType localQ,
const DataPoint &  attributes,
ScalarArray dw 
)
inline

Add a neighbor to perform the fit.

Definition at line 130 of file covariance.hpp.

◆ covarianceDer() [1/2]

template<class DataPoint , class _NFilter , int DiffType, typename T >
CovarianceDer< DataPoint, _NFilter, DiffType, T > & Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >::covarianceDer ( )
inline

Explicit conversion to CovarianceDer , to access methods potentially hidden by heritage.

Definition at line 156 of file covariance.h.

◆ covarianceDer() [2/2]

template<class DataPoint , class _NFilter , int DiffType, typename T >
const CovarianceDer< DataPoint, _NFilter, DiffType, T > & Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >::covarianceDer ( ) const
inline

Explicit conversion to CovarianceDer , to access methods potentially hidden by heritage.

Definition at line 156 of file covariance.h.

◆ finalize()

template<class DataPoint , class _NFilter , int DiffType, typename T >
FIT_RESULT CovarianceDer::finalize ( )
inline

Finalize the procedure.

Returns
Fitting Status
Warning
Must be called be for any use of the fitting output

Definition at line 140 of file covariance.hpp.

◆ init()

template<class DataPoint , class _NFilter , int DiffType, typename T >
void CovarianceDer::init ( )
inline

Set the evaluation position and reset the internal states.

Warning
Must be called be for any computation (but * after #setNeighborFilter)

Definition at line 120 of file covariance.hpp.

Member Data Documentation

◆ m_dCov

template<class DataPoint , class _NFilter , int DiffType, typename T >
MatrixType Ponca::CovarianceDer< DataPoint, _NFilter, DiffType, T >::m_dCov[Base::NbDerivatives]
protected

Computation data: derivatives of the covariance matrix.

Definition at line 153 of file covariance.h.