CLAM::PhaseManagement Class Reference

#include <PhaseManagement.hxx>

Inheritance diagram for CLAM::PhaseManagement:

Detailed Description

The PhaseManagement Class takes care about either.

generating a random set of phases and their continuation
phase alignment

Definition at line 45 of file PhaseManagement.hxx.


Public Member Functions
	PhaseManagement ()
	PhaseManagement (PhaseManagementConfig &c)
	~PhaseManagement ()
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
bool	Do (void)
	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 ProcessingConfig &	GetConfig () 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
InControlTmpl< PhaseManagement >	mCurrentTime
InControlTmpl< PhaseManagement >	mCurrentPitch

Constructor & Destructor Documentation

CLAM::PhaseManagement::PhaseManagement ( )

Definition at line 31 of file PhaseManagement.cxx.

References CLAM::Processing::Configure(), and Init().

CLAM::PhaseManagement::PhaseManagement ( PhaseManagementConfig & c )

Definition at line 38 of file PhaseManagement.cxx.

References CLAM::Processing::Configure(), and Init().

CLAM::PhaseManagement::~PhaseManagement ( )

Definition at line 77 of file PhaseManagement.cxx.

Member Function Documentation

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 53 of file PhaseManagement.hxx.

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

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 55 of file PhaseManagement.hxx.

Referenced by CLAM::SMSSynthesis::Do(), CLAM::SinusoidalSynthesis::Do(), and Do().

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

Definition at line 109 of file PhaseManagement.cxx.

References Do(), mCurrentPitch, and mCurrentTime.

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 82 of file PhaseManagement.cxx.

References DoPhaseAlignment(), DoPhaseContinuation(), DoRandomPhases(), CLAM::EPhaseGeneration::eAlign, CLAM::EPhaseGeneration::eContinuation, CLAM::EPhaseGeneration::eNone, and CLAM::EPhaseGeneration::eRandom.

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

Configuration method.

Reimplemented from CLAM::Processing.

Definition at line 45 of file PhaseManagement.cxx.

References CLAM::Processing::CopyAsConcreteConfig().

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 65 of file PhaseManagement.hxx.

void CLAM::PhaseManagement::Init ( )

Definition at line 51 of file PhaseManagement.cxx.

References CLAM::EScale::eLog, GenerateRandomPhases(), CLAM::SpectralPeakArray::SetIsIndexUpToDate(), and CLAM::DynamicType::UpdateData().

Referenced by PhaseManagement().

void CLAM::PhaseManagement::ResetPhaseAlignment ( )

Definition at line 119 of file PhaseManagement.cxx.

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

Definition at line 129 of file PhaseManagement.cxx.

References CLAM::SpectralPeakArray::GetFreq(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::SpectralPeakArray::GetPhase(), mCurrentPitch, mCurrentTime, CLAM::SpectralPeakArray::SetIsIndexUpToDate(), CLAM::SpectralPeakArray::SetPhase(), and TWO_PI.

Referenced by Do().