lti::classicEdgeDetector::parameters Class Reference

The parameters for the class classicEdgeDetector. More...

#include <ltiClassicEdgeDetector.h>

Inheritance diagram for lti::classicEdgeDetector::parameters:

[legend]

Collaboration diagram for lti::classicEdgeDetector::parameters:

[legend]

List of all members.

Public Types
enum	eMaximaSearchMethod { NonMaximaSuppression, Thresholding }
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)
void	setMaximaSearchMethod (const thresholding &thresholder)
void	setMaximaSearchMethod (const nonMaximaSuppression &suppressor)
void	attachMaximaSearchMethod (thresholding *thresholder)
void	attachMaximaSearchMethod (nonMaximaSuppression *suppressor)
void	useExternalMaximaSearchMethod (thresholding *thresholder)
void	useExternalMaximaSearchMethod (nonMaximaSuppression *suppressor)
Public Attributes
gradientFunctor::parameters	gradientParameters
Protected Attributes
eMaximaSearchMethod	maximaSearchMethod
nonMaximaSuppression *	suppressor
thresholding *	thresholder
bool	destroyFunctor

Detailed Description

The parameters for the class classicEdgeDetector.

Member Enumeration Documentation

enum lti::classicEdgeDetector::parameters::eMaximaSearchMethod

enum type for maxima search method

Enumerator:

NonMaximaSuppression	use an instance of nonMaximaSuprression to extract edges
Thresholding	use an instance of thresholding to extract edges

Constructor & Destructor Documentation

lti::classicEdgeDetector::parameters::parameters ( )

default constructor

Reimplemented from lti::edgeDetector::parameters.

lti::classicEdgeDetector::parameters::parameters ( const parameters & other )

copy constructor

Parameters:

other

the parametrs object to copied

Reimplemented from lti::edgeDetector::parameters.

lti::classicEdgeDetector::parameters::~parameters ( ) [virtual]

destructor

Reimplemented from lti::edgeDetector::parameters.

Member Function Documentation

void lti::classicEdgeDetector::parameters::attachMaximaSearchMethod ( nonMaximaSuppression * suppressor )

Sets a new maxima search method.

The functor which is passed here as an argument must have been allocated with new; it must not be a local variable. On destruction of the parameters object, the instance of the given functor will be deleted, i.e. this parameters instance will be responsible for the memory managment of the object.

Attention: some parameters of the functor will be overwritten in classicEdgeDetector::setParameters();

void lti::classicEdgeDetector::parameters::attachMaximaSearchMethod ( thresholding * thresholder )

Sets a new maxima search method.

The functor which is passed here as an argument must have been allocated with new; it must not be a local variable. On destruction of the parameters object, the instance of the given functor will be deleted, i.e. this parameters instance will be responsible for the memory managment of the object.

Attention: some parameters of the functor will be overwritten in classicEdgeDetector::setParameters();

virtual functor::parameters* lti::classicEdgeDetector::parameters::clone ( ) const [virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from lti::edgeDetector::parameters.

parameters& lti::classicEdgeDetector::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::edgeDetector::parameters.

const char* lti::classicEdgeDetector::parameters::getTypeName ( ) const [virtual]

returns name of this type

Returns:: string "ltiClassicEdgeDetector::parameters"

Reimplemented from lti::edgeDetector::parameters.

parameters& lti::classicEdgeDetector::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

Reimplemented from lti::edgeDetector::parameters.

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

Read the parameters from the given ioHandler Note: The parameters of the used maxima search method will NOT be read!

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::edgeDetector::parameters.

void lti::classicEdgeDetector::parameters::setMaximaSearchMethod ( const nonMaximaSuppression & suppressor )

Sets a new maxima search method.

A copy of the functor will be done (so it is useless to change the parameters of the given functor instance, because the internal functor will never notice the changes done to its "parent").

Attention: some parameters of the functor will be overwritten in classicEdgeDetector::setParameters(const functor::parameters& theParam);

void lti::classicEdgeDetector::parameters::setMaximaSearchMethod ( const thresholding & thresholder )

Sets a new maxima search method.

A copy of the functor will be done (so it is useless to change the parameters of the given functor instance, because the internal functor will never notice the changes done to its "parent").

Attention: some parameters of the functor will be overwritten in classicEdgeDetector::setParameters(const functor::parameters& theParam);

void lti::classicEdgeDetector::parameters::useExternalMaximaSearchMethod ( nonMaximaSuppression * suppressor )

Sets a new maxima search method.

The functor which is passed here as an argument is not deleted by the parameters object, the caller must ensure that threre are no memory leaks.

Attention: some parameters of the functor will be overwritten in classicEdgeDetector::setParameters();

void lti::classicEdgeDetector::parameters::useExternalMaximaSearchMethod ( thresholding * thresholder )

Sets a new maxima search method.

The functor which is passed here as an argument is not deleted by the parameters object, the caller must ensure that threre are no memory leaks.

Attention: some parameters of the functor will be overwritten in classicEdgeDetector::setParameters();

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

Write the parameters in the given ioHandler.

Note: The parameters of the used maxima search method will NOT be saved!

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.