CLAM-Development: CLAM::FDCombFilter Class Reference

CLAM-Development 1.3

Basic Frequency domain Comb Filter. More...

#include <FDCombFilter.hxx>

List of all members.

Public Member Functions
const char *	GetClassName () const
	This method returns the name of the object.
	FDCombFilter (const Config &c=Config())
	Constructor with an object of FDCombFilterConfig class by parameter.
	~FDCombFilter ()
	Destructor of the class.
bool	Do ()
	Supervised Do() function, not implemented yet.
bool	Do (const Spectrum &input, Spectrum &output)
	Unsupervised Do function, applies an spectral envelope to incoming spectrum.
Public Attributes
FloatInControl	mFreq

Detailed Description

Basic Frequency domain Comb Filter.

It has one control (mFreq) which sets the fundamental of harmonic series that wants to be amplified.

: add a gain control to be able to filter out harmonic series instead of amplifying it.

: don't know why it does not work correctly with spectrums that have less than 512 bins !!

Definition at line 39 of file FDCombFilter.hxx.

Constructor & Destructor Documentation

CLAM::FDCombFilter::FDCombFilter ( const Config & c = Config() )

Constructor with an object of FDCombFilterConfig class by parameter.

Parameters:

c	FDCombFilterConfig object created by the user

Definition at line 32 of file FDCombFilter.cxx.

References CLAM::Processing::Configure(), CLAM::InControl< ControlDataType >::DoControl(), and mFreq.

CLAM::FDCombFilter::~FDCombFilter ( )

Destructor of the class.

Definition at line 39 of file FDCombFilter.cxx.

Member Function Documentation

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

Supervised Do() function, not implemented yet.

Implements CLAM::Processing.

Definition at line 45 of file FDCombFilter.cxx.

References CLAM_ASSERT, and CLASS.

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

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

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

Parameters:

input	The Spectrum we want to filter
output	The filtered spectrum

Returns:: Boolean value, true if all has been executed correctly.

Definition at line 53 of file FDCombFilter.cxx.

References CLAM_atan2(), CLAM_cos(), CLAM_sin(), CLAM_sqrt(), CLAM::EScale::eLinear, CLAM::EScale::eLog, CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::Spectrum::GetSize(), mFreq, CLAM::Spectrum::SetSize(), CLAM::Spectrum::ToDB(), CLAM::Spectrum::ToLinear(), and TWO_PI.

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

This method returns the name of the object.

Returns:: Char pointer with the name of object

Implements CLAM::Processing.

Definition at line 45 of file FDCombFilter.hxx.

Member Data Documentation

FloatInControl CLAM::FDCombFilter::mFreq

Definition at line 65 of file FDCombFilter.hxx.

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

The documentation for this class was generated from the following files: