CLAM-Development
1.4.0
|
#include <SMSSineFilter.hxx>
Public Member Functions | |
SMSSineFilter () | |
Base constructor of class. | |
SMSSineFilter (const FrameTransformationConfig &cfg) | |
Constructor with an object of SegmentTransformationConfig class by parameter. | |
virtual bool | ConcreteConfigure (const ProcessingConfig &cfg) |
Configuration method interface. | |
const ProcessingConfig & | GetConfig () const |
Configuration getter. | |
~SMSSineFilter () | |
Destructor of the class. | |
bool | Do (const Frame &in, Frame &out) |
bool | Do (const SpectralPeakArray &in, SpectralPeakArray &out) |
bool | Do () |
Supervised mode execution method (using ports) | |
void | InitBPF () |
![]() | |
FrameTransformation () | |
virtual bool | ConcreteStart () |
Processing objects have to redefine this method when starting them implies some internal changes. | |
virtual bool | InitControls () |
Virtual function to override when needing to give different default values to the controls. | |
![]() | |
bool | Configure (const ProcessingConfig &config) |
Configuration change method. | |
void | Start (void) |
Method to turn the object into running state. | |
void | Stop (void) |
Method to put the object out of running state When in execution mode, this method must be called before any further call to Configure() methods. | |
Processing () | |
virtual | ~Processing () |
virtual bool | CanProcessInplace () |
Override this method if your processing cannot process inplace. | |
bool | CanConsumeAndProduce () |
Check that Supervised Do() can be safely called. | |
void | ConsumeAndProduce () |
Acknoledges data tokens in published ports as read/writen by calling Produce() for all registered OutPorts and Consume() to all registered InPorts. | |
std::string | GetExecStateString () const |
bool | IsConfigured () const |
bool | IsRunning () const |
void | RegisterOutPort (OutPortBase *out) |
void | RegisterInPort (InPortBase *in) |
void | RegisterOutControl (OutControlBase *out) |
void | RegisterInControl (InControlBase *in) |
void | SetParent (Processing *p) |
void | SetNetworkBackLink (Network *network) |
virtual bool | ModifiesPortsAndControlsAtConfiguration () |
This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e. | |
bool | HasInPort (const std::string &name) |
bool | HasOutPort (const std::string &name) |
bool | HasInControl (const std::string &name) |
bool | HasOutControl (const std::string &name) |
InPortBase & | GetInPort (const std::string &name) |
OutPortBase & | GetOutPort (const std::string &name) |
InControlBase & | GetInControl (const std::string &name) |
OutControlBase & | GetOutControl (const std::string &name) |
InPortBase & | GetInPort (unsigned index) |
OutPortBase & | GetOutPort (unsigned index) |
InControlBase & | GetInControl (unsigned index) |
OutControlBase & | GetOutControl (unsigned index) |
unsigned | GetNInPorts () const |
unsigned | GetNOutPorts () const |
unsigned | GetNInControls () const |
unsigned | GetNOutControls () const |
const std::string & | GetConfigErrorMessage () const |
Returns a string describing configuration errors if any. | |
virtual bool | IsSyncSource () const |
Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e. | |
virtual bool | SupportsVariableAudioSize () const |
This method reports whether the processing supports dynamic buffer-size host. |
Additional Inherited Members | |
![]() | |
FrameTransformationConfig | mConfig |
FloatInControl | mAmount |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Definition at line 68 of file SMSSineFilter.hxx.
|
inline |
Base constructor of class.
Calls Configure method with a SegmentTransformationConfig initialised by default
Definition at line 97 of file SMSSineFilter.hxx.
References CLAM::Processing::Configure(), CLAM::FrameTransformation::mConfig, and CLAM::DynamicType::UpdateData().
|
inline |
Constructor with an object of SegmentTransformationConfig class by parameter.
c | SegmentTransformationConfig object created by the user |
Definition at line 114 of file SMSSineFilter.hxx.
References CLAM::Processing::Configure().
|
inline |
Destructor of the class.
Definition at line 134 of file SMSSineFilter.hxx.
|
inlinevirtual |
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.
Reference | to the configuration object. |
true if the processing object is left in a consistent state, and can be executed.
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 124 of file SMSSineFilter.hxx.
References CLAM::Processing::CopyAsConcreteConfig(), InitBPF(), and CLAM::FrameTransformation::mConfig.
Implements CLAM::FrameTransformation.
Definition at line 137 of file SMSSineFilter.hxx.
References Do().
bool CLAM::SMSSineFilter::Do | ( | const SpectralPeakArray & | in, |
SpectralPeakArray & | out | ||
) |
Definition at line 40 of file SMSSineFilter.cxx.
References CLAM::SpectralPeakArray::GetnPeaks(), CLAM::BPFTmpl< TX, TY >::GetValueFromIndex(), and CLAM::FrameTransformation::mConfig.
|
inlinevirtual |
Supervised mode execution method (using ports)
Implements CLAM::Processing.
Definition at line 145 of file SMSSineFilter.hxx.
References CLAM::InPort< Token >::Consume(), CLAM::InPort< Token >::GetData(), CLAM::OutPort< Token >::GetData(), and CLAM::OutPort< Token >::Produce().
Referenced by Do().
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::FrameTransformation.
Definition at line 131 of file SMSSineFilter.hxx.
References CLAM::FrameTransformation::mConfig.
|
inline |
Definition at line 153 of file SMSSineFilter.hxx.
References CLAM::FrameTransformation::mConfig, CLAM::BPFTmpl< TX, TY >::Resize(), CLAM::BPFTmpl< TX, TY >::SetSize(), CLAM::BPFTmpl< TX, TY >::SetValue(), and CLAM::DynamicType::UpdateData().
Referenced by ConcreteConfigure().