CLAM::SpectralPeakArrayInterpolator Class Reference
#include <SpectralPeakArrayInterpolator.hxx>
Detailed Description
This class performs the interpolation of two SpectralPeakArray processing data objects.Definition at line 54 of file SpectralPeakArrayInterpolator.hxx.
Public Member Functions | |
| SpectralPeakArrayInterpolator () | |
| SpectralPeakArrayInterpolator (const PeaksInterpConfig &c) | |
| ~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 | |
| 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< SpectralPeakArray > | mIn1 |
| Ports. | |
| InPort< SpectralPeakArray > | mIn2 |
| OutPort< SpectralPeakArray > | mOut |
| Spectrum * | mpSpectralShape |
Constructor & Destructor Documentation
| CLAM::SpectralPeakArrayInterpolator::SpectralPeakArrayInterpolator | ( | ) |
Definition at line 45 of file SpectralPeakArrayInterpolator.cxx.
References CLAM::Processing::Configure().
| CLAM::SpectralPeakArrayInterpolator::SpectralPeakArrayInterpolator | ( | const PeaksInterpConfig & | c | ) |
Definition at line 60 of file SpectralPeakArrayInterpolator.cxx.
References CLAM::Processing::Configure().
| CLAM::SpectralPeakArrayInterpolator::~SpectralPeakArrayInterpolator | ( | ) | [inline] |
Definition at line 73 of file SpectralPeakArrayInterpolator.hxx.
Member Function Documentation
| 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 75 of file SpectralPeakArrayInterpolator.hxx.
| 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 mIn1, mIn2, mOut, and mpSpectralShape.
Referenced by CLAM::SMSMorph::Do(), and CLAM::FrameInterpolator::Do().
| bool CLAM::SpectralPeakArrayInterpolator::Do | ( | const SpectralPeakArray & | in1, | |
| const SpectralPeakArray & | in2, | |||
| SpectralPeakArray & | out | |||
| ) |
Definition at line 89 of file SpectralPeakArrayInterpolator.cxx.
References CLAM_DEBUG_ASSERT, CLAM::SpectralPeakArray::GetIndex(), 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 | ( | const SpectralPeakArray & | in1, | |
| const SpectralPeakArray & | in2, | |||
| const Spectrum & | spectralShape, | |||
| SpectralPeakArray & | out | |||
| ) |
Definition at line 221 of file SpectralPeakArrayInterpolator.cxx.
References CLAM_DEBUG_ASSERT, CLAM::Spectrum::GetMag(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::Processing::IsRunning(), mFreqInterpolationFactorCtl, mIsHarmonicCtl, mPitch1Ctl, mPitch2Ctl, mPitchInterpolationFactorCtl, CLAM::SpectralPeakArray::SetnPeaks(), CLAM::SpectralPeakArray::TodB(), and CLAM::SpectralPeakArray::ToLinear().
| void CLAM::SpectralPeakArrayInterpolator::AttachSpectralShape | ( | Spectrum & | spec | ) | [inline] |
Member Data Documentation
| SpectralPeakArrayInterpolatorCtl CLAM::SpectralPeakArrayInterpolator::mMagInterpolationFactorCtl |
Input control for interpolation factor.
Definition at line 83 of file SpectralPeakArrayInterpolator.hxx.
Referenced by Do().
| SpectralPeakArrayInterpolatorCtl CLAM::SpectralPeakArrayInterpolator::mFreqInterpolationFactorCtl |
| SpectralPeakArrayInterpolatorCtl CLAM::SpectralPeakArrayInterpolator::mPitchInterpolationFactorCtl |
| SpectralPeakArrayInterpolatorCtl CLAM::SpectralPeakArrayInterpolator::mPitch1Ctl |
Input controls for input pitch needed for harmonic interpolation.
Definition at line 89 of file SpectralPeakArrayInterpolator.hxx.
Referenced by Do().
| SpectralPeakArrayInterpolatorCtl CLAM::SpectralPeakArrayInterpolator::mPitch2Ctl |
| SpectralPeakArrayInterpolatorCtl CLAM::SpectralPeakArrayInterpolator::mIsHarmonicCtl |
Input control for whether harmonic interpolation has to be performed.
Definition at line 93 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:
