DGtal  1.1.0
Public Types | Public Member Functions | Private Attributes
DGtal::ParametricShapeTangentFunctor< TParametricShape > Class Template Reference

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

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

Public Types

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

Public Member Functions

 ParametricShapeTangentFunctor ()=delete
 
 ParametricShapeTangentFunctor (const ParametricShape &aShape)
 
 ~ParametricShapeTangentFunctor ()=default
 
ParametricShapeTangentFunctoroperator= (const ParametricShapeTangentFunctor &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::ParametricShapeTangentFunctor< TParametricShape >

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

Description of template class 'ParametricShapeTangentFunctor'

Template Parameters
TParametricShapea model of parametric shape.

Definition at line 63 of file ParametricShapeTangentFunctor.h.

Member Typedef Documentation

◆ ParametricShape

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

Type of parametric shape.

Definition at line 70 of file ParametricShapeTangentFunctor.h.

◆ Quantity

template<typename TParametricShape >
typedef TParametricShape::RealPoint DGtal::ParametricShapeTangentFunctor< TParametricShape >::Quantity

Type of the functor output.

Definition at line 76 of file ParametricShapeTangentFunctor.h.

◆ RealPoint

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

Type of points.

Definition at line 73 of file ParametricShapeTangentFunctor.h.

Constructor & Destructor Documentation

◆ ParametricShapeTangentFunctor() [1/2]

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

Constructor.

◆ ParametricShapeTangentFunctor() [2/2]

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

Constructor..

Parameters
aShapethe input shape.

Definition at line 89 of file ParametricShapeTangentFunctor.h.

89 : myShape(aShape) {}

◆ ~ParametricShapeTangentFunctor()

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

Destructor.

Member Function Documentation

◆ operator()()

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

Compute the tangent at [aPoint]

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

Definition at line 115 of file ParametricShapeTangentFunctor.h.

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

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

◆ operator=()

template<typename TParametricShape >
ParametricShapeTangentFunctor& DGtal::ParametricShapeTangentFunctor< TParametricShape >::operator= ( const ParametricShapeTangentFunctor< 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::ParametricShapeTangentFunctor< TParametricShape >::myShape
private

Reference of the implicit shape.

Definition at line 126 of file ParametricShapeTangentFunctor.h.

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


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