CLAM-Development  1.4.0
Public Member Functions | Protected Member Functions | Protected Attributes
CLAM::LPC_AutoCorrelation Class Reference

#include <LPC_AutoCorrelation.hxx>

List of all members.

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 ProcessingConfigGetConfig () 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)
- Public Member Functions inherited from CLAM::Processing
bool Configure (const ProcessingConfig &config)
 Configuration change method.
void Start (void)
 Method to turn the object into running state.
void Stop (void)
 Method to put the object out of running state When in execution mode, this method must be called before any further call to Configure() methods.
 Processing ()
virtual ~Processing ()
virtual bool CanProcessInplace ()
 Override this method if your processing cannot process inplace.
bool CanConsumeAndProduce ()
 Check that Supervised Do() can be safely called.
void ConsumeAndProduce ()
 Acknoledges data tokens in published ports as read/writen by calling Produce() for all registered OutPorts and Consume() to all registered InPorts.
std::string GetExecStateString () const
bool IsConfigured () const
bool IsRunning () const
void RegisterOutPort (OutPortBase *out)
void RegisterInPort (InPortBase *in)
void RegisterOutControl (OutControlBase *out)
void RegisterInControl (InControlBase *in)
void SetParent (Processing *p)
void SetNetworkBackLink (Network *network)
virtual bool ModifiesPortsAndControlsAtConfiguration ()
 This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e.
bool HasInPort (const std::string &name)
bool HasOutPort (const std::string &name)
bool HasInControl (const std::string &name)
bool HasOutControl (const std::string &name)
InPortBaseGetInPort (const std::string &name)
OutPortBaseGetOutPort (const std::string &name)
InControlBaseGetInControl (const std::string &name)
OutControlBaseGetOutControl (const std::string &name)
InPortBaseGetInPort (unsigned index)
OutPortBaseGetOutPort (unsigned index)
InControlBaseGetInControl (unsigned index)
OutControlBaseGetOutControl (unsigned index)
unsigned GetNInPorts () const
unsigned GetNOutPorts () const
unsigned GetNInControls () const
unsigned GetNOutControls () const
const std::string & GetConfigErrorMessage () const
 Returns a string describing configuration errors if any.
virtual bool IsSyncSource () const
 Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e.
virtual bool SupportsVariableAudioSize () const
 This method reports whether the processing supports dynamic buffer-size host.

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 Member Functions inherited from CLAM::Processing
virtual bool ConcreteStart ()
 Processing objects have to redefine this method when starting them implies some internal changes.
virtual bool ConcreteStop ()
 Processing objects have to redefine this method when stoping them implies some internal changes.
unsigned BackendBufferSize ()
 Given by the NetworkPlayer (backend) if exists.
unsigned BackendSampleRate ()
 Given by the NetworkPlayer (backend) if exists.
InControlRegistryGetInControls ()
 Accessor to published Controls manager.
OutControlRegistryGetOutControls ()
 Accessor to published Controls manager.
InPortRegistryGetInPorts ()
 Accessor to published Ports manager.
OutPortRegistryGetOutPorts ()
 Accessor to published Portss manager.
bool AddConfigErrorMessage (const std::string &msg)
 Use this method to append a configuration errors to the processing when implementing ConcreteConfigure.
bool AbleToExecute (void) const
 In debug-mode checks that the processing is configured and started.
template<typename ConcreteConfig >
void CopyAsConcreteConfig (ConcreteConfig &concrete, const ProcessingConfig &abstract) const
 Helper template to convert a reference to a ProcessingConfig to the concrete ProcessingConfig specified on the first parameter.
void SetExecState (ExecState state)

Protected Attributes

InPort< AudiomAudioIn
OutPort< LPModelmLPModelOut
OutPort< SpectrummSpectrumOut
LPCConfig mCurrentConfig
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Additional Inherited Members

- Public Types inherited from CLAM::Processing
enum  ExecState { Unconfigured = 0, Ready, Running }
 Processing Object possible execution states. More...
typedef NullProcessingConfig Config

Detailed Description

Definition at line 49 of file LPC_AutoCorrelation.hxx.


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

void CLAM::LPC_AutoCorrelation::ComputeAutocorrelation ( const Array< TData > &  signal,
Array< TData > &  acCoeffs 
)
protected

Definition at line 184 of file LPC_AutoCorrelation.cxx.

References CLAM::dot_product(), CLAM::Array< T >::GetPtr(), NULL, and CLAM::Array< T >::Size().

Referenced by Do().

bool CLAM::LPC_AutoCorrelation::ConcreteConfigure ( const ProcessingConfig )
protectedvirtual

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:
Referenceto 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:
Thismethod 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.

bool CLAM::LPC_AutoCorrelation::Do ( )
virtual
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 
)
const char * CLAM::LPC_AutoCorrelation::GetClassName ( ) const
inlinevirtual

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
inlinevirtual

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.

void CLAM::LPC_AutoCorrelation::SolveSystemByLevinsonDurbin ( const Array< TData > &  R,
Array< TData > &  A,
Array< TData > &  K,
TData E 
)
protected

Definition at line 219 of file LPC_AutoCorrelation.cxx.

References CLAM_ASSERT, mCurrentConfig, and CLAM::Array< T >::Size().

Referenced by Do().


Member Data Documentation

InPort<Audio> CLAM::LPC_AutoCorrelation::mAudioIn
protected

Definition at line 67 of file LPC_AutoCorrelation.hxx.

Referenced by Do().

LPCConfig CLAM::LPC_AutoCorrelation::mCurrentConfig
protected
OutPort<LPModel> CLAM::LPC_AutoCorrelation::mLPModelOut
protected

Definition at line 68 of file LPC_AutoCorrelation.hxx.

Referenced by Do().

OutPort<Spectrum> CLAM::LPC_AutoCorrelation::mSpectrumOut
protected

Definition at line 69 of file LPC_AutoCorrelation.hxx.

Referenced by Do().


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