#include <SetOfSurfels.h>

Collaboration diagram for DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker:

Public Types
typedef Tracker	Self
typedef SetOfSurfels< TKSpace, TSurfelSet >	DigitalSurfaceContainer
typedef TKSpace::SCell	Surfel
typedef TKSpace	KSpace
typedef SurfelNeighborhood < KSpace >	Neighborhood

Public Member Functions
	Tracker (const DigitalSurfaceContainer &aSurface, const Surfel &s)
	Tracker (const Tracker &other)
	~Tracker ()
const DigitalSurfaceContainer &	surface () const
const Surfel &	current () const
Dimension	orthDir () const
void	move (const Surfel &s)
uint8_t	adjacent (Surfel &s, Dimension d, bool pos) const

Private Attributes
const DigitalSurfaceContainer &	mySurface
Neighborhood	myNeighborhood

Detailed Description

template<typename TKSpace, typename TSurfelSet = typename TKSpace::SurfelSet>
class DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker

A model of CDigitalSurfaceTracker for SetOfSurfels.

Definition at line 79 of file SetOfSurfels.h.

Member Typedef Documentation

template<typename TKSpace, typename TSurfelSet = typename TKSpace::SurfelSet>

typedef SetOfSurfels<TKSpace,TSurfelSet> DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::DigitalSurfaceContainer

Definition at line 84 of file SetOfSurfels.h.

template<typename TKSpace, typename TSurfelSet = typename TKSpace::SurfelSet>

typedef TKSpace DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::KSpace

Definition at line 88 of file SetOfSurfels.h.

template<typename TKSpace, typename TSurfelSet = typename TKSpace::SurfelSet>

typedef SurfelNeighborhood<KSpace> DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::Neighborhood

Definition at line 89 of file SetOfSurfels.h.

template<typename TKSpace, typename TSurfelSet = typename TKSpace::SurfelSet>

typedef Tracker DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::Self

Definition at line 83 of file SetOfSurfels.h.

template<typename TKSpace, typename TSurfelSet = typename TKSpace::SurfelSet>

typedef TKSpace::SCell DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::Surfel

Definition at line 85 of file SetOfSurfels.h.

Constructor & Destructor Documentation

template<typename TKSpace , typename TSurfelSet >

DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::Tracker	(	const DigitalSurfaceContainer &	aSurface,
		const Surfel &	s
	)

inline

Constructor from surface container and surfel.

Parameters:

aSurface	the container describing the surface.
s	the surfel on which the tracker is initialized.

Definition at line 51 of file SetOfSurfels.ih.

References DGtal::SurfelNeighborhood< TKSpace >::init(), DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::myNeighborhood, DGtal::SetOfSurfels< TKSpace, TSurfelSet >::space(), DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::surface(), and DGtal::SetOfSurfels< TKSpace, TSurfelSet >::surfelAdjacency().

  : mySurface( aSurface ), myNeighborhood()
{
  myNeighborhood.init( & surface().space(), 
                       & surface().surfelAdjacency(),
                       s );
}

template<typename TKSpace , typename TSurfelSet >

DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::Tracker ( const Tracker & other )

inline

Copy constructor.

Parameters:

other the object to clone.

Definition at line 63 of file SetOfSurfels.ih.

  : mySurface( other.mySurface ), myNeighborhood( other.myNeighborhood )
{
}

template<typename TKSpace , typename TSurfelSet >

DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::~Tracker ( )

inline

Destructor.

Definition at line 45 of file SetOfSurfels.ih.

{}

Member Function Documentation

template<typename TKSpace , typename TSurfelSet >

DGtal::uint8_t DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::adjacent	(	Surfel &	s,
		Dimension	d,
		bool	pos
	)		const

inline

Computes the surfel adjacent to 'current()' in the direction [d] along orientation [pos].

Parameters:

s	(modified) set to the adjacent surfel in the specified direction d and orientation pos if it exists. Otherwise unchanged (method returns 0 in this case).
d	any direction different from 'orthDir()'.
pos	when 'true' look in positive direction along [track_dir] axis, 'false' look in negative direction.

Returns:: the move code (n=0-3). When 0: no adjacent surfel, otherwise 1-3: adjacent surfel is n-th follower.

Definition at line 108 of file SetOfSurfels.ih.

References DGtal::SetOfSurfels< TKSpace, TSurfelSet >::surfelPredicate().

{
  return static_cast<uint8_t>
    ( myNeighborhood.getAdjacentOnSurfelPredicate( s, surface().surfelPredicate(), d, pos ) );
}

template<typename TKSpace , typename TSurfelSet >

const DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::Surfel & DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::current ( ) const

inline

Returns:: the current surfel on which the tracker is.

Definition at line 80 of file SetOfSurfels.ih.

{
  return myNeighborhood.surfel();
}

template<typename TKSpace , typename TSurfelSet >

void DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::move ( const Surfel & s )

inline

Moves the tracker to the given valid surfel.

Precondition:: 'surface().isInside( s )'

Parameters:

s	the surfel on which the tracker is moved.

Definition at line 98 of file SetOfSurfels.ih.

References DGtal::SetOfSurfels< TKSpace, TSurfelSet >::isInside().

{
  ASSERT( surface().isInside( s ) );
  myNeighborhood.setSurfel( s );
}

template<typename TKSpace , typename TSurfelSet >

DGtal::Dimension DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::orthDir ( ) const

inline

Returns:: the orthogonal direction to the current surfel.

Definition at line 89 of file SetOfSurfels.ih.

{
  return myNeighborhood.orthDir();
}

template<typename TKSpace , typename TSurfelSet >

const DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::DigitalSurfaceContainer & DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::surface ( ) const

inline

Returns:: the surface container that the Tracker is tracking.

Definition at line 72 of file SetOfSurfels.ih.

Referenced by DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::Tracker().

{
  return mySurface;
}

Field Documentation

template<typename TKSpace, typename TSurfelSet = typename TKSpace::SurfelSet>

Neighborhood DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::myNeighborhood

private

the current surfel neighborhood, the object that holds the necessary information for determining neighbors.

Definition at line 149 of file SetOfSurfels.h.

Referenced by DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::Tracker().

template<typename TKSpace, typename TSurfelSet = typename TKSpace::SurfelSet>

const DigitalSurfaceContainer& DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::mySurface

private

a reference to the digital surface container on which is the tracker.

Definition at line 146 of file SetOfSurfels.h.

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

Public Types

Public Member Functions

Private Attributes

Detailed Description

template<typename TKSpace, typename TSurfelSet = typename TKSpace::SurfelSet> class DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

template<typename TKSpace, typename TSurfelSet = typename TKSpace::SurfelSet>
class DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker