DGtal  1.5.beta
DGtal::FrechetShortcut< TIterator, TInteger >::Cone Class Reference

#include <DGtal/geometry/curves/FrechetShortcut.h>

Public Member Functions

 Cone ()
 
 Cone (double a0, double a1)
 
 Cone (double x, double y, double x0, double y0, double x1, double y1)
 
 Cone (const Cone &c)=default
 
Coneoperator= (const Cone &c)
 
bool isEmpty () const
 
void intersectCones (Cone c)
 
Cone intersectConesSimple (Cone c)
 
Cone symmetricalCone ()
 
void selfDisplay (std::ostream &out) const
 

Data Fields

double myMin
 
double myMax
 
bool myInf
 

Detailed Description

template<typename TIterator, typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
class DGtal::FrechetShortcut< TIterator, TInteger >::Cone

Class Cone: data structures and methods to handle the cone update used to test if the width of the shortcut is lower than the error.

Definition at line 266 of file FrechetShortcut.h.

Constructor & Destructor Documentation

◆ Cone() [1/4]

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
DGtal::FrechetShortcut< TIterator, TInteger >::Cone::Cone ( )

◆ Cone() [2/4]

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
DGtal::FrechetShortcut< TIterator, TInteger >::Cone::Cone ( double  a0,
double  a1 
)

Constructor from two angles

Parameters
a0an angle
a1a second angle

◆ Cone() [3/4]

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
DGtal::FrechetShortcut< TIterator, TInteger >::Cone::Cone ( double  x,
double  y,
double  x0,
double  y0,
double  x1,
double  y1 
)

Constructor from three points x, x0, x1. The cone is defined by the two lines (xx0) and (xx1)

Parameters
xx
yy
x0x0
y0y0
x1x1
y1y1

◆ Cone() [4/4]

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
DGtal::FrechetShortcut< TIterator, TInteger >::Cone::Cone ( const Cone c)
default

Default copy constructor.

Parameters
cother cone to copy.

Member Function Documentation

◆ intersectCones()

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
void DGtal::FrechetShortcut< TIterator, TInteger >::Cone::intersectCones ( Cone  c)

Intersect two cones: modifies 'this'

Parameters
ca cone to intersect with 'this'

◆ intersectConesSimple()

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
Cone DGtal::FrechetShortcut< TIterator, TInteger >::Cone::intersectConesSimple ( Cone  c)

Intersect two half cones

Parameters
ca cone to intersection with 'this'
Returns
a cone

◆ isEmpty()

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
bool DGtal::FrechetShortcut< TIterator, TInteger >::Cone::isEmpty ( ) const

Test if the cone is empty

Returns
true if empty, false otherwise

◆ operator=()

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
Cone& DGtal::FrechetShortcut< TIterator, TInteger >::Cone::operator= ( const Cone c)

Assignement

Parameters
canother cone
Returns
a reference on 'this'

◆ selfDisplay()

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
void DGtal::FrechetShortcut< TIterator, TInteger >::Cone::selfDisplay ( std::ostream &  out) const

Writes/Displays the object on an output stream.

Parameters
outthe output stream where the object is written.

◆ symmetricalCone()

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
Cone DGtal::FrechetShortcut< TIterator, TInteger >::Cone::symmetricalCone ( )

Computes the symmetrical half cone

Returns
a cone

Field Documentation

◆ myInf

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
bool DGtal::FrechetShortcut< TIterator, TInteger >::Cone::myInf

Boolean: true if the cone is infinite

Definition at line 282 of file FrechetShortcut.h.

◆ myMax

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
double DGtal::FrechetShortcut< TIterator, TInteger >::Cone::myMax

Angle max of the cone

Definition at line 277 of file FrechetShortcut.h.

◆ myMin

template<typename TIterator , typename TInteger = typename IteratorCirculatorTraits<TIterator>::Value::Coordinate>
double DGtal::FrechetShortcut< TIterator, TInteger >::Cone::myMin

Angle min of the cone

Definition at line 272 of file FrechetShortcut.h.


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