DGtal  1.5.beta
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< ShapemyShape
 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
TShapethe 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

Definition at line 174 of file ShapeGeometricFunctors.h.

◆ Quantity

Definition at line 175 of file ShapeGeometricFunctors.h.

◆ RealPoint

Definition at line 171 of file ShapeGeometricFunctors.h.

◆ RealVector

Definition at line 172 of file ShapeGeometricFunctors.h.

◆ 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

Definition at line 176 of file ShapeGeometricFunctors.h.

Constructor & Destructor Documentation

◆ ShapeMeanCurvatureFunctor()

Constructor. A shape may also be attached at construction.

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

Definition at line 184 of file ShapeGeometricFunctors.h.

184 : myShape( aShape ) {}
CountedConstPtrOrConstPtr< Shape > myShape
The shape of interest.

Member Function Documentation

◆ attach()

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

Attach a shape.

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

Definition at line 192 of file ShapeGeometricFunctors.h.

193  {
194  myShape = aShape;
195  }

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
pany point on the shape.
Returns
the mean curvature at point p.

Definition at line 202 of file ShapeGeometricFunctors.h.

203  {
204  return myShape->meanCurvature( p );
205  }

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

Field Documentation

◆ myShape


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