lti::ogdFilter::parameters Class Reference

the parameters for all ogd filters More...

#include <ltiOgdFilter.h>

Inheritance diagram for lti::ogdFilter::parameters:

[legend]

Collaboration diagram for lti::ogdFilter::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
int	order
int	size
double	variance
double	angle

---

Detailed Description

the parameters for all ogd filters

---

Constructor & Destructor Documentation

lti::ogdFilter::parameters::parameters

(

)

default constructor

Reimplemented from lti::modifier::parameters.

lti::ogdFilter::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::modifier::parameters.

lti::ogdFilter::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::ogdFilter::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::modifier::parameters.

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

const char* lti::ogdFilter::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::modifier::parameters.

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

virtual bool lti::ogdFilter::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::modifier::parameters.

---

Member Data Documentation

double lti::ogdFilter::parameters::angle

orientation in radians (0 rad is equivalent to the positive x-Axis)

Default value: 0.0

int lti::ogdFilter::parameters::order

Order of the OGD to be used (1 or 2).

Default value: 1

int lti::ogdFilter::parameters::size

size of the used filter kernel (the 2D kernel has a dimension size x size)

Default value: 5

double lti::ogdFilter::parameters::variance

Variance of the Gaussian.

If you give -1.0 here, the variance will be computed from the given size, exaclty as for the Gaussian Kernels.

Default value: 1.4

---

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

• ltiOgdFilter.h