lti::kMeansSegmentation::parameters Class Reference

the parameters for the class kMeansSegmentation More...

#include <ltiKMeansSegmentation.h>

Inheritance diagram for lti::kMeansSegmentation::parameters:

[legend]

Collaboration diagram for lti::kMeansSegmentation::parameters:

[legend]

List of all members.

Public Types
enum	eSmoothFilterType { Nothing = 0, Median = 1, KNearest = 2 }
Public Member Functions
	parameters ()
	parameters (const int numCols)
	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
kMColorQuantization::parameters	quantParameters
eSmoothFilterType	smoothFilter
int	kernelSize

Detailed Description

the parameters for the class kMeansSegmentation

Member Enumeration Documentation

enum lti::kMeansSegmentation::parameters::eSmoothFilterType

Smooth filter type.

Enumerator:

Nothing	Do not smooth the color quantized image.
Median	Use Median Filter (lti::medianFilter).
KNearest	Use K-Nearest Neighbor filter (lti::kNearestNeighFilter).

Constructor & Destructor Documentation

lti::kMeansSegmentation::parameters::parameters ( )

default constructor

Reimplemented from lti::segmentation::parameters.

lti::kMeansSegmentation::parameters::parameters ( const int numCols )

construct a parameters object with the given number of quantization colors.

Parameters:

numCols

number of colors

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

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::segmentation::parameters.

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

destructor

Reimplemented from lti::segmentation::parameters.

Member Function Documentation

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

returns a pointer to a clone of the parameters

Reimplemented from lti::segmentation::parameters.

parameters& lti::kMeansSegmentation::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::segmentation::parameters.

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

returns name of this type

Reimplemented from lti::segmentation::parameters.

parameters& lti::kMeansSegmentation::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::kMeansSegmentation::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::segmentation::parameters.

virtual bool lti::kMeansSegmentation::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.