Ponca::GLSParam< DataPoint, _WFunctor, T > Class Template Reference

Growing Least Squares reparemetrization of the OrientedSphereFit. More...

#include <gls.h>

Inheritance diagram for Ponca::GLSParam< DataPoint, _WFunctor, T >:

Collaboration diagram for Ponca::GLSParam< DataPoint, _WFunctor, T >:

Public Types
using	Scalar = typename DataPoint::Scalar
	Alias to scalar type.
using	VectorType = typename Base::VectorType
	Alias to vector type.
using	WFunctor = typename Base::WFunctor
	Alias to weight function.

Public Member Functions
GLSParam< DataPoint, _WFunctor, T > &	glsParam ()
	Explicit conversion to GLSParam , to access methods potentially hidden by heritage.
const GLSParam< DataPoint, _WFunctor, T > &	glsParam () const
	Explicit conversion to GLSParam , to access methods potentially hidden by heritage.
FIT_RESULT	finalize ()
	Finalize the procedure.
Scalar	tau () const
	Compute and return \( \tau \).
VectorType	eta () const
	Compute and return \( \eta \).
Scalar	kappa () const
	Compute and return \( \kappa \).
Scalar	tau_normalized () const
	Compute and return \( \frac{\tau}{t} \).
VectorType	eta_normalized () const
	Compute and return \( \eta \).
Scalar	kappa_normalized () const
	Compute and return \( t \kappa \).
Scalar	fitness () const
	Return the fitness, e.g.
Scalar	compareTo (const GLSParam< DataPoint, _WFunctor, T > &_other, bool _useFitness=true) const
	Compare current instance with other.

Protected Types
enum	{ Check = Base::PROVIDES_ALGEBRAIC_SPHERE , PROVIDES_GLS_PARAMETRIZATION }
	[Requirements] More...
using	Base = T
	Base class of the procedure.

Protected Attributes
Scalar	m_fitness {0}
	[Requirements]

Detailed Description

template<class DataPoint, class _WFunctor, typename T>
class Ponca::GLSParam< DataPoint, _WFunctor, T >

Growing Least Squares reparemetrization of the OrientedSphereFit.

Method published in [10]

This class assumes that the WeightFunc defines the accessor

w.evalScale();

in order to access to the evaluation scale, needed to compute the scale invariant GLS reparametrization (all *_normalized methods).

Computed values:

• tau(), eta() and kappa(): the GLS descriptor \( \left[ \tau \; \eta \; \kappa \right]\)
• tau_normalized(), eta_normalized() and kappa_normalized(): the scale invariant GLS descriptor \( \left[ \frac{\tau}{t} \; \eta \; t\kappa \right]\)

Requirements:

PROVIDES_ALGEBRAIC_SPHERE 

Provides:

PROVIDES_GLS_PARAMETRIZATION 

Definition at line 41 of file gls.h.

Member Typedef Documentation

Base

template<class DataPoint , class _WFunctor , typename T >

using Ponca::GLSParam< DataPoint, _WFunctor, T >::Base = T

protected

Base class of the procedure.

Definition at line 43 of file gls.h.

Scalar

template<class DataPoint , class _WFunctor , typename T >

using Ponca::GLSParam< DataPoint, _WFunctor, T >::Scalar = typename DataPoint::Scalar

Alias to scalar type.

Definition at line 43 of file gls.h.

VectorType

template<class DataPoint , class _WFunctor , typename T >

using Ponca::GLSParam< DataPoint, _WFunctor, T >::VectorType = typename Base::VectorType

Alias to vector type.

Definition at line 43 of file gls.h.

WFunctor

template<class DataPoint , class _WFunctor , typename T >

using Ponca::GLSParam< DataPoint, _WFunctor, T >::WFunctor = typename Base::WFunctor

Alias to weight function.

Definition at line 43 of file gls.h.

Member Enumeration Documentation

anonymous enum

template<class DataPoint , class _WFunctor , typename T >

anonymous enum

protected

[Requirements]

Definition at line 47 of file gls.h.

Member Function Documentation

compareTo()

template<class DataPoint , class _WFunctor , typename T >

Scalar Ponca::GLSParam< DataPoint, _WFunctor, T >::compareTo ( const GLSParam< DataPoint, _WFunctor, T > &  _other, bool  _useFitness = true  ) const

inline

Compare current instance with other.

Returns

a distance between two fits (0 correspond to two similar fits)

Warning

Use the same scale to have a useful comparison (normalized value are used)

Definition at line 96 of file gls.h.

eta()

template<class DataPoint , class _WFunctor , typename T >

VectorType Ponca::GLSParam< DataPoint, _WFunctor, T >::eta ( ) const

inline

Compute and return \( \eta \).

Definition at line 71 of file gls.h.

eta_normalized()

template<class DataPoint , class _WFunctor , typename T >

VectorType Ponca::GLSParam< DataPoint, _WFunctor, T >::eta_normalized ( ) const

inline

Compute and return \( \eta \).

Definition at line 83 of file gls.h.

finalize()

template<class DataPoint , class _WFunctor , typename T >

FIT_RESULT GLSParam::finalize ( )

inline

Finalize the procedure.

Returns

Fitting Status

Warning

Must be called be for any use of the fitting output

Definition at line 9 of file gls.hpp.

fitness()

template<class DataPoint , class _WFunctor , typename T >

Scalar Ponca::GLSParam< DataPoint, _WFunctor, T >::fitness ( ) const

inline

Return the fitness, e.g.

the pratt norm of the initial scalar field

Definition at line 89 of file gls.h.

glsParam() [1/2]

template<class DataPoint , class _WFunctor , typename T >

GLSParam< DataPoint, _WFunctor, T > & Ponca::GLSParam< DataPoint, _WFunctor, T >::glsParam ( )

inline

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

Definition at line 58 of file gls.h.

glsParam() [2/2]

template<class DataPoint , class _WFunctor , typename T >

const GLSParam< DataPoint, _WFunctor, T > & Ponca::GLSParam< DataPoint, _WFunctor, T >::glsParam ( ) const

inline

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

Definition at line 58 of file gls.h.

kappa()

template<class DataPoint , class _WFunctor , typename T >

Scalar Ponca::GLSParam< DataPoint, _WFunctor, T >::kappa ( ) const

inline

Compute and return \( \kappa \).

Definition at line 74 of file gls.h.

kappa_normalized()

template<class DataPoint , class _WFunctor , typename T >

Scalar Ponca::GLSParam< DataPoint, _WFunctor, T >::kappa_normalized ( ) const

inline

Compute and return \( t \kappa \).

Definition at line 86 of file gls.h.

tau()

template<class DataPoint , class _WFunctor , typename T >

Scalar Ponca::GLSParam< DataPoint, _WFunctor, T >::tau ( ) const

inline

Compute and return \( \tau \).

Definition at line 65 of file gls.h.

tau_normalized()

template<class DataPoint , class _WFunctor , typename T >

Scalar Ponca::GLSParam< DataPoint, _WFunctor, T >::tau_normalized ( ) const

inline

Compute and return \( \frac{\tau}{t} \).

Definition at line 80 of file gls.h.

Member Data Documentation

m_fitness

template<class DataPoint , class _WFunctor , typename T >

Scalar Ponca::GLSParam< DataPoint, _WFunctor, T >::m_fitness {0}

protected

[Requirements]

Save the fitness value to avoid side effect with Pratt normalization

Definition at line 55 of file gls.h.