DGtal: DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder

Aim: Estimates Gaussian curvature using CGAL Jet Fitting and Monge Form. More...

#include <DGtal/geometry/surfaces/estimation/estimationFunctors/MongeJetFittingPrincipalCurvaturesEstimator.h>

Public Types
typedef TSurfel	Surfel

typedef TEmbedder	SCellEmbedder

typedef std::pair< double, double >	Quantity

typedef SCellEmbedder::RealPoint	RealPoint

typedef CGAL::Cartesian< double >	CGALKernel

typedef CGALKernel::Point_3	CGALPoint

typedef CGAL::Monge_via_jet_fitting< CGALKernel >	CGALMongeViaJet

typedef CGALMongeViaJet::Monge_form	CGALMongeForm

Public Member Functions
	MongeJetFittingPrincipalCurvaturesEstimator (ConstAlias< SCellEmbedder > anEmbedder, const double h, unsigned int d=4)

void	pushSurfel (const Surfel &aSurf, const double aDistance)

Quantity	eval ()

void	reset ()

Private Attributes
const SCellEmbedder *	myEmbedder
	Alias of the geometrical embedder. More...

std::vector< CGALPoint >	myPoints
	Array of CGAL points. More...

double	myH
	Grid Step. More...

unsigned int	myD
	Degree of the polynomial surface to fit. More...

Detailed Description

template<typename TSurfel, typename TEmbedder>
class DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >

Aim: Estimates Gaussian curvature using CGAL Jet Fitting and Monge Form.

Description of template class 'MongeJetFittingPrincipalCurvaturesEstimator'

model of concepts::CLocalEstimatorFromSurfelFunctor.

Template Parameters

TSurfel	type of surfels
TEmbedder	type of functors which embed surfel to \( \mathbb{R}^3\)

Definition at line 77 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

Member Typedef Documentation

◆ CGALKernel

template<typename TSurfel , typename TEmbedder >

typedef CGAL::Cartesian<double> DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::CGALKernel

Definition at line 86 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

◆ CGALMongeForm

template<typename TSurfel , typename TEmbedder >

typedef CGALMongeViaJet::Monge_form DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::CGALMongeForm

Definition at line 89 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

◆ CGALMongeViaJet

template<typename TSurfel , typename TEmbedder >

typedef CGAL::Monge_via_jet_fitting<CGALKernel> DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::CGALMongeViaJet

Definition at line 88 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

◆ CGALPoint

template<typename TSurfel , typename TEmbedder >

typedef CGALKernel::Point_3 DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::CGALPoint

Definition at line 87 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

◆ Quantity

template<typename TSurfel , typename TEmbedder >

typedef std::pair<double, double> DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::Quantity

Definition at line 83 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

◆ RealPoint

template<typename TSurfel , typename TEmbedder >

typedef SCellEmbedder::RealPoint DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::RealPoint

Definition at line 84 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

◆ SCellEmbedder

template<typename TSurfel , typename TEmbedder >

typedef TEmbedder DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::SCellEmbedder

Definition at line 82 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

◆ Surfel

template<typename TSurfel , typename TEmbedder >

typedef TSurfel DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::Surfel

Definition at line 81 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

Constructor & Destructor Documentation

◆ MongeJetFittingPrincipalCurvaturesEstimator()

template<typename TSurfel , typename TEmbedder >

DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::MongeJetFittingPrincipalCurvaturesEstimator	(	ConstAlias< SCellEmbedder >	anEmbedder,
		const double	h,
		unsigned int	d = `4`
	)

inline

Constructor.

Parameters

anEmbedder	embedder to map surfel to R^n.
h	gridstep
d	degree of the polynomial surface to fit.

Definition at line 99 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

                                                                                                                          :
       myEmbedder(&anEmbedder), myH(h), myD(d)
     {
        FATAL_ERROR_MSG(d>=2, "Polynomial surface degree must be greater than 2");
     }

Member Function Documentation

◆ eval()

template<typename TSurfel , typename TEmbedder >

Quantity DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::eval ( )

inline

Evaluate the curvature from Monge form.

Returns: the mean curvature

Definition at line 126 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

     {
       CGALMongeForm monge_form;
       CGALMongeViaJet monge_fit;
  
       monge_form = monge_fit(myPoints.begin() , myPoints.end(), myD, (2<myD)? myD : 2);
  
       double k1 = monge_form.principal_curvatures ( 0 );
       double k2 = monge_form.principal_curvatures ( 1 );
       Quantity result;
       result.first = k1;
       result.second = k2;
       return result;
     }

References DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::myD, and DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::myPoints.

◆ pushSurfel()

template<typename TSurfel , typename TEmbedder >

void DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::pushSurfel	(	const Surfel &	aSurf,
		const double	aDistance
	)

inline

Add the geometrical embedding of a surfel to the point list

Parameters

aSurf	a surfel to add
aDistance	distance of aSurf to the neighborhood boundary

Definition at line 111 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

     {
       BOOST_VERIFY(aDistance==aDistance);
  
       RealPoint p = myEmbedder->operator()(aSurf);
       CGALPoint pp(p[0]*myH,p[1]*myH,p[2]*myH);
       myPoints.push_back(pp);
     }

References DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::myEmbedder, DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::myH, and DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::myPoints.

◆ reset()

template<typename TSurfel , typename TEmbedder >

void DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::reset ( )

inline

Reset the point list.

Definition at line 145 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

     {
       myPoints.clear();
     }

References DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::myPoints.

Field Documentation

◆ myD

template<typename TSurfel , typename TEmbedder >

unsigned int DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::myD

private

Degree of the polynomial surface to fit.

Definition at line 163 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

Referenced by DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::eval().

◆ myEmbedder

template<typename TSurfel , typename TEmbedder >

const SCellEmbedder* DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::myEmbedder

private

Alias of the geometrical embedder.

Definition at line 154 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

Referenced by DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::pushSurfel().

◆ myH

template<typename TSurfel , typename TEmbedder >

double DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::myH

private

Grid Step.

Definition at line 160 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

Referenced by DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::pushSurfel().

◆ myPoints

template<typename TSurfel , typename TEmbedder >

std::vector<CGALPoint> DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::myPoints

private

Array of CGAL points.

Definition at line 157 of file MongeJetFittingPrincipalCurvaturesEstimator.h.

Referenced by DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::eval(), DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::pushSurfel(), and DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >::reset().

The documentation for this class was generated from the following file:

MongeJetFittingPrincipalCurvaturesEstimator.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

template<typename TSurfel, typename TEmbedder> class DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >

Member Typedef Documentation

◆ CGALKernel

◆ CGALMongeForm

◆ CGALMongeViaJet

◆ CGALPoint

◆ Quantity

◆ RealPoint

◆ SCellEmbedder

◆ Surfel

Constructor & Destructor Documentation

◆ MongeJetFittingPrincipalCurvaturesEstimator()

Member Function Documentation

◆ eval()

◆ pushSurfel()

◆ reset()

Field Documentation

◆ myD

◆ myEmbedder

◆ myH

◆ myPoints

template<typename TSurfel, typename TEmbedder>
class DGtal::functors::MongeJetFittingPrincipalCurvaturesEstimator< TSurfel, TEmbedder >