DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape > Struct Template Reference

Aim: A functor RealPoint -> Quantity that returns the first principal curvature at given point (i.e. smallest principal curvature). 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
	ShapeFirstPrincipalCurvatureFunctor (ConstAlias< Shape > aShape=0)
void	attach (ConstAlias< Shape > aShape)
Quantity	operator() (const RealPoint &p) const

Private Attributes
CountedConstPtrOrConstPtr< Shape >	myShape
	The shape of interest. More...

Detailed Description

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

Aim: A functor RealPoint -> Quantity that returns the first principal curvature at given point (i.e. smallest principal curvature).

Description of template class 'ShapeFirstPrincipalCurvatureFunctor'

Template Parameters

TShape

the type of the shape where geometric estimation are made. It must have method principalCurvatures.

Definition at line 273 of file ShapeGeometricFunctors.h.

Member Typedef Documentation

Argument

template<typename TShape >

typedef RealPoint DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::Argument

Definition at line 278 of file ShapeGeometricFunctors.h.

Quantity

template<typename TShape >

typedef Scalar DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::Quantity

Definition at line 279 of file ShapeGeometricFunctors.h.

RealPoint

template<typename TShape >

typedef Shape::RealPoint DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::RealPoint

Definition at line 275 of file ShapeGeometricFunctors.h.

RealVector

template<typename TShape >

typedef Shape::RealVector DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::RealVector

Definition at line 276 of file ShapeGeometricFunctors.h.

Scalar

template<typename TShape >

typedef RealVector::Component DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::Scalar

Definition at line 277 of file ShapeGeometricFunctors.h.

Shape

template<typename TShape >

typedef TShape DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::Shape

Definition at line 274 of file ShapeGeometricFunctors.h.

Value

template<typename TShape >

typedef Quantity DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::Value

Definition at line 280 of file ShapeGeometricFunctors.h.

Constructor & Destructor Documentation

ShapeFirstPrincipalCurvatureFunctor()

template<typename TShape >

DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::ShapeFirstPrincipalCurvatureFunctor ( ConstAlias< Shape >  aShape = 0 )

inline

Constructor. A shape may also be attached at construction.

Parameters

aShape

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

Definition at line 288 of file ShapeGeometricFunctors.h.

        : myShape( aShape ) {}

Member Function Documentation

attach()

template<typename TShape >

void DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::attach ( ConstAlias< Shape >  aShape )

inline

Attach a shape.

Parameters

aShape

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

Definition at line 297 of file ShapeGeometricFunctors.h.

      {
        myShape = aShape;
      }

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

operator()()

template<typename TShape >

Quantity DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::operator() ( const RealPoint &  p ) const

inline

Map operator RealPoint -> Quantity giving the first principal curvature.

Parameters

p	any point on the shape.

Returns

the first principal curvature at point p (smallest curvature).

Definition at line 307 of file ShapeGeometricFunctors.h.

      {
        Quantity k1, k2;
        myShape->principalCurvatures( p, k1, k2 );
        return k1;
      }

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

Field Documentation

myShape

template<typename TShape >

CountedConstPtrOrConstPtr<Shape> DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::myShape

private

The shape of interest.

Definition at line 316 of file ShapeGeometricFunctors.h.

Referenced by DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::attach(), and DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalCurvatureFunctor< TShape >::operator()().

---

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

• ShapeGeometricFunctors.h