lti::convolution::parameters Class Reference

parameters of the lti::convolution functor More...

#include <ltiConvolution.h>

Inheritance diagram for lti::convolution::parameters:

[legend]

Collaboration diagram for lti::convolution::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~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)
Protected Attributes
mathObject *	kernel

---

Detailed Description

parameters of the lti::convolution functor

---

Constructor & Destructor Documentation

lti::convolution::parameters::parameters

(

)

default constructor

Reimplemented from lti::modifier::parameters.

lti::convolution::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::modifier::parameters.

virtual lti::convolution::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::convolution::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of this parameters

Reimplemented from lti::modifier::parameters.

parameters& lti::convolution::parameters::copy

(

const parameters &

other

)

copy the contents of other parameter object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this object

Reimplemented from lti::filter::parameters.

const mathObject& lti::convolution::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::convolution::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::modifier::parameters.

virtual bool lti::convolution::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::convolution::parameters::setKernel

(

const mathObject &

aKernel

)

sets the filter kernel to be used.

A copy of the given parameter will be made!

Parameters:

aKernel

the filter kernel to be used

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

mathObject* lti::convolution::parameters::kernel [protected]

pointer to the filter kernel copy

---

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

• ltiConvolution.h