DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker Class Reference

#include <DGtal/topology/SetOfSurfels.h>

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 (ConstAlias< 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 80 of file SetOfSurfels.h.

Member Typedef Documentation

DigitalSurfaceContainer

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

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

Definition at line 85 of file SetOfSurfels.h.

KSpace

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

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

Definition at line 89 of file SetOfSurfels.h.

Neighborhood

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

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

Definition at line 90 of file SetOfSurfels.h.

Self

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

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

Definition at line 84 of file SetOfSurfels.h.

Surfel

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

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

Definition at line 86 of file SetOfSurfels.h.

Constructor & Destructor Documentation

Tracker() [1/2]

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

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

Constructor from surface container and surfel.

Parameters

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

Tracker() [2/2]

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

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

(

const Tracker &

other

)

Copy constructor.

Parameters

other

the object to clone.

~Tracker()

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

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

(

)

Destructor.

Member Function Documentation

adjacent()

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

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

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.

current()

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

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

(

)

const

Returns

the current surfel on which the tracker is.

move()

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

void DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::move

(

const Surfel &

s

)

Moves the tracker to the given valid surfel.

Precondition

'surface().isInside( s )'

Parameters

s	the surfel on which the tracker is moved.

orthDir()

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

Dimension DGtal::SetOfSurfels< TKSpace, TSurfelSet >::Tracker::orthDir

(

)

const

Returns

the orthogonal direction to the current surfel.

surface()

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

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

(

)

const

Returns

the surface container that the Tracker is tracking.

Field Documentation

myNeighborhood

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 150 of file SetOfSurfels.h.

mySurface

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 147 of file SetOfSurfels.h.

---

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

• SetOfSurfels.h