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

Aim: A functor RealPoint -> (Scalar,Scalar,RealVector,RealVector that returns the principal curvatures and the principal directions as a tuple at given point (k1,k2,d1,d2). 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 std::tuple< Scalar, Scalar, RealVector, RealVector >	Quantity
typedef Quantity	Value

Public Member Functions
	ShapePrincipalCurvaturesAndDirectionsFunctor (ConstAlias< Shape > aShape=0)
void	attach (ConstAlias< Shape > aShape)
Quantity	operator() (const RealPoint &p) const

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

Detailed Description

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

Aim: A functor RealPoint -> (Scalar,Scalar,RealVector,RealVector that returns the principal curvatures and the principal directions as a tuple at given point (k1,k2,d1,d2).

Description of template class 'ShapePrincipalCurvaturesAndDirectionsFunctor'

Template Parameters

TShape

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

Definition at line 499 of file ShapeGeometricFunctors.h.

Member Typedef Documentation

Argument

template<typename TShape >

RealPoint DGtal::functors::ShapeGeometricFunctors::ShapePrincipalCurvaturesAndDirectionsFunctor< TShape >::Argument

Definition at line 504 of file ShapeGeometricFunctors.h.

Quantity

template<typename TShape >

std::tuple<Scalar,Scalar,RealVector,RealVector> DGtal::functors::ShapeGeometricFunctors::ShapePrincipalCurvaturesAndDirectionsFunctor< TShape >::Quantity

Definition at line 505 of file ShapeGeometricFunctors.h.

RealPoint

template<typename TShape >

Shape::RealPoint DGtal::functors::ShapeGeometricFunctors::ShapePrincipalCurvaturesAndDirectionsFunctor< TShape >::RealPoint

Definition at line 501 of file ShapeGeometricFunctors.h.

RealVector

template<typename TShape >

Shape::RealVector DGtal::functors::ShapeGeometricFunctors::ShapePrincipalCurvaturesAndDirectionsFunctor< TShape >::RealVector

Definition at line 502 of file ShapeGeometricFunctors.h.

Scalar

template<typename TShape >

RealVector::Component DGtal::functors::ShapeGeometricFunctors::ShapePrincipalCurvaturesAndDirectionsFunctor< TShape >::Scalar

Definition at line 503 of file ShapeGeometricFunctors.h.

Shape

template<typename TShape >

TShape DGtal::functors::ShapeGeometricFunctors::ShapePrincipalCurvaturesAndDirectionsFunctor< TShape >::Shape

Definition at line 500 of file ShapeGeometricFunctors.h.

Value

template<typename TShape >

Quantity DGtal::functors::ShapeGeometricFunctors::ShapePrincipalCurvaturesAndDirectionsFunctor< TShape >::Value

Definition at line 506 of file ShapeGeometricFunctors.h.

Constructor & Destructor Documentation

ShapePrincipalCurvaturesAndDirectionsFunctor()

template<typename TShape >

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

        : myShape( aShape ) {}

Member Function Documentation

attach()

template<typename TShape >

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

      {
        myShape = aShape;
      }

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

operator()()

template<typename TShape >

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

inline

Map operator RealPoint -> (Scalar,Scalar,RealVector,RealVector) giving the principal curvatures and directions (k1,k2,d1,d2).

Parameters

p	any point on the shape.

Returns

the principal curvatures and directions (k1,k2,d1,d2) at point p.

Definition at line 536 of file ShapeGeometricFunctors.h.

      {
        Scalar k1, k2;
        RealVector d1, d2;
        myShape->principalCurvatures( p, k1, k2 );
        myShape->principalDirections( p, d1, d2 );
        return std::make_tuple( k1, k2, d1, d2 );
      }

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

Field Documentation

myShape

template<typename TShape >

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

private

The shape of interest.

Definition at line 547 of file ShapeGeometricFunctors.h.

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

---

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

• ShapeGeometricFunctors.h