DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape > Struct Template Reference

Aim: A functor RealPoint -> Quantity that returns the mean curvature at given point. More...

#include <DGtal/shapes/ShapeGeometricFunctors.h>

Public Types
typedef TShape	Shape
typedef Shape::RealPoint	RealPoint
typedef Shape::RealVector	RealVector
typedef RealVector::Component	Scalar
typedef RealPoint	Argument
typedef Scalar	Quantity
typedef Quantity	Value

Public Member Functions
	ShapeMeanCurvatureFunctor (ConstAlias< Shape > aShape=0)
void	attach (ConstAlias< Shape > aShape)
Quantity	operator() (const RealPoint &p) const

Private Attributes
CountedConstPtrOrConstPtr< Shape >	myShape
	The shape of interest. More...

Detailed Description

template<typename TShape>
struct DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >

Aim: A functor RealPoint -> Quantity that returns the mean curvature at given point.

Description of template class 'ShapeMeanCurvatureFunctor'

Template Parameters

TShape

the type of the shape where geometric estimation are made. It must have method meanCurvature.

Definition at line 169 of file ShapeGeometricFunctors.h.

Member Typedef Documentation

Argument

template<typename TShape >

typedef RealPoint DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::Argument

Definition at line 174 of file ShapeGeometricFunctors.h.

Quantity

template<typename TShape >

typedef Scalar DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::Quantity

Definition at line 175 of file ShapeGeometricFunctors.h.

RealPoint

template<typename TShape >

typedef Shape::RealPoint DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::RealPoint

Definition at line 171 of file ShapeGeometricFunctors.h.

RealVector

template<typename TShape >

typedef Shape::RealVector DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::RealVector

Definition at line 172 of file ShapeGeometricFunctors.h.

Scalar

template<typename TShape >

typedef RealVector::Component DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::Scalar

Definition at line 173 of file ShapeGeometricFunctors.h.

Shape

template<typename TShape >

typedef TShape DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::Shape

Definition at line 170 of file ShapeGeometricFunctors.h.

Value

template<typename TShape >

typedef Quantity DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::Value

Definition at line 176 of file ShapeGeometricFunctors.h.

Constructor & Destructor Documentation

ShapeMeanCurvatureFunctor()

template<typename TShape >

DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::ShapeMeanCurvatureFunctor ( ConstAlias< Shape >  aShape = 0 )

inline

Constructor. A shape may also be attached at construction.

Parameters

aShape

the shape of interest. The alias can be secured if a some counted pointer is handed.

Definition at line 184 of file ShapeGeometricFunctors.h.

: myShape( aShape ) {}

Member Function Documentation

attach()

template<typename TShape >

void DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::attach ( ConstAlias< Shape >  aShape )

inline

Attach a shape.

Parameters

aShape

the shape of interest. The alias can be secured if a some counted pointer is handed.

Definition at line 192 of file ShapeGeometricFunctors.h.

      {
        myShape = aShape;
      }

References DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::myShape.

operator()()

template<typename TShape >

Quantity DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::operator() ( const RealPoint &  p ) const

inline

Map operator RealPoint -> Quantity giving the mean curvature.

Parameters

p	any point on the shape.

Returns

the mean curvature at point p.

Definition at line 202 of file ShapeGeometricFunctors.h.

      {
        return myShape->meanCurvature( p );
      }

References DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::myShape.

Field Documentation

myShape

template<typename TShape >

CountedConstPtrOrConstPtr<Shape> DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::myShape

private

The shape of interest.

Definition at line 209 of file ShapeGeometricFunctors.h.

Referenced by DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::attach(), and DGtal::functors::ShapeGeometricFunctors::ShapeMeanCurvatureFunctor< TShape >::operator()().

---

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

• ShapeGeometricFunctors.h