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

Aim: A functor RealPoint -> Quantity that returns the second principal curvature at given point (i.e. greatest 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
	ShapeSecondPrincipalCurvatureFunctor (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::ShapeSecondPrincipalCurvatureFunctor< TShape >

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

Description of template class 'ShapeSecondPrincipalCurvatureFunctor'

Template Parameters

TShape

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

Definition at line 328 of file ShapeGeometricFunctors.h.

Member Typedef Documentation

Argument

template<typename TShape >

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

Definition at line 333 of file ShapeGeometricFunctors.h.

Quantity

template<typename TShape >

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

Definition at line 334 of file ShapeGeometricFunctors.h.

RealPoint

template<typename TShape >

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

Definition at line 330 of file ShapeGeometricFunctors.h.

RealVector

template<typename TShape >

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

Definition at line 331 of file ShapeGeometricFunctors.h.

Scalar

template<typename TShape >

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

Definition at line 332 of file ShapeGeometricFunctors.h.

Shape

template<typename TShape >

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

Definition at line 329 of file ShapeGeometricFunctors.h.

Value

template<typename TShape >

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

Definition at line 335 of file ShapeGeometricFunctors.h.

Constructor & Destructor Documentation

ShapeSecondPrincipalCurvatureFunctor()

template<typename TShape >

DGtal::functors::ShapeGeometricFunctors::ShapeSecondPrincipalCurvatureFunctor< TShape >::ShapeSecondPrincipalCurvatureFunctor ( 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 343 of file ShapeGeometricFunctors.h.

        : myShape( aShape ) {}

Member Function Documentation

attach()

template<typename TShape >

void DGtal::functors::ShapeGeometricFunctors::ShapeSecondPrincipalCurvatureFunctor< 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 352 of file ShapeGeometricFunctors.h.

      {
        myShape = aShape;
      }

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

operator()()

template<typename TShape >

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

inline

Map operator RealPoint -> Scalar giving the second principal curvature.

Parameters

p	any point on the shape.

Returns

the second principal curvature at point p (greatest curvature).

Definition at line 362 of file ShapeGeometricFunctors.h.

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

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

Field Documentation

myShape

template<typename TShape >

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

private

The shape of interest.

Definition at line 371 of file ShapeGeometricFunctors.h.

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

---

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

• ShapeGeometricFunctors.h