lti::brightRGB::parameters Class Reference

the parameters for the class brightRGB More...

#include <ltiBrightRGB.h>

Inheritance diagram for lti::brightRGB::parameters:

[legend]

Collaboration diagram for lti::brightRGB::parameters:

[legend]

List of all members.

Public Types
enum	eBRGBFilterType { Minimum = 0, Maximum, Average, 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)
Public Attributes
eBRGBFilterType	type
bool	transparent
rgbPixel	transColor

Detailed Description

the parameters for the class brightRGB

Member Enumeration Documentation

enum lti::brightRGB::parameters::eBRGBFilterType

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

For all modes the transparent color is not taken into account.

See also:: getMin(); getMax(); getAverage(); 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
Median	find the median of all values of each channel

Constructor & Destructor Documentation

lti::brightRGB::parameters::parameters ( )

default constructor

Reimplemented from lti::globalFeatureExtractor::parameters.

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

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::globalFeatureExtractor::parameters.

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

destructor

Reimplemented from lti::globalFeatureExtractor::parameters.

Member Function Documentation

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

returns a pointer to a clone of the parameters

Reimplemented from lti::globalFeatureExtractor::parameters.

parameters& lti::brightRGB::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 char* lti::brightRGB::parameters::getTypeName ( ) const [virtual]

returns name of this type

Reimplemented from lti::globalFeatureExtractor::parameters.

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

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