CLAM::SMSTimeStretch Class Reference

Time Stretch using the SMS model. More...

#include <SMSTimeStretch.hxx>

Public Types
typedef SMSTimeStretchConfig	Config
Public Member Functions
	SMSTimeStretch ()
	~SMSTimeStretch ()
bool	Do ()
	Supervised mode execution method (using ports).
bool	Do (const Frame &in, Frame &out)
bool	Do (const SpectralPeakArray &inPeaks, const Fundamental &inFund, const Spectrum &inSpectrum, SpectralPeakArray &outPeaks, Fundamental &outFund, Spectrum &outSpectrum)
bool	ConcreteStart ()
	Processing objects have to redefine this method when starting them implies some internal changes.
bool	ConcreteStop ()
	Processing objects have to redefine this method when stoping them implies some internal changes.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
Protected Member Functions
bool	ConcreteConfigure (const ProcessingConfig &config)
	Configuration method interface.
Protected Attributes
TTime	mSynthesisTime
TTime	mAnalysisTime
TIndex	mnSynthesisFrames
Frame	mLeftFrame
SpectrumInterpolator	mSpectrumInterpolator
	Child processings.
SpectralPeakArrayInterpolator	mPeaksInterpolator

Detailed Description

Time Stretch using the SMS model.

Todo:: : introduce interpolation of spectral shapes, before that, interpolations may be extracted to external Processing's

Definition at line 44 of file SMSTimeStretch.hxx.

Member Typedef Documentation

typedef SMSTimeStretchConfig CLAM::SMSTimeStretch::Config

Reimplemented from CLAM::Processing.

Definition at line 117 of file SMSTimeStretch.hxx.

Constructor & Destructor Documentation

CLAM::SMSTimeStretch::SMSTimeStretch ( ) [inline]

Definition at line 59 of file SMSTimeStretch.hxx.

References CLAM::Processing::Configure().

CLAM::SMSTimeStretch::~SMSTimeStretch ( ) [inline]

Definition at line 71 of file SMSTimeStretch.hxx.

Member Function Documentation

bool CLAM::SMSTimeStretch::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 166 of file SMSTimeStretch.cxx.

References CLAM::Processing::CopyAsConcreteConfig().

bool CLAM::SMSTimeStretch::ConcreteStart ( void ) [virtual]

Processing objects have to redefine this method when starting them implies some internal changes.

ie: adquiring resources.

Returns:: Whether start changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 195 of file SMSTimeStretch.cxx.

bool CLAM::SMSTimeStretch::ConcreteStop ( ) [virtual]

Processing objects have to redefine this method when stoping them implies some internal changes.

ie: releasing resources.

Returns:: Whether stop changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 188 of file SMSTimeStretch.cxx.

bool CLAM::SMSTimeStretch::Do	(	const SpectralPeakArray &	inPeaks,
		const Fundamental &	inFund,
		const Spectrum &	inSpectrum,
		SpectralPeakArray &	outPeaks,
		Fundamental &	outFund,
		Spectrum &	outSpectrum
	)

TODO: This method does not work if called directly! it must be called from the Segment overload

Definition at line 79 of file SMSTimeStretch.cxx.

References mnSynthesisFrames, and mSynthesisTime.

bool CLAM::SMSTimeStretch::Do	(	const Frame &	in,
		Frame &	out
	)

Definition at line 37 of file SMSTimeStretch.cxx.

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

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 73 of file SMSTimeStretch.hxx.

References CLAM::InPort< Token >::Consume(), CLAM::OutPort< Token >::GetData(), CLAM::InPort< Token >::GetData(), and CLAM::OutPort< Token >::Produce().

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