lti::histograming1D::parameters Class Reference

the parameters for the class histograming1D More...

#include <ltiHistograming1D.h>

Inheritance diagram for lti::histograming1D::parameters:

[legend]

Collaboration diagram for lti::histograming1D::parameters:

[legend]

List of all members.

Public Types
enum	eMode { Normal, Extremes, Interval }
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
kernel1D< double >	kernel
bool	smooth
int	cells
eMode	mode
bool	normalize
float	intervalLow
float	intervalHigh
float	ignoreValue

---

Detailed Description

the parameters for the class histograming1D

---

Member Enumeration Documentation

enum lti::histograming1D::parameters::eMode

type to specify the mode of histogram

Enumerator:

Normal	the histogram will be calculated between 0 and 1.0 for channels or between 0 and 255 for channel8s. Values under 0 will be assigned to 0 and values above 1.0 (or 255) will be assigned to the cells-1 cell. The ignoreValue allows to ignore one specific value in this interval (usually used to ignore background
Extremes	the histogram will be calculated between the min and max values of the input data
Interval	the histogram will be calculated between the given interval values. Note that the given values will be interpreted "as is", for example if you give as interval 0-1.0, the whole channel value range will be histogramed, but only two values of channel8 will be considered!. Only the values in the interval will be considered, i.e. elements outside the interval will be ignored.

---

Constructor & Destructor Documentation

lti::histograming1D::parameters::parameters

(

)

default constructor

Reimplemented from lti::globalFeatureExtractor::parameters.

lti::histograming1D::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::globalFeatureExtractor::parameters.

lti::histograming1D::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::globalFeatureExtractor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::histograming1D::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::globalFeatureExtractor::parameters.

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

(

)

const [virtual]

returns name of this type

Reimplemented from lti::globalFeatureExtractor::parameters.

parameters& lti::histograming1D::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::histograming1D::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::histograming1D::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::histograming1D::parameters::cells

Number of cells in the histogram.

Default: 256

float lti::histograming1D::parameters::ignoreValue

this value will be ignored (Default -1.0f)

float lti::histograming1D::parameters::intervalHigh

if mode==Interval, this is the highest value to be considered (Default 1.0f)

float lti::histograming1D::parameters::intervalLow

if mode==Interval, this is the lowest value considered (Default 0.0f)

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

The smoothing kernel.

Default value: the default gaussian kernel of size 3

eMode lti::histograming1D::parameters::mode

the mode of histograming (see eMode).

If the mode is "Normal", the outliers will be considered as part of the nearest cell. (for example if using a channel, and the value of a pixel is -0.1 the cell 0 will be incremented). Default value: Normal

bool lti::histograming1D::parameters::normalize

if true, the histogram will be normalized (to have an area of 1) Default: false

bool lti::histograming1D::parameters::smooth

smooth specify if the kernel should be apply at the end of the histograming.

Default value: false

---

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

• ltiHistograming1D.h