Public Types | Public Member Functions | Protected Member Functions

DGtal::ArithDSS4< Domain2D > Class Template Reference

Aim: More...

#include <ArithDSS4.h>

Inheritance diagram for DGtal::ArithDSS4< Domain2D >:
Inheritance graph
[legend]
Collaboration diagram for DGtal::ArithDSS4< Domain2D >:
Collaboration graph
[legend]

Public Types

typedef Domain2D::Coordinate Integer
typedef Domain2D::Point Point
typedef Domain2D::Vector Vector

Public Member Functions

 ArithDSS4 ()
 ArithDSS4 (const Point &aFirstPoint, const Point &aSecondPoint)
 ~ArithDSS4 ()

Protected Member Functions

Integer norm (const Integer &x, const Integer &y) const
bool sameQuadrant (const Vector &aVec) const
Vector vectorFrom0ToOmega () const
Point next (const Point &aPoint) const

Detailed Description

template<typename Domain2D>
class DGtal::ArithDSS4< Domain2D >

Aim:

Description of template class 'ArithDSS4'


Member Typedef Documentation

template<typename Domain2D>
typedef Domain2D::Coordinate DGtal::ArithDSS4< Domain2D >::Integer

Reimplemented from DGtal::ArithDSS< Domain2D >.

template<typename Domain2D>
typedef Domain2D::Point DGtal::ArithDSS4< Domain2D >::Point

Reimplemented from DGtal::ArithDSS< Domain2D >.

template<typename Domain2D>
typedef Domain2D::Vector DGtal::ArithDSS4< Domain2D >::Vector

Reimplemented from DGtal::ArithDSS< Domain2D >.


Constructor & Destructor Documentation

template<typename Domain2D>
DGtal::ArithDSS4< Domain2D >::ArithDSS4 (  ) 

Default constructor (not valid).

template<typename Domain2D>
DGtal::ArithDSS4< Domain2D >::ArithDSS4 ( const Point aFirstPoint,
const Point aSecondPoint 
)

Constructor.

template<typename Domain2D>
DGtal::ArithDSS4< Domain2D >::~ArithDSS4 (  ) 

Destructor.


Member Function Documentation

template<typename Domain2D>
Point DGtal::ArithDSS4< Domain2D >::next ( const Point aPoint  )  const [protected, virtual]

Returns the point that follows a given point in the DSS

Parameters:
aPoint,a given point of the DSS.
Returns:
the next point.

Implements DGtal::ArithDSS< Domain2D >.

template<typename Domain2D>
Integer DGtal::ArithDSS4< Domain2D >::norm ( const Integer x,
const Integer y 
) const [protected, virtual]

Computes the norm of the two components of a 2D vector as the L1 norm

Parameters:
x and y, two values.
Returns:
the L1 norm of a 2D vector.

Implements DGtal::ArithDSS< Domain2D >.

template<typename Domain2D>
bool DGtal::ArithDSS4< Domain2D >::sameQuadrant ( const Vector aVec  )  const [protected, virtual]

Checks whether the DSS lies in one quadrant or not

Parameters:
aVec,the last displacement vector.
Returns:
'true' if yes, 'false' otherwise.

Implements DGtal::ArithDSS< Domain2D >.

template<typename Domain2D>
Vector DGtal::ArithDSS4< Domain2D >::vectorFrom0ToOmega (  )  const [protected, virtual]

Computes the 2D vector starting at a point of remainder 0 and pointing at a point of remainder omega = |a|+|b|

Returns:
the 2D vector.

Implements DGtal::ArithDSS< Domain2D >.


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