This class performs the interpolation of two SpectralPeakArray processing data objects. More...
#include <SpectralPeakArrayAdder.hxx>
Public Member Functions | |
| SpectralPeakArrayAdder (const Config &c=Config()) | |
| ~SpectralPeakArrayAdder () | |
| bool | Do () |
| Supervised mode execution method (using ports) | |
| bool | Do (const SpectralPeakArray &in1, const SpectralPeakArray &in2, SpectralPeakArray &out) |
 Public Member Functions inherited from CLAM::Processing | |
| 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. | |
| virtual const ProcessingConfig & | GetConfig () const |
| Configuration getter. | |
| 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. | |
Public Attributes | |
| InPort< SpectralPeakArray > | mIn1 |
| Ports. | |
| InPort< SpectralPeakArray > | mIn2 |
| OutPort< SpectralPeakArray > | mOut |
Additional Inherited Members | |
| Public Types inherited from CLAM::Processing | |
| enum | ExecState { Unconfigured = 0, Ready, Running } |
| Processing Object possible execution states. More... | |
| typedef NullProcessingConfig | Config |
| Protected Member Functions inherited from CLAM::Processing | |
| virtual bool | ConcreteConfigure (const ProcessingConfig &) |
| Configuration method interface. | |
| virtual bool | ConcreteStart () |
| Processing objects have to redefine this method when starting them implies some internal changes. | |
| virtual bool | ConcreteStop () |
| Processing objects have to redefine this method when stoping them implies some internal changes. | |
| unsigned | BackendBufferSize () |
| Given by the NetworkPlayer (backend) if exists. | |
| unsigned | BackendSampleRate () |
| Given by the NetworkPlayer (backend) if exists. | |
| InControlRegistry & | GetInControls () |
| Accessor to published Controls manager. | |
| OutControlRegistry & | GetOutControls () |
| Accessor to published Controls manager. | |
| InPortRegistry & | GetInPorts () |
| Accessor to published Ports manager. | |
| OutPortRegistry & | GetOutPorts () |
| Accessor to published Portss manager. | |
| bool | AddConfigErrorMessage (const std::string &msg) |
| Use this method to append a configuration errors to the processing when implementing ConcreteConfigure. | |
| bool | AbleToExecute (void) const |
| In debug-mode checks that the processing is configured and started. | |
| template<typename ConcreteConfig > | |
| void | CopyAsConcreteConfig (ConcreteConfig &concrete, const ProcessingConfig &abstract) const |
| Helper template to convert a reference to a ProcessingConfig to the concrete ProcessingConfig specified on the first parameter. | |
| void | SetExecState (ExecState state) |
| Protected Attributes inherited from CLAM::Processing | |
| ProcessingComposite * | mpParent |
| Pointer to the parent (composite) processing object, or 0. | |
| Network * | _network |
| The parent network if any. | |
Detailed Description
This class performs the interpolation of two SpectralPeakArray processing data objects.
Definition at line 48 of file SpectralPeakArrayAdder.hxx.
Constructor & Destructor Documentation
Definition at line 31 of file SpectralPeakArrayAdder.cxx.
References CLAM::Processing::Configure().
|
inline |
Definition at line 54 of file SpectralPeakArrayAdder.hxx.
Member Function Documentation
|
inlinevirtual |
Supervised mode execution method (using ports)
- Returns:
- A boolean telling whether it has been output
Implements CLAM::Processing.
Definition at line 56 of file SpectralPeakArrayAdder.hxx.
Referenced by CLAM::FrameAdder::Do().
| bool CLAM::SpectralPeakArrayAdder::Do | ( | const SpectralPeakArray & | in1, |
| const SpectralPeakArray & | in2, | ||
| SpectralPeakArray & | out | ||
| ) |
This loop may be a little more efficient by ussing the buffers directly. But it would surely become muc less readable and much longer. TODO?
Definition at line 41 of file SpectralPeakArrayAdder.cxx.
References CLAM::SpectralPeakArray::AddSpectralPeak(), CLAM_ASSERT, CLAM_DEBUG_ASSERT, CLAM::SpectralPeakArray::GetFreq(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::SpectralPeakArray::GetSpectralPeak(), CLAM::Processing::IsRunning(), CLAM::SpectralPeakArray::SetnPeaks(), and CLAM::DynamicType::UpdateData().
Member Data Documentation
| InPort<SpectralPeakArray> CLAM::SpectralPeakArrayAdder::mIn1 |
Ports.
Definition at line 61 of file SpectralPeakArrayAdder.hxx.
| InPort<SpectralPeakArray> CLAM::SpectralPeakArrayAdder::mIn2 |
Definition at line 62 of file SpectralPeakArrayAdder.hxx.
| OutPort<SpectralPeakArray> CLAM::SpectralPeakArrayAdder::mOut |
Definition at line 63 of file SpectralPeakArrayAdder.hxx.
The documentation for this class was generated from the following files:
