File failed to load: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.3/config/TeX-MML-AM_CHTML/MathJax.js
DGtal 2.0.0
DGtal::functors::ShapeGeometricFunctors::ShapeGaussianCurvatureFunctor< TShape > Struct Template Reference

Aim: A functor RealPoint -> Quantity that returns the gaussian 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

 ShapeGaussianCurvatureFunctor (ConstAlias< Shape > aShape=0)
void attach (ConstAlias< Shape > aShape)
Quantity operator() (const RealPoint &p) const

Private Attributes

CountedConstPtrOrConstPtr< ShapemyShape
 The shape of interest.

Detailed Description

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

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

Description of template class 'ShapeGaussianCurvatureFunctor'

Template Parameters
TShapethe type of the shape where geometric estimation are made. It must have method gaussianCurvature.

Definition at line 221 of file ShapeGeometricFunctors.h.

Member Typedef Documentation

◆ Argument

template<typename TShape>
typedef RealPoint DGtal::functors::ShapeGeometricFunctors::ShapeGaussianCurvatureFunctor< TShape >::Argument

Definition at line 226 of file ShapeGeometricFunctors.h.

◆ Quantity

template<typename TShape>
typedef Scalar DGtal::functors::ShapeGeometricFunctors::ShapeGaussianCurvatureFunctor< TShape >::Quantity

Definition at line 227 of file ShapeGeometricFunctors.h.

◆ RealPoint

◆ RealVector

template<typename TShape>
typedef Shape::RealVector DGtal::functors::ShapeGeometricFunctors::ShapeGaussianCurvatureFunctor< TShape >::RealVector

Definition at line 224 of file ShapeGeometricFunctors.h.

◆ Scalar

Definition at line 225 of file ShapeGeometricFunctors.h.

◆ Shape

template<typename TShape>
typedef TShape DGtal::functors::ShapeGeometricFunctors::ShapeGaussianCurvatureFunctor< TShape >::Shape

Definition at line 222 of file ShapeGeometricFunctors.h.

◆ Value

Definition at line 228 of file ShapeGeometricFunctors.h.

Constructor & Destructor Documentation

◆ ShapeGaussianCurvatureFunctor()

template<typename TShape>
DGtal::functors::ShapeGeometricFunctors::ShapeGaussianCurvatureFunctor< TShape >::ShapeGaussianCurvatureFunctor ( ConstAlias< Shape > aShape = 0)
inline

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 236 of file ShapeGeometricFunctors.h.

236: myShape( aShape ) {}
Aim: A functor RealPoint -> Quantity that returns the gaussian curvature at given point.
CountedConstPtrOrConstPtr< Shape > myShape
The shape of interest.

References myShape.

Member Function Documentation

◆ attach()

template<typename TShape>
void DGtal::functors::ShapeGeometricFunctors::ShapeGaussianCurvatureFunctor< 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 244 of file ShapeGeometricFunctors.h.

245 {
246 myShape = aShape;
247 }

References myShape.

◆ operator()()

template<typename TShape>
Quantity DGtal::functors::ShapeGeometricFunctors::ShapeGaussianCurvatureFunctor< TShape >::operator() ( const RealPoint & p) const
inline

Map operator RealPoint -> Quantity giving the Gaussian curvature.

Parameters
pany point on the shape.
Returns
the Gaussian curvature at point p.

Definition at line 254 of file ShapeGeometricFunctors.h.

255 {
256 return myShape->gaussianCurvature( p );
257 }

References myShape.

Field Documentation

◆ myShape

The shape of interest.

Definition at line 261 of file ShapeGeometricFunctors.h.

Referenced by attach(), operator()(), and ShapeGaussianCurvatureFunctor().


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