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

Plane fitting procedure using only points position. More...

#include <covariancePlaneFit.h>

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

Collaboration diagram for Ponca::CovariancePlaneFitImpl< 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
CovariancePlaneFitImpl< DataPoint, _NFilter, T > &	covariancePlaneFit ()
	Explicit conversion to CovariancePlaneFitImpl , to access methods potentially hidden by heritage.
const CovariancePlaneFitImpl< DataPoint, _NFilter, T > &	covariancePlaneFit () const
	Explicit conversion to CovariancePlaneFitImpl , to access methods potentially hidden by heritage.
FIT_RESULT	finalize ()
	Finalize the procedure.
constexpr bool	isSigned ()
	Is scalar field signed.
VectorType	worldToTangentPlane (const VectorType &_q) const
	Express a point in ambient space relatively to the tangent plane.
VectorType	tangentPlaneToWorld (const VectorType &_q) const
	Transform a point from the tangent plane [h, u, v]^T to ambient space.

Protected Types
enum	{ Check , PROVIDES_TANGENT_PLANE_BASIS }
using	Base = T
	Base class of the procedure.

Detailed Description

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

Plane fitting procedure using only points position.

This class can also computes the surface variation measure introduced in [13].

See also

Plane

Definition at line 34 of file covariancePlaneFit.h.

Member Typedef Documentation

Base

template<class DataPoint , class _NFilter , typename T >

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

protected

Base class of the procedure.

Definition at line 36 of file covariancePlaneFit.h.

MatrixType

template<class DataPoint , class _NFilter , typename T >

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

Alias to matrix type.

Definition at line 37 of file covariancePlaneFit.h.

NeighborFilter

template<class DataPoint , class _NFilter , typename T >

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

Alias to the filter applied on the neighbors.

Definition at line 36 of file covariancePlaneFit.h.

Scalar

template<class DataPoint , class _NFilter , typename T >

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

Alias to scalar type.

Definition at line 36 of file covariancePlaneFit.h.

VectorType

template<class DataPoint , class _NFilter , typename T >

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

Alias to vector type.

Definition at line 36 of file covariancePlaneFit.h.

Member Enumeration Documentation

anonymous enum

template<class DataPoint , class _NFilter , typename T >

anonymous enum

protected

Enumerator
PROVIDES_TANGENT_PLANE_BASIS	Expose a method worldToTangentPlane(VectorType), which turns a point in ambient 3D space to the tangent plane. See also worldToTangentPlane tangentPlaneToWorld

Definition at line 40 of file covariancePlaneFit.h.

Member Function Documentation

covariancePlaneFit() [1/2]

template<class DataPoint , class _NFilter , typename T >

CovariancePlaneFitImpl< DataPoint, _NFilter, T > & Ponca::CovariancePlaneFitImpl< DataPoint, _NFilter, T >::covariancePlaneFit ( )

inline

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

Definition at line 54 of file covariancePlaneFit.h.

covariancePlaneFit() [2/2]

template<class DataPoint , class _NFilter , typename T >

const CovariancePlaneFitImpl< DataPoint, _NFilter, T > & Ponca::CovariancePlaneFitImpl< DataPoint, _NFilter, T >::covariancePlaneFit ( ) const

inline

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

Definition at line 54 of file covariancePlaneFit.h.

finalize()

template<class DataPoint , class _NFilter , typename T >

FIT_RESULT CovariancePlaneFitImpl::finalize ( )

inline

Finalize the procedure.

Returns

Fitting Status

Warning

Must be called be for any use of the fitting output

Definition at line 15 of file covariancePlaneFit.hpp.

isSigned()

template<class DataPoint , class _NFilter , typename T >

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

inlineconstexpr

Is scalar field signed.

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

Definition at line 56 of file covariancePlaneFit.h.

tangentPlaneToWorld()

template<class DataPoint , class _NFilter , typename T >

CovariancePlaneFitImpl< DataPoint, _NFilter, T >::VectorType CovariancePlaneFitImpl::tangentPlaneToWorld ( const VectorType &  _q ) const

inline

Transform a point from the tangent plane [h, u, v]^T to ambient space.

Parameters

_q	Point coordinates expressed in local tangent frame

Returns

Point coordinates expressed in ambient space

Definition at line 34 of file covariancePlaneFit.hpp.

worldToTangentPlane()

template<class DataPoint , class _NFilter , typename T >

CovariancePlaneFitImpl< DataPoint, _NFilter, T >::VectorType CovariancePlaneFitImpl::worldToTangentPlane ( const VectorType &  _q ) const

inline

Express a point in ambient space relatively to the tangent plane.

Output vector is: [h, u, v]^T, where u, v are 2d coordinates on the plane, and h the height of the sample.

Parameters

_q	Point coordinates expressed in ambient space

Returns

Point coordinates expressed in local tangent frame

Definition at line 27 of file covariancePlaneFit.hpp.