CLAM::SynthSineSpectrum Class Reference

Configuration class for the SynthSineSpectrum Processing. More...

#include <SynthSineSpectrum.hxx>

List of all members.

Public Member Functions

 SynthSineSpectrum ()
 SynthSineSpectrum (SynthSineSpectrumConfig &cfg)
 ~SynthSineSpectrum ()
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
bool Do (const SpectralPeakArray &peakArray, Spectrum &residualSpectrumOut, double gain=1.0)
bool Do (void)
 Supervised mode execution method (using ports).
bool ConcreteConfigure (const ProcessingConfig &)
 Configuration method.
const ProcessingConfig & GetConfig () const
 Configuration getter.

Detailed Description

Configuration class for the SynthSineSpectrum Processing.

Processing which can synthesize a spectrum out of an array of spectral peaks. It does this by convolving the spectral peaks with the significant part of the fourier transformed Blackman-Harris92 window, it's main lobe. WARNING: the do method changes the type of the output spectrum to complex regardless its original format. This behaviour may result in inconsistencies and should be taken into account.

Definition at line 57 of file SynthSineSpectrum.hxx.

Constructor & Destructor Documentation

SynthSineSpectrum::SynthSineSpectrum (  ) 

Definition at line 35 of file SynthSineSpectrum.cxx.

References CLAM::Processing::Configure().

SynthSineSpectrum::SynthSineSpectrum ( SynthSineSpectrumConfig &  cfg  ) 

Definition at line 42 of file SynthSineSpectrum.cxx.

References CLAM::Processing::Configure().

SynthSineSpectrum::~SynthSineSpectrum (  ) 

Definition at line 66 of file SynthSineSpectrum.cxx.

Member Function Documentation

bool SynthSineSpectrum::ConcreteConfigure ( const ProcessingConfig &  c  )  [virtual]

Configuration method.

Reimplemented from CLAM::Processing.

Definition at line 50 of file SynthSineSpectrum.cxx.

References CLAM::Processing::Configure(), CLAM::Processing::CopyAsConcreteConfig(), CLAM::EWindowType::eBlackmanHarris92, CLAM::EWindowNormalize::eNone, and MAINLOBE_TABLE_SIZE.

bool SynthSineSpectrum::Do ( void   )  [virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 70 of file SynthSineSpectrum.cxx.

References CLAM::InPort< Token >::Consume(), Do(), CLAM::OutPort< Token >::GetData(), CLAM::InPort< Token >::GetData(), and CLAM::OutPort< Token >::Produce().

Referenced by Do().

bool SynthSineSpectrum::Do ( const SpectralPeakArray &  peakArray,
Spectrum &  residualSpectrumOut,
double  gain = 1.0 
)

Definition at line 84 of file SynthSineSpectrum.cxx.

References CLAM::Processing::AbleToExecute(), CLAM::SpecTypeFlags::bComplex, CLAM::SpecTypeFlags::bMagPhase, CLAM::SpecTypeFlags::bMagPhaseBPF, CLAM::SpecTypeFlags::bPolar, CLAM_DEBUG_ASSERT, CLAM::Spectrum::Configure(), CLAM::EScale::eLinear, and CLAM::Array< T >::Size().

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

const char* CLAM::SynthSineSpectrum::GetClassName (  )  const [inline, virtual]

Override it in every subclass and retur the name of that class.

Implements CLAM::Processing.

Definition at line 68 of file SynthSineSpectrum.hxx.

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

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