lti::histogramRGBL::parameters Class Reference

the parameters for the class histogramRGBL More...

#include <ltiHistogramRGBL.h>

Inheritance diagram for lti::histogramRGBL::parameters:

[legend]

Collaboration diagram for lti::histogramRGBL::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
bool	smooth
kernel1D< double >	kernel
bool	normalize
int	cells
bool	considerAllData
rgbPixel	ignoreValue

---

Detailed Description

the parameters for the class histogramRGBL

---

Constructor & Destructor Documentation

lti::histogramRGBL::parameters::parameters

(

)

default constructor

Reimplemented from lti::globalFeatureExtractor::parameters.

lti::histogramRGBL::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::globalFeatureExtractor::parameters.

lti::histogramRGBL::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::globalFeatureExtractor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::histogramRGBL::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::globalFeatureExtractor::parameters.

parameters& lti::histogramRGBL::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::histogramRGBL::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::globalFeatureExtractor::parameters.

parameters& lti::histogramRGBL::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::histogramRGBL::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[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.

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

int lti::histogramRGBL::parameters::cells

Number of cells per single color histogram.

The dimensionality of the resulting feature vector will be four times this value. Default value: 32 (i.e. 128 dimensions for the final feature vector)

bool lti::histogramRGBL::parameters::considerAllData

if true, the ignoreValue will be ignored and all data values will be considered in the histogram generation.

If false (the default) all but the pixels with value ignoreValue will be considered. Default value: false

rgbPixel lti::histogramRGBL::parameters::ignoreValue

this value will be ignored in the histogram.

It is usually used to ignore the background. Default value (0,0,0), i.e. black will be ignored.

kernel1D<double> lti::histogramRGBL::parameters::kernel

smoothing kernel.

Default: gaussian kernel of size 3 (default variance).

bool lti::histogramRGBL::parameters::normalize

If true, the area under the each single histogram will be normalized to one; i.e.

the total area will be four. Default value: true

bool lti::histogramRGBL::parameters::smooth

If true, the resulting feature vector will be smothed using the given filter kernel.

Default value: true

---

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

• ltiHistogramRGBL.h