CLAM::FrameAdder Class Reference

#include <FrameAdder.hxx>

Inheritance diagram for CLAM::FrameAdder:

List of all members.

Detailed Description

This class performs the interpolation of two Frame processing data objects.

Note that only spectral peak array for the sinusoidal component and residual spectrum are interpolated.

Todo:: : maybe other attributes in Frame could also be interpolated if so specified in the configuration.

Definition at line 48 of file FrameAdder.hxx.


Public Member Functions
	FrameAdder ()
	FrameAdder (const FrameAdderConfig &c)
	~FrameAdder ()
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do (void)
	Supervised mode execution method (using ports).
bool	Do (const Frame &in1, const Frame &in2, Frame &out)
Public Attributes
InPort< Frame >	mIn1
	Ports.
InPort< Frame >	mIn2
OutPort< Frame >	mOut

Constructor & Destructor Documentation

CLAM::FrameAdder::FrameAdder ( )

Definition at line 30 of file FrameAdder.cxx.

References CLAM::Processing::Configure().

CLAM::FrameAdder::FrameAdder ( const FrameAdderConfig & c )

Definition at line 39 of file FrameAdder.cxx.

References CLAM::Processing::Configure().

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

Definition at line 68 of file FrameAdder.hxx.

Member Function Documentation

const ProcessingConfig& CLAM::FrameAdder::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.

Implements CLAM::ProcessingComposite.

Definition at line 70 of file FrameAdder.hxx.

bool CLAM::FrameAdder::Do ( void ) [virtual]

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::ProcessingComposite.

Definition at line 91 of file FrameAdder.cxx.

References CLAM_ASSERT.

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

we set the output fundamental to zero. Note that when adding two frames we have a polyphonic signal and the representation of the resulting sum of harmonics is not trivial.

Now we add spectral peaks

Finally we add residual spectrum

Definition at line 64 of file FrameAdder.cxx.

References CLAM_DEBUG_ASSERT, CLAM::SpectrumAdder2::Do(), CLAM::SpectralPeakArrayAdder::Do(), and CLAM::Processing::IsRunning().