lti::channelStatistics::parameters Class Reference

the parameters for the class channelStatistics More...

#include <ltiChannelStatistics.h>

Inheritance diagram for lti::channelStatistics::parameters:

[legend]

Collaboration diagram for lti::channelStatistics::parameters:

[legend]

List of all members.

Public Types
enum	eBRGBFilterType {   Minimum = 0, Maximum, Average, Gaussian,   Median }
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	setSplitter (splitImage *theSplitter, const bool own=true)
const splitImage &	getSplitter () const
Public Attributes
eBRGBFilterType	type
bool	ownsSplitter
rgbColor	ignoreColor
Protected Attributes
splitImage *	splitter

---

Detailed Description

the parameters for the class channelStatistics

---

Member Enumeration Documentation

enum lti::channelStatistics::parameters::eBRGBFilterType

Specification of the filter type used on each channel to calculate the feature vector.

See also:

apply()

getMin()

getMax()

getAverage()

getGaussian()

getMedian()

Enumerator:

Minimum	find the minimum value of each channel
Maximum	find the maximum value of each channel
Average	find the average value of each channel
Gaussian	find the mean and variance of each channel
Median	find the median of all values of each channel

---

Constructor & Destructor Documentation

lti::channelStatistics::parameters::parameters

(

)

default constructor

Reimplemented from lti::globalFeatureExtractor::parameters.

lti::channelStatistics::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::globalFeatureExtractor::parameters.

lti::channelStatistics::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::globalFeatureExtractor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::channelStatistics::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::globalFeatureExtractor::parameters.

parameters& lti::channelStatistics::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::globalFeatureExtractor::parameters.

const splitImage& lti::channelStatistics::parameters::getSplitter

(

)

const

get a reference to the splitter object

const char* lti::channelStatistics::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::globalFeatureExtractor::parameters.

parameters& lti::channelStatistics::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::channelStatistics::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::functor::parameters.

void lti::channelStatistics::parameters::setSplitter	(	splitImage *	theSplitter,
		const bool	own = true
	)

set the splitImage functor to be used.

This will delete the actual splitter (if this object owns it), before assigning it to the actual parameter pointer.

Parameters:

	theSplitter	a pointer to the new functor to be used
	own	if true, this parameter object will take control of the memory deallocation of the object. If false, this object will never delete the functor.

virtual bool lti::channelStatistics::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::functor::parameters.

---

Member Data Documentation

rgbColor lti::channelStatistics::parameters::ignoreColor

The color which is ignored when the statistics is built.

This works only with the unmasked apply methods. If a mask or an areapoint object is given, these are used instead and this parameter is ignored.

bool lti::channelStatistics::parameters::ownsSplitter

Indicates whether the parameters own the splitImage pointer or not.

If they do, the pointer will be deleted in the destructor, if they don't, the class using the channelStatistics is responsible for deleting the the pointer. Default is true.

When channelStatistics is read from a file, this parameter is set to true, since a new pointer is generated.

splitImage* lti::channelStatistics::parameters::splitter [protected]

The splitImage functor used for selecting the channels.

Default is splitImageToRGB.

eBRGBFilterType lti::channelStatistics::parameters::type

Kind of calculation rule used to get the values.

Default value is Average

---

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

• ltiChannelStatistics.h