CLAM::FDCombFilter Class Reference
#include <FDCombFilter.hxx>
Detailed Description
Basid Frequency domain Comb Filter.It has one control (mFreq) which sets the fundamental of harmonic series that wants to be amplified.
- Todo:
- : add a gain control to be able to filter out harmonic series instead of amplifying it.
- Todo:
- : don't know why it does not work correctly with spectrums that have less than 512 bins !!
Definition at line 48 of file FDCombFilter.hxx.
Public Member Functions | |
| FDCombFilter () | |
| Base constructor of class. | |
| FDCombFilter (const FDCombFilterConfig &c) | |
| Constructor with an object of FDCombFilterConfig class by parameter. | |
| ~FDCombFilter () | |
| Destructor of the class. | |
| const ProcessingConfig & | GetConfig () const |
| This method allows to obtain the FDCombFilterConfig object of the class. | |
| bool | Do (void) |
| Supervised Do() function, not implemented yet. | |
| bool | Do (const Spectrum &input, Spectrum &output) |
| Unsupervised Do function, applies an spectral envelope to incoming spectrum. | |
| bool | SetPrototypes (const Spectrum &input, Spectrum &output) |
| Change the internal type state. | |
| bool | SetPrototypes () |
| bool | UnsetPrototypes () |
| bool | MayDisableExecution () const |
Public Attributes | |
| InControlTmpl< FDCombFilter > | mFreq |
Constructor & Destructor Documentation
| CLAM::FDCombFilter::FDCombFilter | ( | ) |
Base constructor of class.
Calls Configure method with a FDCombFilterConfig initialised by default
Definition at line 32 of file FDCombFilter.cxx.
References CLAM::Processing::Configure(), and mFreq.
| CLAM::FDCombFilter::FDCombFilter | ( | const FDCombFilterConfig & | c = FDCombFilterConfig() |
) |
Constructor with an object of FDCombFilterConfig class by parameter.
- Parameters:
-
c FDCombFilterConfig object created by the user
Definition at line 38 of file FDCombFilter.cxx.
References CLAM::Processing::Configure(), and mFreq.
| CLAM::FDCombFilter::~FDCombFilter | ( | ) |
Member Function Documentation
| const ProcessingConfig& CLAM::FDCombFilter::GetConfig | ( | ) | const [inline, virtual] |
This method allows to obtain the FDCombFilterConfig object of the class.
- Returns:
- The configuration of the class
Reimplemented from CLAM::Processing.
Definition at line 77 of file FDCombFilter.hxx.
| bool CLAM::FDCombFilter::Do | ( | void | ) | [virtual] |
Supervised Do() function, not implemented yet.
Implements CLAM::Processing.
Definition at line 76 of file FDCombFilter.cxx.
References CLAM_ASSERT, and CLASS.
Referenced by CLAM::SMSPitchShift::Do().
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 84 of file FDCombFilter.cxx.
References CLAM_atan2(), CLAM_cos(), CLAM_sin(), CLAM_sqrt(), CLAM::EScale::eLinear, CLAM::EScale::eLog, CLAM::Spectrum::GetSize(), mFreq, CLAM::Spectrum::SetSize(), CLAM::Spectrum::ToDB(), CLAM::Spectrum::ToLinear(), and TWO_PI.
| bool CLAM::FDCombFilter::SetPrototypes | ( | ) |
Definition at line 64 of file FDCombFilter.cxx.
| bool CLAM::FDCombFilter::UnsetPrototypes | ( | ) |
Definition at line 69 of file FDCombFilter.cxx.
| bool CLAM::FDCombFilter::MayDisableExecution | ( | ) | const [inline] |
Definition at line 99 of file FDCombFilter.hxx.
Member Data Documentation
Definition at line 101 of file FDCombFilter.hxx.
Referenced by CLAM::SMSPitchShift::Do(), Do(), and FDCombFilter().
The documentation for this class was generated from the following files:
