CLAM::FundFreqDetect Class Reference

This class estimates a fundamental frequency value in the spectral domain for one single spectral Frame. More...

#include <FundFreqDetect.hxx>

List of all members.

Public Member Functions

 FundFreqDetect ()
 FundFreqDetect (const FundFreqDetectConfig &c)
 ~FundFreqDetect ()
const ProcessingConfig & GetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution method (using ports).
bool Do (SpectralPeakArray &input, Fundamental &fund)
 Do function.

Detailed Description

This class estimates a fundamental frequency value in the spectral domain for one single spectral Frame.

The input is a set of spectral peaks stored in the class CLAM::SpectralPeakArray The number of candidates is given by the CLAM::Fundamental object using the attribute nMaxCandidate. This implementation is based in the Two-Way Mismatch algorithm proposed by Maher and Beauchamp (JASA vol 95. pp. 2254-2263 1993).

Author:
emilia.gomez@iua.upf.es
See also:
Fundamental SpectralPeakArray

Definition at line 53 of file FundFreqDetect.hxx.

Constructor & Destructor Documentation

CLAM::FundFreqDetect::FundFreqDetect (  ) 

Definition at line 33 of file FundFreqDetect.cxx.

References CLAM::Processing::Configure().

CLAM::FundFreqDetect::FundFreqDetect ( const FundFreqDetectConfig &  c  ) 

Definition at line 41 of file FundFreqDetect.cxx.

References CLAM::Processing::Configure().

CLAM::FundFreqDetect::~FundFreqDetect (  ) 

Definition at line 49 of file FundFreqDetect.cxx.

Member Function Documentation

bool CLAM::FundFreqDetect::Do ( SpectralPeakArray &  input,
Fundamental &  fund 
)

Do function.

Definition at line 109 of file FundFreqDetect.cxx.

References CLAM::Fundamental::AddElem(), CLAM_ASSERT, CLAM::CLAM_max(), CLAM::CLAM_min(), CLAM::SpectralPeakArray::DeleteIndex(), CLAM::Fundamental::GetFreq(), CLAM::SpectralPeakArray::GetMag(), CLAM::SpectralPeakArray::GetMaxMagIndex(), CLAM::SpectralPeakArray::GetMaxMagPos(), CLAM::Fundamental::GetnCandidates(), CLAM::Fundamental::GetnMaxCandidates(), CLAM::SpectralPeakArray::GetnMaxPeaks(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::Fundamental::Init(), CLAM::SpectralPeakArray::ResetIndices(), CLAM::OutControl< ControlDataType >::SendControl(), CLAM::Fundamental::SetnCandidates(), CLAM::Fundamental::SetnMaxCandidates(), CLAM::SpectralPeakArray::SetnMaxPeaks(), CLAM::Array< T >::Size(), CLAM::Fundamental::SortByError(), and CLAM::DynamicType::UpdateData().

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

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 97 of file FundFreqDetect.cxx.

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

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

const ProcessingConfig & CLAM::FundFreqDetect::GetConfig (  )  const [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 FundFreqDetect.cxx.

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