lti::realFFT::parameters Class Reference

Parameter class of the realFFT class. More...

#include <ltiRealFFT.h>

Inheritance diagram for lti::realFFT::parameters:

[legend]

Collaboration diagram for lti::realFFT::parameters:

[legend]

List of all members.

Public Types
enum	eMode { Cartesic, Polar }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
parameters &	copy (const parameters &other)
virtual functor::parameters *	clone () const
virtual const char *	getTypeName () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
eMode	mode

---

Detailed Description

Parameter class of the realFFT class.

the one and only parameter is the mode (i.e. Cartesic or Polar). Note that the cartesic transformation is faster.

---

Member Enumeration Documentation

enum lti::realFFT::parameters::eMode

enum type for mode parameter

Enumerator:

Cartesic	cartesic coordinates
Polar	polar coordinates

---

Constructor & Destructor Documentation

lti::realFFT::parameters::parameters

(

)

default constructor

Reimplemented from lti::transform::parameters.

lti::realFFT::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Reimplemented from lti::transform::parameters.

References copy().

---

Member Function Documentation

virtual functor::parameters* lti::realFFT::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters.

Reimplemented from lti::transform::parameters.

parameters& lti::realFFT::parameters::copy

(

const parameters &

other

)

copy member

Reimplemented from lti::transform::parameters.

Referenced by parameters().

virtual const char* lti::realFFT::parameters::getTypeName

(

)

const [virtual]

returns name of this class

Reimplemented from lti::transform::parameters.

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

eMode lti::realFFT::parameters::mode

format of the output vectors can be either cartesic or polar.

Note that cartesic is faster. Default: Cartesic

---

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

• ltiRealFFT.h