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 (const PeaksInterpConfig &c=Config())
	~SpectralPeakArrayInterpolator ()
const ProcessingConfig &	GetConfig () 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
FloatInControl	mMagInterpolationFactorCtl
	Input control for interpolation factor.
FloatInControl	mFreqInterpolationFactorCtl
FloatInControl	mPitchInterpolationFactorCtl
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< SpectralPeakArray >	mIn1
	Ports.
InPort< SpectralPeakArray >	mIn2
OutPort< SpectralPeakArray >	mOut
Spectrum *	mpSpectralShape

---

Detailed Description

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

Definition at line 54 of file SpectralPeakArrayInterpolator.hxx.

---

Constructor & Destructor Documentation

CLAM::SpectralPeakArrayInterpolator::SpectralPeakArrayInterpolator

(

const PeaksInterpConfig &

c = Config()

)

Definition at line 45 of file SpectralPeakArrayInterpolator.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralPeakArrayInterpolator::~SpectralPeakArrayInterpolator

(

)

[inline]

Definition at line 69 of file SpectralPeakArrayInterpolator.hxx.

---

Member Function Documentation

void CLAM::SpectralPeakArrayInterpolator::AttachSpectralShape

(

Spectrum &

spec

)

[inline]

Definition at line 97 of file SpectralPeakArrayInterpolator.hxx.

References mpSpectralShape.

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

Definition at line 206 of file SpectralPeakArrayInterpolator.cxx.

References CLAM_DEBUG_ASSERT, CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::Spectrum::GetMag(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::Processing::IsRunning(), mFreqInterpolationFactorCtl, mIsHarmonicCtl, mPitch1Ctl, mPitch2Ctl, mPitchInterpolationFactorCtl, CLAM::SpectralPeakArray::SetnPeaks(), CLAM::SpectralPeakArray::TodB(), and CLAM::SpectralPeakArray::ToLinear().

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

Definition at line 74 of file SpectralPeakArrayInterpolator.cxx.

References CLAM_DEBUG_ASSERT, CLAM::SpectralPeakArray::GetIndex(), CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::SpectralPeakArray::GetPositionFromIndex(), CLAM::Processing::IsRunning(), mFreqInterpolationFactorCtl, mIsHarmonicCtl, mMagInterpolationFactorCtl, mPitch1Ctl, mPitch2Ctl, mPitchInterpolationFactorCtl, CLAM::SpectralPeakArray::SetnPeaks(), CLAM::SpectralPeakArray::TodB(), and CLAM::SpectralPeakArray::ToLinear().

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 314 of file SpectralPeakArrayInterpolator.cxx.

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

Referenced by CLAM::FrameInterpolator::Do().

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

---

Member Data Documentation

FloatInControl CLAM::SpectralPeakArrayInterpolator::mFreqInterpolationFactorCtl

Definition at line 80 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

InPort<SpectralPeakArray> CLAM::SpectralPeakArrayInterpolator::mIn1

Ports.

Definition at line 92 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

InPort<SpectralPeakArray> CLAM::SpectralPeakArrayInterpolator::mIn2

Definition at line 93 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

FloatInControl CLAM::SpectralPeakArrayInterpolator::mIsHarmonicCtl

Input control for whether harmonic interpolation has to be performed.

Definition at line 89 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

FloatInControl CLAM::SpectralPeakArrayInterpolator::mMagInterpolationFactorCtl

Input control for interpolation factor.

Definition at line 79 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

OutPort<SpectralPeakArray> CLAM::SpectralPeakArrayInterpolator::mOut

Definition at line 94 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

FloatInControl CLAM::SpectralPeakArrayInterpolator::mPitch1Ctl

Input controls for input pitch needed for harmonic interpolation.

Definition at line 85 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

FloatInControl CLAM::SpectralPeakArrayInterpolator::mPitch2Ctl

Definition at line 86 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

FloatInControl CLAM::SpectralPeakArrayInterpolator::mPitchInterpolationFactorCtl

Definition at line 81 of file SpectralPeakArrayInterpolator.hxx.

Referenced by Do().

Spectrum* CLAM::SpectralPeakArrayInterpolator::mpSpectralShape

Definition at line 96 of file SpectralPeakArrayInterpolator.hxx.

Referenced by AttachSpectralShape(), and Do().

---

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

• SpectralPeakArrayInterpolator.hxx
• SpectralPeakArrayInterpolator.cxx