CLAM::PhaseManagement Class Reference

The PhaseManagement Class takes care about either. More...

#include <PhaseManagement.hxx>

List of all members.

Public Types

typedef PhaseManagementConfig Config

Public Member Functions

 PhaseManagement (const PhaseManagementConfig &c=Config())
 ~PhaseManagement ()
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
bool Do ()
 Supervised mode execution method (using ports).
bool Do (Frame &currentFrame)
bool Do (SpectralPeakArray &in)
 Basic non-supervised Do.
bool ConcreteConfigure (const ProcessingConfig &)
 Configuration method.
const ProcessingConfigGetConfig () const
 Configuration getter.
void Init ()
void ResetPhaseAlignment ()
void DoPhaseAlignment (SpectralPeakArray &peakArray)
void DoRandomPhases (SpectralPeakArray &peakArray)
void DoPhaseContinuation (SpectralPeakArray &p)
void SetLastPhasesAndFreqs (SpectralPeakArray &peakArray)
void GenerateRandomPhases (DataArray &a)

Public Attributes

FloatInControl mCurrentTime
FloatInControl mCurrentPitch

Detailed Description

The PhaseManagement Class takes care about either.

  1. generating a random set of phases and their continuation
  2. phase alignment

Definition at line 45 of file PhaseManagement.hxx.


Member Typedef Documentation

Reimplemented from CLAM::Processing.

Definition at line 48 of file PhaseManagement.hxx.


Constructor & Destructor Documentation

CLAM::PhaseManagement::PhaseManagement ( const PhaseManagementConfig c = Config()  ) 

Definition at line 25 of file PhaseManagement.cxx.

CLAM::PhaseManagement::~PhaseManagement (  ) 

Definition at line 65 of file PhaseManagement.cxx.


Member Function Documentation

bool CLAM::PhaseManagement::ConcreteConfigure ( const ProcessingConfig c  )  [virtual]

Configuration method.

Reimplemented from CLAM::Processing.

Definition at line 33 of file PhaseManagement.cxx.

bool CLAM::PhaseManagement::Do ( SpectralPeakArray in  ) 

Basic non-supervised Do.

Todo:
: the way the algorithms are now, they just allow inplace processing. This should be changed.

Definition at line 70 of file PhaseManagement.cxx.

bool CLAM::PhaseManagement::Do ( Frame currentFrame  ) 

Definition at line 97 of file PhaseManagement.cxx.

bool CLAM::PhaseManagement::Do (  )  [inline, virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 54 of file PhaseManagement.hxx.

void CLAM::PhaseManagement::DoPhaseAlignment ( SpectralPeakArray peakArray  ) 

Definition at line 117 of file PhaseManagement.cxx.

void CLAM::PhaseManagement::DoPhaseContinuation ( SpectralPeakArray p  ) 

Definition at line 237 of file PhaseManagement.cxx.

void CLAM::PhaseManagement::DoRandomPhases ( SpectralPeakArray peakArray  ) 

Definition at line 180 of file PhaseManagement.cxx.

void CLAM::PhaseManagement::GenerateRandomPhases ( DataArray a  ) 

Definition at line 280 of file PhaseManagement.cxx.

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

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

Implements CLAM::Processing.

Definition at line 52 of file PhaseManagement.hxx.

const ProcessingConfig& CLAM::PhaseManagement::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 64 of file PhaseManagement.hxx.

void CLAM::PhaseManagement::Init (  ) 

Definition at line 39 of file PhaseManagement.cxx.

void CLAM::PhaseManagement::ResetPhaseAlignment (  ) 

Definition at line 107 of file PhaseManagement.cxx.

void CLAM::PhaseManagement::SetLastPhasesAndFreqs ( SpectralPeakArray peakArray  ) 

Definition at line 289 of file PhaseManagement.cxx.


Member Data Documentation

Definition at line 70 of file PhaseManagement.hxx.

Definition at line 69 of file PhaseManagement.hxx.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3