CLAM::LPC_AutoCorrelation Class Reference

#include <LPC_AutoCorrelation.hxx>

Inheritance diagram for CLAM::LPC_AutoCorrelation:

Detailed Description

Definition at line 49 of file LPC_AutoCorrelation.hxx.


Public Member Functions
	LPC_AutoCorrelation ()
virtual	~LPC_AutoCorrelation ()
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do ()
	Supervised mode execution method (using ports).
bool	Do (const Audio &in, LPModel &out)
bool	Do (const Audio &in, DataArray &A, DataArray &K, TData &E)
Protected Member Functions
bool	ConcreteConfigure (const ProcessingConfig &cfg)
	Configuration method interface.
void	ComputeAutocorrelation (const Array< TData > &signal, Array< TData > &acCoeffs)
void	SolveSystemByLevinsonDurbin (const Array< TData > &R, Array< TData > &A, Array< TData > &K, TData &E)
Protected Attributes
InPort< Audio >	mAudioIn
OutPort< LPModel >	mLPModelOut
OutPort< Spectrum >	mSpectrumOut
LPCConfig	mCurrentConfig

Constructor & Destructor Documentation

CLAM::LPC_AutoCorrelation::LPC_AutoCorrelation ( )

Definition at line 52 of file LPC_AutoCorrelation.cxx.

References CLAM::Processing::Configure().

CLAM::LPC_AutoCorrelation::~LPC_AutoCorrelation ( ) [virtual]

Definition at line 60 of file LPC_AutoCorrelation.cxx.

Member Function Documentation

const char * CLAM::LPC_AutoCorrelation::GetClassName ( ) const [inline, virtual]

Override it in every subclass and retur the name of that class.

Implements CLAM::Processing.

Definition at line 88 of file LPC_AutoCorrelation.hxx.

const ProcessingConfig & CLAM::LPC_AutoCorrelation::GetConfig ( ) const [inline, virtual]

Configuration getter.

Gets the configuration parameters used to create the object.

Returns:: Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.

Reimplemented from CLAM::Processing.

Definition at line 93 of file LPC_AutoCorrelation.hxx.

References mCurrentConfig.

bool CLAM::LPC_AutoCorrelation::Do ( ) [virtual]

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 64 of file LPC_AutoCorrelation.cxx.

References CLAM::SpecTypeFlags::bComplex, CLAM::SpecTypeFlags::bMagPhase, CLAM::Audio::GetSize(), mAudioIn, mCurrentConfig, mLPModelOut, mSpectrumOut, CLAM::Spectrum::SetSize(), CLAM::Spectrum::SetType(), CLAM::LPModel::ToSpectrum(), and CLAM::LPModel::UpdateModelOrder().

Referenced by Do().

bool CLAM::LPC_AutoCorrelation::Do	(	const Audio &	in,
		LPModel &	out
	)

Definition at line 86 of file LPC_AutoCorrelation.cxx.

References Do(), and CLAM::DynamicType::UpdateData().

bool CLAM::LPC_AutoCorrelation::Do	(	const Audio &	in,
		DataArray &	A,
		DataArray &	K,
		TData &	E
	)

Special K!

Definition at line 139 of file LPC_AutoCorrelation.cxx.

References CLAM::Processing::AbleToExecute(), ComputeAutocorrelation(), mCurrentConfig, and SolveSystemByLevinsonDurbin().

bool CLAM::LPC_AutoCorrelation::ConcreteConfigure ( const ProcessingConfig & ) [protected, virtual]

Configuration method interface.

The Processing base class forces all the concrete classes derived from it to implement this method, which must actually perform the specific configuration tasks.

Note that the user can not call this method directly. He will use Configure instead. The argument is expected to be an object of the necesary concrete configuration class.

Parameters:

Reference

to the configuration object.

Returns:: false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)

true if the processing object is left in a consistent state, and can be executed.

Exceptions:

This

method must throw a bad_cast exception if the argument is not an object of the expected configuration class.

Reimplemented from CLAM::Processing.

Definition at line 163 of file LPC_AutoCorrelation.cxx.

References CLAM_ASSERT, CLAM::Processing::CopyAsConcreteConfig(), and mCurrentConfig.