lti::localMaxima< T >::parameters Class Reference

the parameters for the class localMaxima More...

#include <ltiLocalMaxima.h>

Inheritance diagram for lti::localMaxima< T >::parameters:

[legend]

Collaboration diagram for lti::localMaxima< T >::parameters:

[legend]

List of all members.

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
float	relativeMinimum
T	noMaxValue
float	hystheresisThreshold
int	maxNumber

Detailed Description

template<class T>
class lti::localMaxima< T >::parameters

the parameters for the class localMaxima

Constructor & Destructor Documentation

template<class T>

lti::localMaxima< T >::parameters::parameters ( void ) [inline]

default constructor

Reimplemented from lti::modifier::parameters.

References lti::localMaxima< T >::parameters::hystheresisThreshold, lti::localMaxima< T >::parameters::maxNumber, lti::localMaxima< T >::parameters::noMaxValue, and lti::localMaxima< T >::parameters::relativeMinimum.

Referenced by lti::localMaxima< T >::parameters::clone().

template<class T>

lti::localMaxima< T >::parameters::parameters ( const parameters & other ) [inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::maximumFilter< T >::parameters.

References lti::localMaxima< T >::parameters::copy().

template<class T>

lti::localMaxima< T >::parameters::~parameters ( ) [inline, virtual]

destructor

Reimplemented from lti::maximumFilter< T >::parameters.

Member Function Documentation

template<class T>

virtual functor::parameters* lti::localMaxima< T >::parameters::clone ( ) const [inline, virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::maximumFilter< T >::parameters.

References lti::localMaxima< T >::parameters::parameters().

template<class T>

parameters& lti::localMaxima< T >::parameters::copy ( const parameters & other ) [inline]

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::maximumFilter< T >::parameters.

References lti::localMaxima< T >::parameters::hystheresisThreshold, lti::localMaxima< T >::parameters::maxNumber, lti::localMaxima< T >::parameters::noMaxValue, and lti::localMaxima< T >::parameters::relativeMinimum.

Referenced by lti::localMaxima< T >::parameters::operator=(), and lti::localMaxima< T >::parameters::parameters().

template<class T>

const char* lti::localMaxima< T >::parameters::getTypeName ( void ) const [inline, virtual]

returns name of this type

Reimplemented from lti::maximumFilter< T >::parameters.

template<class T>

parameters& lti::localMaxima< T >::parameters::operator= ( const parameters & other ) [inline]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:: a reference to this parameters object

References lti::localMaxima< T >::parameters::copy().

template<class T>

virtual bool lti::localMaxima< T >::parameters::read	(	ioHandler &	handler,
		const bool	complete = `true`
	)			`[inline, 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 read, otherwise only the data block will be read.

Returns:: true if write was successful

Reimplemented from lti::maximumFilter< T >::parameters.

References lti::localMaxima< T >::parameters::hystheresisThreshold, lti::localMaxima< T >::parameters::maxNumber, lti::localMaxima< T >::parameters::noMaxValue, lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), and lti::localMaxima< T >::parameters::relativeMinimum.

template<class T>

virtual bool lti::localMaxima< T >::parameters::write	(	ioHandler &	handler,
		const bool	complete = `true`
	)			const `[inline, 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::maximumFilter< T >::parameters.

References lti::localMaxima< T >::parameters::hystheresisThreshold, lti::localMaxima< T >::parameters::maxNumber, lti::localMaxima< T >::parameters::noMaxValue, lti::localMaxima< T >::parameters::relativeMinimum, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

Member Data Documentation

template<class T>

float lti::localMaxima< T >::parameters::hystheresisThreshold

This value offers a more stronger suppression of non-maxima.

If a local maxima is detected in a given window (defined by the attribute maximumFilter<T>::parameters::kernelSize) a region search algorithm will look for pixels around with a value greater than the local maxima found, the search will consider for the expansion only pixels with a value greater than the found local maxima multiplied by this hystheresis value.

The seach will be done for each local maxima, starting with the smallest ones.

To activate this region-search mode, use a value between 0 (meaning "search for a global maximum") and 1 ("detect all local minima").

A negative value or a value greater 1 deactivates this search (saves some time).

Default value: -1 (search deactivated)

Referenced by lti::localMaxima< T >::parameters::copy(), lti::localMaxima< T >::parameters::parameters(), lti::localMaxima< T >::parameters::read(), and lti::localMaxima< T >::parameters::write().

template<class T>

int lti::localMaxima< T >::parameters::maxNumber

Maximum number of local maxima to be kept.

If you are only interested in a fixed number of maxima, the set this attribute to a value larger or equal 1. If you want to always obtaine the maximum number of local maxima, set this value to -1.

Default value: -1 (not used)

Referenced by lti::localMaxima< T >::parameters::copy(), lti::localMaxima< T >::parameters::parameters(), lti::localMaxima< T >::parameters::read(), and lti::localMaxima< T >::parameters::write().

template<class T>

T lti::localMaxima< T >::parameters::noMaxValue

All non-maximum values will be set to this value.

All maxima will keep their value.

Default value: 0

Referenced by lti::localMaxima< T >::parameters::copy(), lti::localMaxima< T >::parameters::parameters(), lti::localMaxima< T >::parameters::read(), and lti::localMaxima< T >::parameters::write().

template<class T>

float lti::localMaxima< T >::parameters::relativeMinimum

All pixels with values smaller than the maximum found in the input channel multiplied by "relativeMinimum" will be suppressed.

(Zero means, all detected local minima will be kept)