CLAM::FrameInterpolator Class Reference

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

#include <FrameInterpolator.hxx>

List of all members.

Public Member Functions

 FrameInterpolator (const FrameInterpConfig &c=Config())
 ~FrameInterpolator ()
const ProcessingConfigGetConfig () 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

FloatInControl mFrameInterpolationFactorCtl
 Input control for interpolation factor.
FloatInControl mMagInterpolationFactorCtl
FloatInControl mFreqInterpolationFactorCtl
FloatInControl mPitchInterpolationFactorCtl
FloatInControl mResidualInterpolationFactorCtl
FloatInControl mPitch1Ctl
 Input controls for input pitch needed for harmonic interpolation.
FloatInControl mPitch2Ctl
FloatInControl mIsHarmonicCtl
 Input control for whether harmonic interpolation has to be performed.
InPort< FramemIn1
 Ports.
InPort< FramemIn2
OutPort< FramemOut
SpectrummpSpectralShape

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.


Constructor & Destructor Documentation

CLAM::FrameInterpolator::FrameInterpolator ( const FrameInterpConfig c = Config()  ) 

Definition at line 45 of file FrameInterpolator.cxx.

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

Definition at line 78 of file FrameInterpolator.hxx.


Member Function Documentation

void CLAM::FrameInterpolator::AttachSpectralShape ( Spectrum spec  )  [inline]

Definition at line 108 of file FrameInterpolator.hxx.

References mpSpectralShape.

bool CLAM::FrameInterpolator::Do ( const Frame in1,
const Frame in2,
Frame out 
)
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 141 of file FrameInterpolator.cxx.

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


Member Data Documentation

Input control for interpolation factor.

Definition at line 88 of file FrameInterpolator.hxx.

Definition at line 91 of file FrameInterpolator.hxx.

Ports.

Definition at line 104 of file FrameInterpolator.hxx.

Definition at line 105 of file FrameInterpolator.hxx.

Input control for whether harmonic interpolation has to be performed.

Definition at line 101 of file FrameInterpolator.hxx.

Referenced by Do().

Definition at line 90 of file FrameInterpolator.hxx.

Definition at line 106 of file FrameInterpolator.hxx.

Input controls for input pitch needed for harmonic interpolation.

Definition at line 97 of file FrameInterpolator.hxx.

Referenced by Do().

Definition at line 98 of file FrameInterpolator.hxx.

Referenced by Do().

Definition at line 92 of file FrameInterpolator.hxx.

Referenced by Do().

Definition at line 110 of file FrameInterpolator.hxx.

Referenced by AttachSpectralShape(), and Do().

Definition at line 93 of file FrameInterpolator.hxx.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3