lti::shiftInvariance::parameters Class Reference

the parameters for the class shiftInvariance More...

#include <ltiShiftInvariance.h>

Inheritance diagram for lti::shiftInvariance::parameters:

[legend]

Collaboration diagram for lti::shiftInvariance::parameters:

[legend]

List of all members.

Public Types
enum	eMode { Fourier, Momentum }
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
eMode	mode

---

Detailed Description

the parameters for the class shiftInvariance

---

Member Enumeration Documentation

enum lti::shiftInvariance::parameters::eMode

Shift invariance mode.

Enumerator:

Fourier	Try to eliminate the phase term caused by signal shift.
Momentum	Shift the signal in a way that the first cyclic momentum is position at 0.

---

Constructor & Destructor Documentation

lti::shiftInvariance::parameters::parameters

(

)

default constructor

Reimplemented from lti::globalFeatureExtractor::parameters.

lti::shiftInvariance::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::globalFeatureExtractor::parameters.

lti::shiftInvariance::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::globalFeatureExtractor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::shiftInvariance::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::globalFeatureExtractor::parameters.

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

(

)

const [virtual]

returns name of this type

Reimplemented from lti::globalFeatureExtractor::parameters.

parameters& lti::shiftInvariance::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::shiftInvariance::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::shiftInvariance::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::shiftInvariance::parameters::mode

the mode to be used.

Default value: Momentum

---

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

• ltiShiftInvariance.h