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

Aim: A functor RealPoint -> RealVector that returns the first principal direction at given point (i.e. direction of 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 RealVector	Quantity
typedef Quantity	Value

Public Member Functions
	ShapeFirstPrincipalDirectionFunctor (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::ShapeFirstPrincipalDirectionFunctor< TShape >

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

Description of template class 'ShapeFirstPrincipalDirectionFunctor'

Template Parameters

TShape

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

Definition at line 385 of file ShapeGeometricFunctors.h.

Member Typedef Documentation

Argument

template<typename TShape >

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

Definition at line 390 of file ShapeGeometricFunctors.h.

Quantity

template<typename TShape >

typedef RealVector DGtal::functors::ShapeGeometricFunctors::ShapeFirstPrincipalDirectionFunctor< TShape >::Quantity

Definition at line 391 of file ShapeGeometricFunctors.h.

RealPoint

template<typename TShape >

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

Definition at line 387 of file ShapeGeometricFunctors.h.

RealVector

template<typename TShape >

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

Definition at line 388 of file ShapeGeometricFunctors.h.

Scalar

template<typename TShape >

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

Definition at line 389 of file ShapeGeometricFunctors.h.

Shape

template<typename TShape >

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

Definition at line 386 of file ShapeGeometricFunctors.h.

Value

template<typename TShape >

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

Definition at line 392 of file ShapeGeometricFunctors.h.

Constructor & Destructor Documentation

ShapeFirstPrincipalDirectionFunctor()

template<typename TShape >

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

        : myShape( aShape ) {}

Member Function Documentation

attach()

template<typename TShape >

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

      {
        myShape = aShape;
      }

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

operator()()

template<typename TShape >

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

inline

Map operator RealPoint -> Scalar giving the first principal direction (i.e. direction of first/smallest principal curvature).

Parameters

p	any point on the shape.

Returns

the first principal direction at point p.

Definition at line 419 of file ShapeGeometricFunctors.h.

      {
        Quantity d1, d2;
        myShape->principalDirections( p, d1, d2 );
        return d1;
      }

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

Field Documentation

myShape

template<typename TShape >

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

private

The shape of interest.

Definition at line 428 of file ShapeGeometricFunctors.h.

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

---

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

• ShapeGeometricFunctors.h