DGtal::deprecated::SCellToArrow< KSpace > Class Template Reference

#include <Modifier.h>

Public Types
typedef KSpace::Point	Point
typedef KSpace::Vector	Vector
typedef std::pair< Point, Vector >	Output
typedef KSpace::SCell	Input

Public Member Functions
	SCellToArrow ()
	SCellToArrow (KSpace aK)
	SCellToArrow (const SCellToArrow &other)
SCellToArrow &	operator= (const SCellToArrow &other)
Output	get (const Input &s) const

Private Attributes
KSpace	myK

---

Detailed Description

template<typename KSpace>
class DGtal::deprecated::SCellToArrow< KSpace >

Aim: transforms a signed cell into an arrow, ie. a pair point-vector.

Description of template class 'SCellToArrow'

Template Parameters:

KSpace,the

Khalimsky space

See also:

SCellToPoint ConstIteratorAdapter KhalimskySpaceND PointVector

Definition at line 337 of file Modifier.h.

---

Member Typedef Documentation

template<typename KSpace >

typedef KSpace::SCell DGtal::deprecated::SCellToArrow< KSpace >::Input

Definition at line 346 of file Modifier.h.

template<typename KSpace >

typedef std::pair<Point,Vector> DGtal::deprecated::SCellToArrow< KSpace >::Output

Definition at line 344 of file Modifier.h.

template<typename KSpace >

typedef KSpace::Point DGtal::deprecated::SCellToArrow< KSpace >::Point

Definition at line 342 of file Modifier.h.

template<typename KSpace >

typedef KSpace::Vector DGtal::deprecated::SCellToArrow< KSpace >::Vector

Definition at line 343 of file Modifier.h.

---

Constructor & Destructor Documentation

template<typename KSpace >

DGtal::deprecated::SCellToArrow< KSpace >::SCellToArrow ( )

inline

Default constructor.

Definition at line 356 of file Modifier.h.

{ }

template<typename KSpace >

DGtal::deprecated::SCellToArrow< KSpace >::SCellToArrow ( KSpace  aK )

inline

Constructor.

Parameters:

aK	a Khalimsky space

Definition at line 362 of file Modifier.h.

: myK(aK) { }

template<typename KSpace >

DGtal::deprecated::SCellToArrow< KSpace >::SCellToArrow ( const SCellToArrow< KSpace > &  other )

inline

Copy constructor.

Parameters:

other

any SCellToArrow modifier

Definition at line 368 of file Modifier.h.

    : myK(other.myK) { }

---

Member Function Documentation

template<typename KSpace >

Output DGtal::deprecated::SCellToArrow< KSpace >::get ( const Input &  s ) const

inline

Get an arrow, ie a pair point-vector in integer coordinates from a scell in khalimsky coordinates

Parameters:

s

a scell

Returns:

the corresponding point.

Definition at line 391 of file Modifier.h.

References DGtal::deprecated::SCellToArrow< KSpace >::myK.

    {
      //starting point of the arrow
      Input pointel( myK.sIndirectIncident( s, *myK.sDirs( s ) ) );
      Point p( myK.sCoords( pointel ) );   //integer coordinates
      //displacement vector
      Vector v( myK.sKCoords( s ) - myK.sKCoords( pointel ) );
      return Output(p,v);
    }

template<typename KSpace >

SCellToArrow& DGtal::deprecated::SCellToArrow< KSpace >::operator= ( const SCellToArrow< KSpace > &  other )

inline

Assignment.

Parameters:

other

the object to copy.

Returns:

a reference on 'this'.

Definition at line 376 of file Modifier.h.

References DGtal::deprecated::SCellToArrow< KSpace >::myK.

    {
      if ( this != &other )
      {
        myK = other.myK; 
      }
      return *this;
    }

---

Field Documentation

template<typename KSpace >

KSpace DGtal::deprecated::SCellToArrow< KSpace >::myK

private

Definition at line 349 of file Modifier.h.

Referenced by DGtal::deprecated::SCellToArrow< KSpace >::get(), and DGtal::deprecated::SCellToArrow< KSpace >::operator=().

---

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

• Modifier.h