CLAM::SpectralEnvelopeApply Class Reference

Applies an existing spectral envelope to incoming spectral peaks or spectrum. More...

#include <SpectralEnvelopeApply.hxx>

List of all members.

Public Member Functions

 SpectralEnvelopeApply ()
 Base constructor of class.
 SpectralEnvelopeApply (const SpectralEnvelopeApplyConfig &c)
 Constructor with an object of SpectralEnvelopeApplyConfig class by parameter.
 ~SpectralEnvelopeApply ()
 Destructor of the class.
const ProcessingConfig & GetConfig () const
 This method allows to obtain the SpectralEnvelopeApplyConfig object of the class.
bool Do (void)
 Supervised Do() function, not implemented yet.
bool Do (const SpectralPeakArray &input, const Spectrum &spectralEnvelope, SpectralPeakArray &output)
 Unsupervised Do function, applies an spectral envelope to incoming Spectral Peaks.
bool Do (const Spectrum &input, const Spectrum &spectralEnvelope, Spectrum &output)
 Unsupervised Do function, applies an spectral envelope to incoming spectrum.
bool SetPrototypes (const SpectralPeakArray &input, Spectrum &output)
 Change the internal type state.
bool SetPrototypes ()
bool UnsetPrototypes ()
bool MayDisableExecution () const

Detailed Description

Applies an existing spectral envelope to incoming spectral peaks or spectrum.

Todo:
: the spline interpolation gets a bit out of hand in the ends of the spectral envelope so you may get artifacts in the higher frequencies!!!

Definition at line 48 of file SpectralEnvelopeApply.hxx.

Constructor & Destructor Documentation

CLAM::SpectralEnvelopeApply::SpectralEnvelopeApply (  ) 

Base constructor of class.

Calls Configure method with a SpectralEnvelopeApplyConfig initialised by default

Definition at line 31 of file SpectralEnvelopeApply.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralEnvelopeApply::SpectralEnvelopeApply ( const SpectralEnvelopeApplyConfig &  c = SpectralEnvelopeApplyConfig()  ) 

Constructor with an object of SpectralEnvelopeApplyConfig class by parameter.

Parameters:
c SpectralEnvelopeApplyConfig object created by the user

Definition at line 36 of file SpectralEnvelopeApply.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralEnvelopeApply::~SpectralEnvelopeApply (  ) 

Destructor of the class.

Definition at line 41 of file SpectralEnvelopeApply.cxx.

Member Function Documentation

bool CLAM::SpectralEnvelopeApply::Do ( const Spectrum &  input,
const Spectrum &  spectralEnvelope,
Spectrum &  output 
)

Unsupervised Do function, applies an spectral envelope to incoming spectrum.

Parameters:
input The Spectrum we want to apply the spectral Envelope to
spectralEnvelope The Spectrum that holds the spectral Envelope
out An Spectrum object with the new SpectralEnvelope applied
Returns:
Boolean value, true if all has been executed correctly.

Definition at line 113 of file SpectralEnvelopeApply.cxx.

References CLAM_ASSERT, CLAM::Spectrum::GetSize(), and CLAM::BPFTmpl< TX, TY >::GetValue().

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

Unsupervised Do function, applies an spectral envelope to incoming Spectral Peaks.

Parameters:
input The SpectralPeaks we want to apply the spectral Envelope to
spectralEnvelope The Spectrum that holds the spectral Envelope
out An SpectralPeakArray object with the new SpectralEnvelope applied
Returns:
Boolean value, true if all has been executed correctly.

Definition at line 80 of file SpectralEnvelopeApply.cxx.

References CLAM_ASSERT, CLAM::SpectralPeakArray::GetnMaxPeaks(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::BPFTmpl< TX, TY >::GetValue(), CLAM::SpectralPeakArray::SetnMaxPeaks(), and CLAM::SpectralPeakArray::SetnPeaks().

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

Supervised Do() function, not implemented yet.

Implements CLAM::Processing.

Definition at line 73 of file SpectralEnvelopeApply.cxx.

References CLAM_ASSERT, and CLASS.

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

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

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

Returns:
The configuration of the class

Reimplemented from CLAM::Processing.

Definition at line 77 of file SpectralEnvelopeApply.hxx.

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

Definition at line 108 of file SpectralEnvelopeApply.hxx.

bool CLAM::SpectralEnvelopeApply::SetPrototypes (  ) 

Definition at line 61 of file SpectralEnvelopeApply.cxx.

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

Change the internal type state.

Definition at line 56 of file SpectralEnvelopeApply.cxx.

bool CLAM::SpectralEnvelopeApply::UnsetPrototypes (  ) 

Definition at line 66 of file SpectralEnvelopeApply.cxx.

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