lti::distanceTransform::parameters Class Reference

the parameters for the class distanceTransform More...

#include <ltiDistanceTransform.h>

Inheritance diagram for lti::distanceTransform::parameters:

[legend]

Collaboration diagram for lti::distanceTransform::parameters:

[legend]

List of all members.

Public Types
enum	eDistanceType {   EightNeighborhood, FourNeighborhood, EuclideanSqr, Euclidean,   EightSED, EightSEDSqr, FourSED, FourSEDSqr }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
eDistanceType	distance

---

Detailed Description

the parameters for the class distanceTransform

---

Member Enumeration Documentation

enum lti::distanceTransform::parameters::eDistanceType

Four distancetransformation computation types can be choosen: EightNeighbor, FourNeighbor, EuclideanSqr and Euclidean.

For two pixels p and q with position p(p.x,p.y) and q(q.x,q.y) following is valid:

• the distance in a 4-neighborhood is |p.x-q.x| + |p.y-q.y|
• the distance in an 8-neighborhood is max(|p.x-q.x|,|p.y-q.y|)
• the distance is euclidean square for (p.x - q.x)^2 + (p.y - q.y)^2
• the distance is euclidean for ( (p.x - q.x)^2 + (p.y - q.y)^2 )^1/2

Enumerator:

EightNeighborhood	eight neighborhood distance
FourNeighborhood	four neighborhood (city block) distance
EuclideanSqr	square of euclidean distance
Euclidean	euclidean distance
EightSED	eight point sequential euclidian distance mapping
EightSEDSqr	square of the eight point sequential euclidian distance mapping
FourSED	four point sequential euclidian distance mapping
FourSEDSqr	square of the four point sequential euclidian distance mapping

---

Constructor & Destructor Documentation

lti::distanceTransform::parameters::parameters

(

)

default constructor

Reimplemented from lti::morphology::parameters.

lti::distanceTransform::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::morphology::parameters.

lti::distanceTransform::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::morphology::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::distanceTransform::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::morphology::parameters.

parameters& lti::distanceTransform::parameters::copy

(

const parameters &

other

)

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from lti::morphology::parameters.

const char* lti::distanceTransform::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::morphology::parameters.

parameters& lti::distanceTransform::parameters::operator=

(

const parameters &

other

)

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

virtual bool lti::distanceTransform::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

read the parameters from the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::modifier::parameters.

virtual bool lti::distanceTransform::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::modifier::parameters.

---

Member Data Documentation

eDistanceType lti::distanceTransform::parameters::distance

Kind of distance transform to be computed.

See eDistanceType for more information.

Default value: Euclidean

---

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

• ltiDistanceTransform.h