CLAM::FrameInterpolator Class Reference

#include <FrameInterpolator.hxx>

Inheritance diagram for CLAM::FrameInterpolator:

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 60 of file FrameInterpolator.hxx.

Public Member Functions
	FrameInterpolator ()
	FrameInterpolator (const FrameInterpConfig &c)
	~FrameInterpolator ()
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)
void	AttachSpectralShape (Spectrum &spec)
Public Attributes
FrameInterpolatorCtl	mFrameInterpolationFactorCtl
	Input control for interpolation factor.
FrameInterpolatorCtl	mMagInterpolationFactorCtl
FrameInterpolatorCtl	mFreqInterpolationFactorCtl
FrameInterpolatorCtl	mPitchInterpolationFactorCtl
FrameInterpolatorCtl	mResidualInterpolationFactorCtl
FrameInterpolatorCtl	mPitch1Ctl
	Input controls for input pitch needed for harmonic interpolation.
FrameInterpolatorCtl	mPitch2Ctl
FrameInterpolatorCtl	mIsHarmonicCtl
	Input control for whether harmonic interpolation has to be performed.
InPort< Frame >	mIn1
	Ports.
InPort< Frame >	mIn2
OutPort< Frame >	mOut
Spectrum *	mpSpectralShape

---

Constructor & Destructor Documentation

CLAM::FrameInterpolator::FrameInterpolator

(

)

Definition at line 48 of file FrameInterpolator.cxx.

References CLAM::Processing::Configure().

CLAM::FrameInterpolator::FrameInterpolator

(

const FrameInterpConfig &

c

)

Definition at line 66 of file FrameInterpolator.cxx.

References CLAM::Processing::Configure().

CLAM::FrameInterpolator::~FrameInterpolator

(

)

[inline]

Definition at line 82 of file FrameInterpolator.hxx.

---

Member Function Documentation

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

bool CLAM::FrameInterpolator::Do

(

void

)

[virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::ProcessingComposite.

Definition at line 162 of file FrameInterpolator.cxx.

References CLAM_ASSERT.

Referenced by CLAM::SegmentSMSTimeStretch::Do(), CLAM::SegmentSMSMorph::Do(), and CLAM::SegmentSMSMorph::FindInterpolatedFrameFromSegment2Morph().

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

Definition at line 127 of file FrameInterpolator.cxx.

References CLAM_DEBUG_ASSERT, CLAM::SpectrumInterpolator::Do(), CLAM::SpectralPeakArrayInterpolator::Do(), CLAM::Frame::GetFundamentalFreq(), CLAM::Processing::IsRunning(), mIsHarmonicCtl, mPitch1Ctl, mPitch2Ctl, mPitchInterpolationFactorCtl, and mpSpectralShape.

void CLAM::FrameInterpolator::AttachSpectralShape

(

Spectrum &

spec

)

[inline]

Definition at line 112 of file FrameInterpolator.hxx.

References mpSpectralShape.

Referenced by CLAM::SegmentSMSMorph::ConcreteConfigure().

---

Member Data Documentation

FrameInterpolatorCtl CLAM::FrameInterpolator::mFrameInterpolationFactorCtl

Input control for interpolation factor.

Definition at line 92 of file FrameInterpolator.hxx.

Referenced by CLAM::SegmentSMSTimeStretch::Do(), and CLAM::SegmentSMSMorph::UpdateFrameInterpolatorFactors().

FrameInterpolatorCtl CLAM::FrameInterpolator::mMagInterpolationFactorCtl

Definition at line 94 of file FrameInterpolator.hxx.

Referenced by CLAM::SegmentSMSMorph::UpdateFrameInterpolatorFactors().

FrameInterpolatorCtl CLAM::FrameInterpolator::mFreqInterpolationFactorCtl

Definition at line 95 of file FrameInterpolator.hxx.

Referenced by CLAM::SegmentSMSMorph::UpdateFrameInterpolatorFactors().

FrameInterpolatorCtl CLAM::FrameInterpolator::mPitchInterpolationFactorCtl

Definition at line 96 of file FrameInterpolator.hxx.

Referenced by Do(), and CLAM::SegmentSMSMorph::UpdateFrameInterpolatorFactors().

FrameInterpolatorCtl CLAM::FrameInterpolator::mResidualInterpolationFactorCtl

Definition at line 97 of file FrameInterpolator.hxx.

Referenced by CLAM::SegmentSMSMorph::UpdateFrameInterpolatorFactors().

FrameInterpolatorCtl CLAM::FrameInterpolator::mPitch1Ctl

Input controls for input pitch needed for harmonic interpolation.

Definition at line 101 of file FrameInterpolator.hxx.

Referenced by Do().

FrameInterpolatorCtl CLAM::FrameInterpolator::mPitch2Ctl

Definition at line 102 of file FrameInterpolator.hxx.

Referenced by Do().

FrameInterpolatorCtl CLAM::FrameInterpolator::mIsHarmonicCtl

Input control for whether harmonic interpolation has to be performed.

Definition at line 105 of file FrameInterpolator.hxx.

Referenced by Do().

InPort<Frame> CLAM::FrameInterpolator::mIn1

Ports.

Definition at line 108 of file FrameInterpolator.hxx.

InPort<Frame> CLAM::FrameInterpolator::mIn2

Definition at line 109 of file FrameInterpolator.hxx.

OutPort<Frame> CLAM::FrameInterpolator::mOut

Definition at line 110 of file FrameInterpolator.hxx.

Spectrum* CLAM::FrameInterpolator::mpSpectralShape

Definition at line 114 of file FrameInterpolator.hxx.

Referenced by AttachSpectralShape(), and Do().

---

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

• FrameInterpolator.hxx
• FrameInterpolator.cxx