CLAM::PhaseManagement Class Reference

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

#include <PhaseManagement.hxx>

Inheritance diagram for CLAM::PhaseManagement:

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 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
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

typedef PhaseManagementConfig CLAM::PhaseManagement::Config

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

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

CLAM::PhaseManagement::~PhaseManagement

(

)

Definition at line 69 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 52 of file PhaseManagement.hxx.

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.

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

bool CLAM::PhaseManagement::Do

(

Frame &

currentFrame

)

Definition at line 101 of file PhaseManagement.cxx.

References Do(), CLAM::InControl< ControlDataType >::DoControl(), 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 74 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 37 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 64 of file PhaseManagement.hxx.

void CLAM::PhaseManagement::Init

(

)

Definition at line 43 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 111 of file PhaseManagement.cxx.

void CLAM::PhaseManagement::DoPhaseAlignment

(

SpectralPeakArray &

peakArray

)

Definition at line 121 of file PhaseManagement.cxx.

References CLAM::SpectralPeakArray::GetFreq(), CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::SpectralPeakArray::GetPhase(), mCurrentPitch, mCurrentTime, CLAM::SpectralPeakArray::SetIsIndexUpToDate(), CLAM::SpectralPeakArray::SetPhase(), and TWO_PI.

Referenced by Do().

void CLAM::PhaseManagement::DoRandomPhases

(

SpectralPeakArray &

peakArray

)

Definition at line 184 of file PhaseManagement.cxx.

References CLAM::SpectralPeakArray::GetFreq(), CLAM::SpectralPeakArray::GetIndex(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::SpectralPeakArray::GetSpectralPeak(), CLAM::SpectralPeakArray::SetIsIndexUpToDate(), CLAM::SpectralPeakArray::SetPhase(), and TWO_PI.

Referenced by Do().

void CLAM::PhaseManagement::DoPhaseContinuation

(

SpectralPeakArray &

p

)

Definition at line 241 of file PhaseManagement.cxx.

References CLAM::SpectralPeakArray::GetIndex(), CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::SpectralPeakArray::GetPositionFromIndex(), mCurrentTime, CLAM::SpectralPeakArray::SetIsIndexUpToDate(), and TWO_PI.

Referenced by Do().

void CLAM::PhaseManagement::SetLastPhasesAndFreqs

(

SpectralPeakArray &

peakArray

)

Definition at line 293 of file PhaseManagement.cxx.

References CLAM::SpectralPeakArray::GetnPeaks(), and CLAM::SpectralPeakArray::SetIsIndexUpToDate().

void CLAM::PhaseManagement::GenerateRandomPhases

(

DataArray &

a

)

Definition at line 284 of file PhaseManagement.cxx.

References TWO_PI.

Referenced by Init().

---

Member Data Documentation

FloatInControl CLAM::PhaseManagement::mCurrentTime

Definition at line 69 of file PhaseManagement.hxx.

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

FloatInControl CLAM::PhaseManagement::mCurrentPitch

Definition at line 70 of file PhaseManagement.hxx.

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

---

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

• PhaseManagement.hxx
• PhaseManagement.cxx