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.
typedef TParametricShape::RealPoint	RealPoint
	Type of points.
typedef double	Quantity
	Type of the functor output.

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

Private Attributes
const ParametricShape &	myShape
	Reference of the implicit shape.

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

TParametricShape

a 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.

Referenced by operator=().

ParametricShapeCurvatureFunctor() [2/2]

template<typename TParametricShape>

DGtal::ParametricShapeCurvatureFunctor< TParametricShape >::ParametricShapeCurvatureFunctor ( const ParametricShape & aShape )

inline

Constructor.

Parameters

aShape

the input shape.

Definition at line 91 of file ParametricShapeCurvatureFunctor.h.

: myShape(aShape) {}

References myShape.

~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

aPoint

the point at which the curvature is computed.

Returns

the curvature at [aPoint].

Definition at line 116 of file ParametricShapeCurvatureFunctor.h.

    {
      double t = myShape.parameter( aPoint );
      return myShape.curvature( t );
    }

References aPoint, and myShape.

operator=()

template<typename TParametricShape>

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

delete

Assignment.

Parameters

other

the object to copy.

Returns

a reference on 'this'. Forbidden by default.

References ParametricShapeCurvatureFunctor().

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 operator()(), and ParametricShapeCurvatureFunctor().

---

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

• ParametricShapeCurvatureFunctor.h