DGtal  1.5.beta
DGtal::concepts::CLMSTTangentFromDSS< T > Struct Template Reference

Aim: Defines the concept describing a functor which calculates a direction of the 2D DSS and an eccentricity [74] of a given point in this DSS. More...

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

Inheritance diagram for DGtal::concepts::CLMSTTangentFromDSS< T >:
[legend]

Public Types

typedef T::Value Value
 
typedef T::RealVector RealVector
 
typedef T::TDSS TDSS
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CForwardSegmentComputer< TDSS >))
 
 BOOST_CONCEPT_ASSERT ((CBidirectionalRange< RealVector >))
 
 BOOST_CONCEPT_USAGE (CLMSTTangentFromDSS)
 
void checkConstConstraints () const
 

Private Attributes

RealVector vec
 
Value v1
 
Value v2
 
x
 
double d
 
TDSS dss
 

Detailed Description

template<typename T>
struct DGtal::concepts::CLMSTTangentFromDSS< T >

Aim: Defines the concept describing a functor which calculates a direction of the 2D DSS and an eccentricity [74] of a given point in this DSS.

Description of concept 'CLMSTTangentFromDSS'

Refinement of boost::DefaultConstructible<T>, boost::CopyConstructible<T>, boost::Assignable<T>

Associated types

  • TDSS a 3d digital straight segment recognition algorithm
  • LambdaFunction
    See also
    FunctorsLambdaMST.h
  • Value struct Value { RealVector first; double second; Value & operator += ( const Value &); }

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
operator() x() (const TDSS &, const int &, const int &) T::Value Calculates DSS direction and eccentricity of given points in the DSS. model dependant

Invariants

Models

Notes

Template Parameters
Tthe type that should be a model of CLMSTTangentFromDSS.

Definition at line 93 of file CLMSTTangentFromDSS.h.

Member Typedef Documentation

◆ RealVector

template<typename T >
typedef T::RealVector DGtal::concepts::CLMSTTangentFromDSS< T >::RealVector

Definition at line 97 of file CLMSTTangentFromDSS.h.

◆ TDSS

template<typename T >
typedef T::TDSS DGtal::concepts::CLMSTTangentFromDSS< T >::TDSS

Definition at line 98 of file CLMSTTangentFromDSS.h.

◆ Value

template<typename T >
typedef T::Value DGtal::concepts::CLMSTTangentFromDSS< T >::Value

Definition at line 96 of file CLMSTTangentFromDSS.h.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/2]

template<typename T >
DGtal::concepts::CLMSTTangentFromDSS< T >::BOOST_CONCEPT_ASSERT ( (CBidirectionalRange< RealVector >)  )

◆ BOOST_CONCEPT_ASSERT() [2/2]

template<typename T >
DGtal::concepts::CLMSTTangentFromDSS< T >::BOOST_CONCEPT_ASSERT ( (CForwardSegmentComputer< TDSS >)  )

◆ BOOST_CONCEPT_USAGE()

◆ checkConstConstraints()

template<typename T >
void DGtal::concepts::CLMSTTangentFromDSS< T >::checkConstConstraints ( ) const
inline

Definition at line 110 of file CLMSTTangentFromDSS.h.

111  {
112  ConceptUtils::sameType( v1, x.operator()( dss, 0, 10 ) );
113  }

References DGtal::concepts::CLMSTTangentFromDSS< T >::dss, and DGtal::concepts::ConceptUtils::sameType().

Field Documentation

◆ d

template<typename T >
double DGtal::concepts::CLMSTTangentFromDSS< T >::d
private

◆ dss

◆ v1

template<typename T >
Value DGtal::concepts::CLMSTTangentFromDSS< T >::v1
private

Definition at line 117 of file CLMSTTangentFromDSS.h.

◆ v2

template<typename T >
Value DGtal::concepts::CLMSTTangentFromDSS< T >::v2
private

Definition at line 117 of file CLMSTTangentFromDSS.h.

◆ vec

◆ x

template<typename T >
T DGtal::concepts::CLMSTTangentFromDSS< T >::x
private

Definition at line 118 of file CLMSTTangentFromDSS.h.


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