DGtal  1.3.beta
Public Types | Public Member Functions | Private Attributes
DGtal::ParametricShapeCurvatureFunctor< TParametricShape > Class Template Reference

Aim: implements a functor that computes the curvature at a given point of a parametric shape. More...

#include <DGtal/geometry/curves/estimation/ParametricShapeCurvatureFunctor.h>

Public Types

typedef TParametricShape ParametricShape
 Type of parametric shape. More...
 
typedef TParametricShape::RealPoint RealPoint
 Type of points. More...
 
typedef double Quantity
 Type of the functor output. More...
 

Public Member Functions

 ParametricShapeCurvatureFunctor ()=delete
 
 ParametricShapeCurvatureFunctor (const ParametricShape &aShape)
 
 ~ParametricShapeCurvatureFunctor ()=default
 
ParametricShapeCurvatureFunctoroperator= (const ParametricShapeCurvatureFunctor &other)=delete
 
Quantity operator() (const RealPoint &aPoint) const
 

Private Attributes

const ParametricShapemyShape
 Reference of the implicit shape. More...
 

Detailed Description

template<typename TParametricShape>
class DGtal::ParametricShapeCurvatureFunctor< TParametricShape >

Aim: implements a functor that computes the curvature at a given point of a parametric shape.

Description of template class 'ParametricShapeCurvatureFunctor'

Note
Curvature is given by \(\kappa(t) = \frac{x'y''-y'x''}{(x'^2+y'^2)^{3/2}}\)
Template Parameters
TParametricShapea model of parametric shape.

Definition at line 65 of file ParametricShapeCurvatureFunctor.h.

Member Typedef Documentation

◆ ParametricShape

template<typename TParametricShape >
typedef TParametricShape DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::ParametricShape

Type of parametric shape.

Definition at line 72 of file ParametricShapeCurvatureFunctor.h.

◆ Quantity

template<typename TParametricShape >
typedef double DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::Quantity

Type of the functor output.

Definition at line 78 of file ParametricShapeCurvatureFunctor.h.

◆ RealPoint

template<typename TParametricShape >
typedef TParametricShape::RealPoint DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::RealPoint

Type of points.

Definition at line 75 of file ParametricShapeCurvatureFunctor.h.

Constructor & Destructor Documentation

◆ ParametricShapeCurvatureFunctor() [1/2]

template<typename TParametricShape >
DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::ParametricShapeCurvatureFunctor ( )
delete

Constructor.

◆ ParametricShapeCurvatureFunctor() [2/2]

template<typename TParametricShape >
DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::ParametricShapeCurvatureFunctor ( const ParametricShape aShape)
inline

Constructor.

Parameters
aShapethe input shape.

Definition at line 91 of file ParametricShapeCurvatureFunctor.h.

91 : myShape(aShape) {}

◆ ~ParametricShapeCurvatureFunctor()

template<typename TParametricShape >
DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::~ParametricShapeCurvatureFunctor ( )
default

Destructor.

Member Function Documentation

◆ operator()()

template<typename TParametricShape >
Quantity DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::operator() ( const RealPoint aPoint) const
inline

Computes the curvature at [aPoint]

Parameters
aPointthe point at which the curvature is computed.
Returns
the curvature at [aPoint].

Definition at line 116 of file ParametricShapeCurvatureFunctor.h.

117  {
118  double t = myShape.parameter( aPoint );
119  return myShape.curvature( t );
120  }

References aPoint(), and DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::myShape.

◆ operator=()

template<typename TParametricShape >
ParametricShapeCurvatureFunctor& DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::operator= ( const ParametricShapeCurvatureFunctor< TParametricShape > &  other)
delete

Assignment.

Parameters
otherthe object to copy.
Returns
a reference on 'this'. Forbidden by default.

Field Documentation

◆ myShape

template<typename TParametricShape >
const ParametricShape& DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::myShape
private

Reference of the implicit shape.

Definition at line 127 of file ParametricShapeCurvatureFunctor.h.

Referenced by DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::operator()().


The documentation for this class was generated from the following file:
aPoint
const Point aPoint(3, 4)
DGtal::ParametricShapeCurvatureFunctor::myShape
const ParametricShape & myShape
Reference of the implicit shape.
Definition: ParametricShapeCurvatureFunctor.h:127