CLAM::OscillatingSpectralNotch Class Reference
#include <OscillatingSpectralNotch.hxx>
Detailed Description
Definition at line 37 of file OscillatingSpectralNotch.hxx.
Public Member Functions | |
| const char * | GetClassName () const |
| Override it in every subclass and retur the name of that class. | |
| OscillatingSpectralNotch () | |
| ~OscillatingSpectralNotch () | |
| bool | ConcreteConfigure (const ProcessingConfig &config) |
| Configuration method interface. | |
| bool | Do (const Frame &in, Frame &out) |
| bool | Do (const Spectrum &in, Spectrum &out) |
| bool | Do () |
| Supervised mode execution method (using ports). | |
Constructor & Destructor Documentation
| CLAM::OscillatingSpectralNotch::OscillatingSpectralNotch | ( | ) | [inline] |
Definition at line 54 of file OscillatingSpectralNotch.hxx.
References CLAM::Processing::Configure().
| CLAM::OscillatingSpectralNotch::~OscillatingSpectralNotch | ( | ) | [inline] |
Definition at line 67 of file OscillatingSpectralNotch.hxx.
Member Function Documentation
| const char* CLAM::OscillatingSpectralNotch::GetClassName | ( | ) | const [inline, virtual] |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 49 of file OscillatingSpectralNotch.hxx.
| bool CLAM::OscillatingSpectralNotch::ConcreteConfigure | ( | const ProcessingConfig & | ) | [inline, virtual] |
Configuration method interface.
The Processing base class forces all the concrete classes derived from it to implement this method, which must actually perform the specific configuration tasks.
Note that the user can not call this method directly. He will use Configure instead. The argument is expected to be an object of the necesary concrete configuration class.
- Parameters:
-
Reference to the configuration object.
- Returns:
- false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)
- Exceptions:
-
This method must throw a bad_cast exception if the argument is not an object of the expected configuration class.
Reimplemented from CLAM::Processing.
Definition at line 68 of file OscillatingSpectralNotch.hxx.
References CLAM::InControl::DoControl(), and CLAM::InControl::SetBounds().
Implements CLAM::FrameTransformation.
Definition at line 92 of file OscillatingSpectralNotch.hxx.
References Do().
Definition at line 38 of file OscillatingSpectralNotch.cxx.
References CLAM::SimpleOscillator::Do(), CLAM::InControl::GetLastValue(), CLAM::Spectrum::GetSize(), log2lin(), Round(), and CLAM::SendFloatToInControl().
| bool CLAM::OscillatingSpectralNotch::Do | ( | ) | [inline, virtual] |
Supervised mode execution method (using ports).
- Returns:
- A boolean telling whether it has been output
Implements CLAM::Processing.
Definition at line 100 of file OscillatingSpectralNotch.hxx.
Referenced by Do().
The documentation for this class was generated from the following files:
