Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T > Class Template Reference

Line fitting procedure that minimize the orthogonal distance between the samples and the fitted primitive. More...

#include <covarianceLineFit.h>

Inheritance diagram for Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T >:

Collaboration diagram for Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, 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.

Public Member Functions
CovarianceLineFitImpl< DataPoint, _NFilter, T > &	covarianceLineFit ()
	Explicit conversion to CovarianceLineFitImpl , to access methods potentially hidden by heritage.
const CovarianceLineFitImpl< DataPoint, _NFilter, T > &	covarianceLineFit () const
	Explicit conversion to CovarianceLineFitImpl , to access methods potentially hidden by heritage.
FIT_RESULT	finalize ()
	Finalize the procedure.
constexpr bool	isSigned ()
	Is scalar field signed.

Protected Types
enum	{ check }
using	Base = T
	Base class of the procedure.

Detailed Description

template<class DataPoint, class _NFilter, typename T>
class Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T >

Line fitting procedure that minimize the orthogonal distance between the samples and the fitted primitive.

See also

Line

CovariancePlaneFit which use a similar approach for Plane estimation

Warning

This class is valid only in 3D.

Definition at line 34 of file covarianceLineFit.h.

Member Typedef Documentation

Base

template<class DataPoint , class _NFilter , typename T >

using Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T >::Base = T

protected

Base class of the procedure.

Definition at line 36 of file covarianceLineFit.h.

MatrixType

template<class DataPoint , class _NFilter , typename T >

using Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T >::MatrixType = typename DataPoint::MatrixType

Alias to matrix type.

Definition at line 37 of file covarianceLineFit.h.

NeighborFilter

template<class DataPoint , class _NFilter , typename T >

using Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T >::NeighborFilter = typename Base::NeighborFilter

Alias to the filter applied on the neighbors.

Definition at line 36 of file covarianceLineFit.h.

Scalar

template<class DataPoint , class _NFilter , typename T >

using Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T >::Scalar = typename DataPoint::Scalar

Alias to scalar type.

Definition at line 36 of file covarianceLineFit.h.

VectorType

template<class DataPoint , class _NFilter , typename T >

using Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T >::VectorType = typename Base::VectorType

Alias to vector type.

Definition at line 36 of file covarianceLineFit.h.

Member Enumeration Documentation

anonymous enum

template<class DataPoint , class _NFilter , typename T >

anonymous enum

protected

Definition at line 40 of file covarianceLineFit.h.

Member Function Documentation

covarianceLineFit() [1/2]

template<class DataPoint , class _NFilter , typename T >

CovarianceLineFitImpl< DataPoint, _NFilter, T > & Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T >::covarianceLineFit ( )

inline

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

Definition at line 47 of file covarianceLineFit.h.

covarianceLineFit() [2/2]

template<class DataPoint , class _NFilter , typename T >

const CovarianceLineFitImpl< DataPoint, _NFilter, T > & Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T >::covarianceLineFit ( ) const

inline

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

Definition at line 47 of file covarianceLineFit.h.

finalize()

template<class DataPoint , class _NFilter , typename T >

FIT_RESULT Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T >::finalize ( )

inline

Finalize the procedure.

Returns

Fitting Status

Warning

Must be called be for any use of the fitting output

Definition at line 50 of file covarianceLineFit.h.

isSigned()

template<class DataPoint , class _NFilter , typename T >

constexpr bool Ponca::CovarianceLineFitImpl< DataPoint, _NFilter, T >::isSigned ( )

inlineconstexpr

Is scalar field signed.

If not, the method the sign of potential() must be ignored

Definition at line 59 of file covarianceLineFit.h.