CLAM::SpectralEnvelopeExtract Class Reference

Configuration class for SpectralEnvelopeExtract objects. More...

#include <SpectralEnvelopeExtract.hxx>

List of all members.

Public Member Functions

 SpectralEnvelopeExtract ()
 Base constructor of class.
 SpectralEnvelopeExtract (const SpectralEnvelopeExtractConfig &c)
 Constructor with an object of SpectralEnvelopeExtractConfig class by parameter.
 ~SpectralEnvelopeExtract ()
 Destructor of the class.
const ProcessingConfig & GetConfig () const
 This method allows to obtain the SpectralEnvelopeExtractConfig object of the class.
bool Do (void)
 Supervised Do() function, not implemented yet.
bool Do (const SpectralPeakArray &input, Spectrum &output)
 Unsupervised Do function, receives an Spectrum object input, and the output of method is an SpectralPeakArray (passed by parameter).
bool SetPrototypes (const SpectralPeakArray &input, Spectrum &output)
 Change the internal type state.
bool SetPrototypes ()
bool UnsetPrototypes ()
bool MayDisableExecution () const

Detailed Description

Configuration class for SpectralEnvelopeExtract objects.

See also:
ProcessingConfig, SpectralEnvelopeExtract Processing to extract spectral envelope from an array of spectral peaks.

Definition at line 45 of file SpectralEnvelopeExtract.hxx.

Constructor & Destructor Documentation

CLAM::SpectralEnvelopeExtract::SpectralEnvelopeExtract (  ) 

Base constructor of class.

Calls Configure method with a SpectralEnvelopeExtractConfig initialised by default

Definition at line 51 of file SpectralEnvelopeExtract.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralEnvelopeExtract::SpectralEnvelopeExtract ( const SpectralEnvelopeExtractConfig &  c = SpectralEnvelopeExtractConfig()  ) 

Constructor with an object of SpectralEnvelopeExtractConfig class by parameter.

Parameters:
c SpectralEnvelopeExtractConfig object created by the user

Definition at line 56 of file SpectralEnvelopeExtract.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralEnvelopeExtract::~SpectralEnvelopeExtract (  ) 

Destructor of the class.

Definition at line 61 of file SpectralEnvelopeExtract.cxx.

Member Function Documentation

bool CLAM::SpectralEnvelopeExtract::Do ( const SpectralPeakArray &  input,
Spectrum &  output 
)

Unsupervised Do function, receives an Spectrum object input, and the output of method is an SpectralPeakArray (passed by parameter).

Parameters:
input The Spectral Peaks we want to extract the envelope from
output A Spectrum in BPF form that represents the Spectral Envelope
Returns:
Boolean value, true if all has been executed correctly.

Definition at line 103 of file SpectralEnvelopeExtract.cxx.

References CLAM_pow(), CLAM::EScale::eLog, CLAM::SpectralPeakArray::GetnPeaks(), CLAM::Array< T >::Resize(), CLAM::Spectrum::SetSize(), and CLAM::Array< T >::SetSize().

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

Supervised Do() function, not implemented yet.

Implements CLAM::Processing.

Definition at line 95 of file SpectralEnvelopeExtract.cxx.

References CLAM_ASSERT, and CLASS.

Referenced by CLAM::SMSSpectralShapeShift::Do(), and CLAM::SMSPitchShift::Do().

const ProcessingConfig& CLAM::SpectralEnvelopeExtract::GetConfig (  )  const [inline, virtual]

This method allows to obtain the SpectralEnvelopeExtractConfig object of the class.

Returns:
The configuration of the class

Reimplemented from CLAM::Processing.

Definition at line 74 of file SpectralEnvelopeExtract.hxx.

bool CLAM::SpectralEnvelopeExtract::MayDisableExecution (  )  const [inline]

Definition at line 96 of file SpectralEnvelopeExtract.hxx.

bool CLAM::SpectralEnvelopeExtract::SetPrototypes (  ) 

Definition at line 83 of file SpectralEnvelopeExtract.cxx.

bool CLAM::SpectralEnvelopeExtract::SetPrototypes ( const SpectralPeakArray &  input,
Spectrum &  output 
)

Change the internal type state.

Definition at line 78 of file SpectralEnvelopeExtract.cxx.

bool CLAM::SpectralEnvelopeExtract::UnsetPrototypes (  ) 

Definition at line 88 of file SpectralEnvelopeExtract.cxx.

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