lti::downsampling::parameters Class Reference

the parameters for the class downsampling More...

#include <ltiDownsampling.h>

Inheritance diagram for lti::downsampling::parameters:

[legend]

Collaboration diagram for lti::downsampling::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
virtual functor::parameters *	clone () const
const mathObject &	getKernel () const
void	setKernel (const mathObject &aKernel)
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
mathObject *	kernel
point	factor

---

Detailed Description

the parameters for the class downsampling

---

Constructor & Destructor Documentation

lti::downsampling::parameters::parameters

(

)

default constructor

Reimplemented from lti::modifier::parameters.

lti::downsampling::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::modifier::parameters.

lti::downsampling::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::downsampling::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::modifier::parameters.

parameters& lti::downsampling::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 mathObject& lti::downsampling::parameters::getKernel

(

)

const

returns the kernel in use.

If it is not set yet, an lti::invalidParameters exception will be thrown

Returns:

a const reference to the filter kernel.

const char* lti::downsampling::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::modifier::parameters.

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

void lti::downsampling::parameters::setKernel

(

const mathObject &

aKernel

)

sets the filter kernel to be used.

A copy of the given parameter will be made!

Default value: see attribute lti::downsampling::parameters::kernel

Parameters:

aKernel

the filter kernel to be used

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

point lti::downsampling::parameters::factor

the downsampling factor

Only the pixels with coordinates x=n*factor.x or y=m*factor.y, (n and m integers) will be taken.

The default value is (2,2).

mathObject* lti::downsampling::parameters::kernel

The filter to be used.

This should be a separable kernel of the same type as the object to be decimated, with only one filter pair. If not, some time will be required to construct an adequate filter kernel!

The default value for the kernel is a 3x3 separable kernel, with row/column kernel of the form (0.25 0.5 0.25)x(0.25 0.5 0.25).

---

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

• ltiDownsampling.h