CLAM::SMSMorph Class Reference

Morph using the SMS model. More...

#include <SMSMorph.hxx>

Public Types
typedef SMSMorphConfig	Config
Public Member Functions
	SMSMorph ()
	~SMSMorph ()
bool	Do ()
	Supervised mode execution method (using ports).
bool	Do (const SpectralPeakArray &inPeaks1, const Fundamental &inFund1, const Spectrum &inSpectrum1, const SpectralPeakArray &inPeaks2, const Fundamental &inFund2, const Spectrum &inSpectrum2, SpectralPeakArray &outPeaks, Fundamental &outFund, Spectrum &outSpectrum)
bool	Do (const Frame &in1, const Frame &in2, Frame &out)
const ProcessingConfig &	GetConfig () const
	Configuration getter.
Protected Member Functions
bool	ConcreteConfigure (const ProcessingConfig &c)
	Configuration method interface.
Protected Attributes
SpectrumInterpolator	mSpectrumInterpolator
	Child processings.
SpectralPeakArrayInterpolator	mPeaksInterpolator

Detailed Description

Morph using the SMS model.

Allows to 'morph' or hybridize two sounds, so the resulting one has intermediate characteristics

Definition at line 42 of file SMSMorph.hxx.

Member Typedef Documentation

typedef SMSMorphConfig CLAM::SMSMorph::Config

Reimplemented from CLAM::Processing.

Definition at line 129 of file SMSMorph.hxx.

Constructor & Destructor Documentation

CLAM::SMSMorph::SMSMorph ( ) [inline]

Definition at line 66 of file SMSMorph.hxx.

References CLAM::Processing::Configure().

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

Definition at line 85 of file SMSMorph.hxx.

Member Function Documentation

bool CLAM::SMSMorph::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 98 of file SMSMorph.cxx.

bool CLAM::SMSMorph::Do	(	const Frame &	in1,
		const Frame &	in2,
		Frame &	out
	)

Definition at line 36 of file SMSMorph.cxx.

bool CLAM::SMSMorph::Do	(	const SpectralPeakArray &	inPeaks1,
		const Fundamental &	inFund1,
		const Spectrum &	inSpectrum1,
		const SpectralPeakArray &	inPeaks2,
		const Fundamental &	inFund2,
		const Spectrum &	inSpectrum2,
		SpectralPeakArray &	outPeaks,
		Fundamental &	outFund,
		Spectrum &	outSpectrum
	)

Definition at line 52 of file SMSMorph.cxx.

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

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 87 of file SMSMorph.hxx.

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

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