CLAM-Development  1.1
Public Member Functions | Public Attributes
CLAM::SpectralPeakArrayInterpolator Class Reference

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

#include <SpectralPeakArrayInterpolator.hxx>

List of all members.

Public Member Functions

 SpectralPeakArrayInterpolator ()
 SpectralPeakArrayInterpolator (const PeaksInterpConfig &c)
 ~SpectralPeakArrayInterpolator ()
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution method (using ports)
bool Do (const SpectralPeakArray &in1, const SpectralPeakArray &in2, SpectralPeakArray &out)
bool Do (const SpectralPeakArray &in1, const SpectralPeakArray &in2, const Spectrum &spectralShape, SpectralPeakArray &out)
void AttachSpectralShape (Spectrum &spec)

Public Attributes

SpectralPeakArrayInterpolatorCtl mMagInterpolationFactorCtl
 Input control for interpolation factor.
SpectralPeakArrayInterpolatorCtl mFreqInterpolationFactorCtl
SpectralPeakArrayInterpolatorCtl mPitchInterpolationFactorCtl
SpectralPeakArrayInterpolatorCtl mPitch1Ctl
 Input controls for input pitch needed for harmonic interpolation.
SpectralPeakArrayInterpolatorCtl mPitch2Ctl
SpectralPeakArrayInterpolatorCtl mIsHarmonicCtl
 Input control for whether harmonic interpolation has to be performed.
InPort< SpectralPeakArraymIn1
 Ports.
InPort< SpectralPeakArraymIn2
OutPort< SpectralPeakArraymOut
SpectrummpSpectralShape

Detailed Description

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

Definition at line 54 of file SpectralPeakArrayInterpolator.hxx.


Constructor & Destructor Documentation

Definition at line 45 of file SpectralPeakArrayInterpolator.cxx.

References CLAM::Processing::Configure().

Definition at line 60 of file SpectralPeakArrayInterpolator.cxx.

References CLAM::Processing::Configure().

Definition at line 73 of file SpectralPeakArrayInterpolator.hxx.


Member Function Documentation

Definition at line 101 of file SpectralPeakArrayInterpolator.hxx.

References mpSpectralShape.

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

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 329 of file SpectralPeakArrayInterpolator.cxx.

References CLAM::InPort< Token >::GetData(), CLAM::OutPort< Token >::GetData(), mIn1, mIn2, mOut, and mpSpectralShape.

Referenced by CLAM::FrameInterpolator::Do(), and CLAM::SMSMorph::Do().

bool CLAM::SpectralPeakArrayInterpolator::Do ( const SpectralPeakArray in1,
const SpectralPeakArray in2,
const Spectrum spectralShape,
SpectralPeakArray out 
)

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 75 of file SpectralPeakArrayInterpolator.hxx.


Member Data Documentation

Definition at line 84 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

Ports.

Definition at line 96 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

Definition at line 97 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

Input control for whether harmonic interpolation has to be performed.

Definition at line 93 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

Input control for interpolation factor.

Definition at line 83 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

Definition at line 98 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

Input controls for input pitch needed for harmonic interpolation.

Definition at line 89 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

Definition at line 90 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

Definition at line 85 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

Definition at line 100 of file SpectralPeakArrayInterpolator.hxx.

Referenced by AttachSpectralShape(), and Do().


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