Aim: this class adapts any local functor on digital surface element to define a local estimator. This class is model of CDigitalSurfaceLocalEstimator. More...

#include <DGtal/geometry/surfaces/estimation/LocalEstimatorFromSurfelFunctorAdapter.h>

Public Types
typedef TDigitalSurfaceContainer	DigitalSurfaceContainer
	Digital surface container type.
typedef TMetric	Metric
	Metric type.
typedef Metric::Value	Value
	Metric value type.
typedef Metric::Point	Point
	Metric point type.
typedef TFunctorOnSurfel	FunctorOnSurfel
	Functor on surfels type.
typedef TConvolutionFunctor	ConvolutionFunctor
	Functor on double to compute convolution weights.
typedef TFunctorOnSurfel::Quantity	Quantity
	Quantity type.
typedef double	Scalar
	The "real number" type.
typedef DigitalSurface< DigitalSurfaceContainer >	Surface
	Digital surface type.
typedef DigitalSurfaceContainer::Surfel	Surfel
	Surfel type.

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CMetricSpace< TMetric >))
	Concept Checks.
	BOOST_CONCEPT_ASSERT ((concepts::CLocalEstimatorFromSurfelFunctor< TFunctorOnSurfel >))
	BOOST_CONCEPT_ASSERT ((concepts::CUnaryFunctor< TConvolutionFunctor, double, double >))
	BOOST_CONCEPT_ASSERT ((concepts::CDigitalSurfaceContainer< TDigitalSurfaceContainer >))
	BOOST_STATIC_ASSERT ((concepts::ConceptUtils::SameType< typename Point::Component, double >::value))
	The point must be a real point.
	LocalEstimatorFromSurfelFunctorAdapter ()
	LocalEstimatorFromSurfelFunctorAdapter (ConstAlias< Surface > aSurface, ConstAlias< TMetric > aMetric, Alias< FunctorOnSurfel > aFunctor, ConstAlias< ConvolutionFunctor > aConvolutionFunctor)
	LocalEstimatorFromSurfelFunctorAdapter (const LocalEstimatorFromSurfelFunctorAdapter &other)
LocalEstimatorFromSurfelFunctorAdapter &	operator= (const LocalEstimatorFromSurfelFunctorAdapter &other)
	~LocalEstimatorFromSurfelFunctorAdapter ()
Scalar	h () const
void	attach (ConstAlias< Surface > aSurface)
void	setParams (ConstAlias< TMetric > aMetric, Alias< FunctorOnSurfel > aFunctor, ConstAlias< ConvolutionFunctor > aConvolutionFunctor, const Value radius)
template<typename SurfelConstIterator>
void	init (const double _h, SurfelConstIterator itb, SurfelConstIterator ite)
template<typename SurfelConstIterator>
Quantity	eval (const SurfelConstIterator &it) const
Quantity	eval (const Surfel &scell) const
template<typename SurfelConstIterator, typename OutputIterator>
OutputIterator	eval (const SurfelConstIterator &itb, const SurfelConstIterator &ite, OutputIterator result) const
template<typename OutputIterator>
OutputIterator	evalAll (OutputIterator result) const
void	selfDisplay (std::ostream &out) const
bool	isValid () const

Private Types
typedef FunctorOnSurfel::SCellEmbedder	Embedder
	Embedded and type definitions.
typedef Embedder::RealPoint	RealPoint
	Real point type.
typedef std::function< Value(Point) >	MetricToPoint
typedef functors::Composer< Embedder, MetricToPoint, Value >	VertexFunctor
typedef DistanceBreadthFirstVisitor< Surface, VertexFunctor >	Visitor

Private Attributes
CountedConstPtrOrConstPtr< Surface >	mySurface
	Digital surface member.
FunctorOnSurfel *	myFunctor
	Functor member.
CountedConstPtrOrConstPtr< Metric >	myMetric
	Distance functor.
double	myH
	Grid step.
bool	myInit
	Has init been done before eval.
Embedder	myEmbedder
	Embedder object.
CountedConstPtrOrConstPtr< ConvolutionFunctor >	myConvFunctor
	Convolution functor.
Value	myRadius
	Ball radius.

Detailed Description

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>
class DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >

Aim: this class adapts any local functor on digital surface element to define a local estimator. This class is model of CDigitalSurfaceLocalEstimator.

Description of template class 'LocalEstimatorFromSurfelFunctorAdapter'

When we evaluate the adapted estimator at a surfel s, we first identify the set of neighboring around s using a DistanceBreadthFirstVisitor parametrized by a given metric. Then, the estimated quantity is computed applying a functor on the surfel set.

More precisely, this adapter needs a model of CMetricSpace to define the neighborhood and a model of CLocalEstimatorFromSurfelFunctor to perform the local estimator computation. When sent to the functor, the surfels are weighted using the distance from the kernel boundary: weights are defined in [0,1] interval, 1 for the center and decreasing to 0 with the distance to the specified kernel radius specified during the init(). The shape of the distance-to-weight function is defined by a functor of type TConvolutionFunctor.

During the init() method, we thus specify the gridstep h and the radius of the ball to consider to define the neighborhood. An instance of the convolution functor should be passed to the constructor.

Note that the visitor used in this class considers the distance function in the ambient space (not a geodesic one for instance) on canonical embedding of surfel elements (cf CanonicSCellEmbedder).

Template Parameters

TDigitalSurfaceContainer	any model of digital surface container concept (CDigitalSurfaceContainer)
TMetric	any model of CMetricSpace to be used in the neighborhood construction on RealPoint (e.g. LpMetric)
TFunctorOnSurfel	an estimator on surfel set (model of CLocalEstimatorFromSurfelFunctor)
TConvolutionFunctor	type of functor on double [0,1]->[0,1] to implement the response of a symmetric convolution kernel.

Definition at line 103 of file LocalEstimatorFromSurfelFunctorAdapter.h.

Member Typedef Documentation

◆ ConvolutionFunctor

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef TConvolutionFunctor DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::ConvolutionFunctor

Functor on double to compute convolution weights.

Definition at line 132 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ DigitalSurfaceContainer

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef TDigitalSurfaceContainer DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::DigitalSurfaceContainer

Digital surface container type.

Definition at line 115 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ Embedder

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef FunctorOnSurfel::SCellEmbedder DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::Embedder

private

Embedded and type definitions.

Definition at line 151 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ FunctorOnSurfel

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef TFunctorOnSurfel DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::FunctorOnSurfel

Functor on surfels type.

Definition at line 129 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ Metric

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef TMetric DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::Metric

Metric type.

Definition at line 118 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ MetricToPoint

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef std::function< Value ( Point ) > DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::MetricToPoint

private

Definition at line 154 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ Point

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef Metric::Point DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::Point

Metric point type.

Definition at line 124 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ Quantity

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef TFunctorOnSurfel::Quantity DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::Quantity

Quantity type.

Definition at line 135 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ RealPoint

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef Embedder::RealPoint DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::RealPoint

private

Real point type.

Definition at line 153 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ Scalar

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef double DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::Scalar

The "real number" type.

Definition at line 138 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ Surface

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef DigitalSurface< DigitalSurfaceContainer > DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::Surface

Digital surface type.

Definition at line 141 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ Surfel

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef DigitalSurfaceContainer::Surfel DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::Surfel

Surfel type.

Definition at line 144 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ Value

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef Metric::Value DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::Value

Metric value type.

Definition at line 121 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ VertexFunctor

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef functors::Composer<Embedder, MetricToPoint, Value> DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::VertexFunctor

private

Definition at line 155 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ Visitor

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

typedef DistanceBreadthFirstVisitor< Surface, VertexFunctor> DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::Visitor

private

Definition at line 157 of file LocalEstimatorFromSurfelFunctorAdapter.h.

Constructor & Destructor Documentation

◆ LocalEstimatorFromSurfelFunctorAdapter() [1/3]

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::LocalEstimatorFromSurfelFunctorAdapter ( )

Default constructor.

Referenced by LocalEstimatorFromSurfelFunctorAdapter(), and operator=().

◆ LocalEstimatorFromSurfelFunctorAdapter() [2/3]

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::LocalEstimatorFromSurfelFunctorAdapter	(	ConstAlias< Surface >	aSurface,
		ConstAlias< TMetric >	aMetric,
		Alias< FunctorOnSurfel >	aFunctor,
		ConstAlias< ConvolutionFunctor >	aConvolutionFunctor )

Constructor.

Parameters

aSurface	a digital surface
aMetric	the metric
aFunctor	a functor on digital surface elements (e.g. the normal or the curvature estimation)
aConvolutionFunctor	a functor giving the weight as a function of the distance to the surfel.

◆ LocalEstimatorFromSurfelFunctorAdapter() [3/3]

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::LocalEstimatorFromSurfelFunctorAdapter ( const LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor > & other )

inline

Copy constructor.

Parameters

other the object to clone. Forbidden by default.

Definition at line 190 of file LocalEstimatorFromSurfelFunctorAdapter.h.

190 :

191 mySurface(other.mySurface), myFunctor(other.myFunctor), myMetric(other.myMetric),

192 myEmbedder(other.myEmbedder), myConvFunctor(other.myConvFunctor)

193 { }

DGtal::LocalEstimatorFromSurfelFunctorAdapter

Aim: this class adapts any local functor on digital surface element to define a local estimator....

Definition LocalEstimatorFromSurfelFunctorAdapter.h:104

DGtal::LocalEstimatorFromSurfelFunctorAdapter::myConvFunctor

CountedConstPtrOrConstPtr< ConvolutionFunctor > myConvFunctor

Convolution functor.

Definition LocalEstimatorFromSurfelFunctorAdapter.h:339

DGtal::LocalEstimatorFromSurfelFunctorAdapter::myMetric

CountedConstPtrOrConstPtr< Metric > myMetric

Distance functor.

Definition LocalEstimatorFromSurfelFunctorAdapter.h:327

DGtal::LocalEstimatorFromSurfelFunctorAdapter::myEmbedder

Embedder myEmbedder

Embedder object.

Definition LocalEstimatorFromSurfelFunctorAdapter.h:336

DGtal::LocalEstimatorFromSurfelFunctorAdapter::mySurface

CountedConstPtrOrConstPtr< Surface > mySurface

Digital surface member.

Definition LocalEstimatorFromSurfelFunctorAdapter.h:321

DGtal::LocalEstimatorFromSurfelFunctorAdapter::myFunctor

FunctorOnSurfel * myFunctor

Functor member.

Definition LocalEstimatorFromSurfelFunctorAdapter.h:324

References LocalEstimatorFromSurfelFunctorAdapter(), myConvFunctor, myEmbedder, myFunctor, myMetric, and mySurface.

◆ ~LocalEstimatorFromSurfelFunctorAdapter()

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::~LocalEstimatorFromSurfelFunctorAdapter ( )

Destructor.

Member Function Documentation

◆ attach()

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

void DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::attach ( ConstAlias< Surface > aSurface )

Attach a digital surface. After this call, the object is then invalid and the user must called setParams.

Parameters

aSurface the digital surface that is aliased in this. The user can secure the aliasing by passing a CountedConstPtrOrConstPtr.

◆ BOOST_CONCEPT_ASSERT() [1/4]

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::BOOST_CONCEPT_ASSERT ( (concepts::CDigitalSurfaceContainer< TDigitalSurfaceContainer >) )

◆ BOOST_CONCEPT_ASSERT() [2/4]

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::BOOST_CONCEPT_ASSERT ( (concepts::CLocalEstimatorFromSurfelFunctor< TFunctorOnSurfel >) )

◆ BOOST_CONCEPT_ASSERT() [3/4]

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::BOOST_CONCEPT_ASSERT ( (concepts::CMetricSpace< TMetric >) )

Concept Checks.

◆ BOOST_CONCEPT_ASSERT() [4/4]

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::BOOST_CONCEPT_ASSERT ( (concepts::CUnaryFunctor< TConvolutionFunctor, double, double >) )

◆ BOOST_STATIC_ASSERT()

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::BOOST_STATIC_ASSERT ( (concepts::ConceptUtils::SameType< typename Point::Component, double >::value) )

The point must be a real point.

References DGtal::concepts::ConceptUtils::SameType< T1, T2 >::value.

◆ eval() [1/3]

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

Quantity DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::eval ( const Surfel & scell ) const

Returns: the estimated quantity at scell

Parameters

[in] scell the surfel at which we evaluate the quantity.

◆ eval() [2/3]

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

template<typename SurfelConstIterator>

Quantity DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::eval ( const SurfelConstIterator & it ) const

Returns: the estimated quantity at *it

Parameters

[in] it the surfel iterator at which we evaluate the quantity.

◆ eval() [3/3]

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

template<typename SurfelConstIterator, typename OutputIterator>

OutputIterator DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::eval	(	const SurfelConstIterator &	itb,
		const SurfelConstIterator &	ite,
		OutputIterator	result ) const

Returns: the estimated quantity in the range [itb,ite)

Parameters

[in]	itb	starting surfel iterator.
[in]	ite	end surfel iterator.
[in,out]	result	resulting output iterator

◆ evalAll()

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

template<typename OutputIterator>

OutputIterator DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::evalAll ( OutputIterator result ) const

Writes on result the estimated quantity at all surfels of the digital surface.

Parameters

result any model of boost::OutputIterator on Quantity.

Returns: the output iterator after the last write.

◆ h()

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

Scalar DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::h ( ) const

Returns: the gridstep.

Precondition: must be called after init

◆ init()

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

template<typename SurfelConstIterator>

void DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::init	(	const double	_h,
		SurfelConstIterator	itb,
		SurfelConstIterator	ite )

Initialisation of estimator parameters.

Parameters

[in]	_h	grid size (must be >0).
[in]	itb	iterator after the last surfel of the surface.
[in]	ite	iterator on the first surfel of the surface.

◆ isValid()

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

bool DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::isValid ( ) const

Checks the validity/consistency of the object.

Returns: 'true' if the object is valid, 'false' otherwise.

◆ operator=()

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

LocalEstimatorFromSurfelFunctorAdapter & DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::operator= ( const LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor > & other )

inline

Assignment.

Parameters

other the object to copy.

Returns: a reference on 'this'. Forbidden by default.

Definition at line 202 of file LocalEstimatorFromSurfelFunctorAdapter.h.

    {
      mySurface = other.mySurface;
      myFunctor = other.myFunctor;
      myMetric = other.myMetric;
      myEmbedder = other.myEmbedder;
      myConvFunctor = other.myConvFunctor;
      return *this;
    }

References LocalEstimatorFromSurfelFunctorAdapter(), myConvFunctor, myEmbedder, myFunctor, myMetric, and mySurface.

◆ selfDisplay()

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

void DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::selfDisplay ( std::ostream & out ) const

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

◆ setParams()

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

void DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::setParams	(	ConstAlias< TMetric >	aMetric,
		Alias< FunctorOnSurfel >	aFunctor,
		ConstAlias< ConvolutionFunctor >	aConvolutionFunctor,
		const Value	radius )

Initialisation of estimator specific parameters.

Parameters

aMetric	the metric
aFunctor	a functor on digital surface elements (e.g. the normal or the curvature estimation)
aConvolutionFunctor	a functor giving the weight as a function of the distance to the surfel.
radius	a kernel radius.

Field Documentation

◆ myConvFunctor

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

CountedConstPtrOrConstPtr<ConvolutionFunctor> DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::myConvFunctor

private

Convolution functor.

Definition at line 339 of file LocalEstimatorFromSurfelFunctorAdapter.h.

Referenced by LocalEstimatorFromSurfelFunctorAdapter(), and operator=().

◆ myEmbedder

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

Embedder DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::myEmbedder

private

Embedder object.

Definition at line 336 of file LocalEstimatorFromSurfelFunctorAdapter.h.

Referenced by LocalEstimatorFromSurfelFunctorAdapter(), and operator=().

◆ myFunctor

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

FunctorOnSurfel* DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::myFunctor

private

Functor member.

Definition at line 324 of file LocalEstimatorFromSurfelFunctorAdapter.h.

Referenced by LocalEstimatorFromSurfelFunctorAdapter(), and operator=().

◆ myH

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

double DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::myH

private

Grid step.

Definition at line 330 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ myInit

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

bool DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::myInit

private

Has init been done before eval.

Definition at line 333 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ myMetric

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

CountedConstPtrOrConstPtr<Metric> DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::myMetric

private

Distance functor.

Definition at line 327 of file LocalEstimatorFromSurfelFunctorAdapter.h.

Referenced by LocalEstimatorFromSurfelFunctorAdapter(), and operator=().

◆ myRadius

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

Value DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::myRadius

private

Ball radius.

Definition at line 342 of file LocalEstimatorFromSurfelFunctorAdapter.h.

◆ mySurface

template<typename TDigitalSurfaceContainer, typename TMetric, typename TFunctorOnSurfel, typename TConvolutionFunctor>

CountedConstPtrOrConstPtr<Surface> DGtal::LocalEstimatorFromSurfelFunctorAdapter< TDigitalSurfaceContainer, TMetric, TFunctorOnSurfel, TConvolutionFunctor >::mySurface

private

Digital surface member.

Definition at line 321 of file LocalEstimatorFromSurfelFunctorAdapter.h.

Referenced by LocalEstimatorFromSurfelFunctorAdapter(), and operator=().

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

LocalEstimatorFromSurfelFunctorAdapter.h

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ConvolutionFunctor

◆ DigitalSurfaceContainer

◆ Embedder

◆ FunctorOnSurfel

◆ Metric

◆ MetricToPoint

◆ Point

◆ Quantity

◆ RealPoint

◆ Scalar

◆ Surface

◆ Surfel

◆ Value

◆ VertexFunctor

◆ Visitor

Constructor & Destructor Documentation

◆ LocalEstimatorFromSurfelFunctorAdapter() [1/3]

◆ LocalEstimatorFromSurfelFunctorAdapter() [2/3]

◆ LocalEstimatorFromSurfelFunctorAdapter() [3/3]

◆ ~LocalEstimatorFromSurfelFunctorAdapter()

Member Function Documentation

◆ attach()

◆ BOOST_CONCEPT_ASSERT() [1/4]

◆ BOOST_CONCEPT_ASSERT() [2/4]

◆ BOOST_CONCEPT_ASSERT() [3/4]

◆ BOOST_CONCEPT_ASSERT() [4/4]

◆ BOOST_STATIC_ASSERT()

◆ eval() [1/3]

◆ eval() [2/3]

◆ eval() [3/3]

◆ evalAll()

◆ h()

◆ init()

◆ isValid()

◆ operator=()

◆ selfDisplay()

◆ setParams()

Field Documentation

◆ myConvFunctor

◆ myEmbedder

◆ myFunctor

◆ myH

◆ myInit

◆ myMetric

◆ myRadius

◆ mySurface