lti::brightRGB Class Reference

This functor splits an image into its three channels (R.G,b) and then calculates the Minimum, Maximum, Average, Median or Average and Variance over their values, depending on the parameter type. More...

#include <ltiBrightRGB.h>

Inheritance diagram for lti::brightRGB:

[legend]

Collaboration diagram for lti::brightRGB:

[legend]

List of all members.

Classes
class	parameters
	the parameters for the class brightRGB More...
Public Member Functions
	brightRGB ()
	brightRGB (const brightRGB &other)
virtual	~brightRGB ()
virtual const char *	getTypeName () const
bool	apply (const image &src, dvector &dest) const
brightRGB &	copy (const brightRGB &other)
brightRGB &	operator= (const brightRGB &other)
virtual functor *	clone () const
const parameters &	getParameters () const
Protected Member Functions
bool	getMin (const image &img, dvector &dest) const
bool	getMax (const image &img, dvector &dest) const
bool	getAverage (const image &img, dvector &dest) const
bool	getMedian (const image &img, dvector &dest) const

---

Detailed Description

This functor splits an image into its three channels (R.G,b) and then calculates the Minimum, Maximum, Average, Median or Average and Variance over their values, depending on the parameter type.

It is possible to define a "transparent color" which will be ignored by the calculation.

---

Constructor & Destructor Documentation

lti::brightRGB::brightRGB

(

)

default constructor

lti::brightRGB::brightRGB

(

const brightRGB &

other

)

copy constructor

Parameters:

other

the object to be copied

virtual lti::brightRGB::~brightRGB

(

)

[virtual]

destructor

---

Member Function Documentation

bool lti::brightRGB::apply	(	const image &	src,
		dvector &	dest
	)			const [virtual]

Calculates the Minimum, Maximum, Average or Median of each channel of the given image, depending on the value of the parameter type.

Parameters:

	src	image which is analysed by the calculation rule
	dest	the result value per channel

Returns:

true if apply successful or false otherwise.

Reimplemented from lti::globalFeatureExtractor.

virtual functor* lti::brightRGB::clone

(

)

const [virtual]

returns a pointer to a clone of this functor.

Reimplemented from lti::globalFeatureExtractor.

brightRGB& lti::brightRGB::copy

(

const brightRGB &

other

)

copy data of "other" functor.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::globalFeatureExtractor.

bool lti::brightRGB::getAverage	(	const image &	img,
		dvector &	dest
	)			const [protected]

Calculates the average value of each channel of the image.

If the parameter transparent is true, the transparent color defined by the parameter transColor is not taken into account.

Parameters:

	img	image to be evaluated
	dest	vector with the average value of all not transparent points between R, G and B.

Returns:

true if apply successful or false otherwise.

bool lti::brightRGB::getMax	(	const image &	img,
		dvector &	dest
	)			const [protected]

Calculates the maximum value of each channel of the image.

If the parameter transparent is true, the transparent color defined by the parameter transColor is not taken into account.

Parameters:

	img	image to be evaluated
	dest	vector with the maximum value of all not transparent points between R, G and B.

Returns:

true if apply successful or false otherwise.

bool lti::brightRGB::getMedian	(	const image &	img,
		dvector &	dest
	)			const [protected]

Calculates the median of all values of each channel of the image.

If the parameter transparent is true, the transparent color defined by the parameter transColor is not taken into account.

Parameters:

	img	image to be evaluated
	dest	vector with the average value of all not transparent points between R, G and B.

Returns:

true if apply successful or false otherwise.

bool lti::brightRGB::getMin	(	const image &	img,
		dvector &	dest
	)			const [protected]

Calculates the minimum value of each channel of the image.

If the parameter transparent is true, the transparent color defined by the parameter transColor is not taken into account.

Parameters:

	img	image to be evaluated
	dest	vector with the minimum value of all not transparent points between R, G and B.

Returns:

true if apply successful or false otherwise.

const parameters& lti::brightRGB::getParameters

(

)

const

returns used parameters

Reimplemented from lti::globalFeatureExtractor.

virtual const char* lti::brightRGB::getTypeName

(

)

const [virtual]

returns the name of this type ("brightRGB")

Reimplemented from lti::globalFeatureExtractor.

brightRGB& lti::brightRGB::operator=

(

const brightRGB &

other

)

alias for copy member

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::functor.

---

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

• ltiBrightRGB.h