CLAM-Development
1.4.0
|
This class performs the product of two Spectrum processing data objects. More...
#include <SpectrumProduct.hxx>
Public Member Functions | |
SpectrumProduct (const Config &c=Config()) | |
virtual | ~SpectrumProduct () |
bool | Do () |
Supervised mode execution method (using ports) | |
bool | Do (Spectrum &in1, Spectrum &in2, Spectrum &out) |
bool | SetPrototypes (const Spectrum &in1, const Spectrum &in2, const Spectrum &out) |
Change the internal type state. | |
bool | SetPrototypes () |
bool | UnsetPrototypes () |
bool | MayDisableExecution () const |
![]() | |
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< Spectrum > | mInput1 |
InPort< Spectrum > | mInput2 |
OutPort< Spectrum > | mOutput |
Additional Inherited Members | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
![]() | |
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) |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
This class performs the product of two Spectrum processing data objects.
Its primary use will be to allow frecuency domain filtering, by taking the frecuency response as one of its inputs. (It implements the funcionality provided in the old CCLAMApplyFDFilter class).
It Allows any possible attribute configuration in its inputs and in its output, but it performs faster when prototype configuration of the data is specified using SetPrototypes(...), in certain situations:
The BPFxBPF product is being thought. If both BPFs have the same range and point possition, the way to go is obvious, but in other situations it is not so simple. Whe should probably merge both BPFs, into a new BPF.
Definition at line 69 of file SpectrumProduct.hxx.
Definition at line 41 of file SpectrumProduct.cxx.
References CLAM::Processing::Configure().
|
virtual |
Definition at line 51 of file SpectrumProduct.cxx.
|
virtual |
Supervised mode execution method (using ports)
Implements CLAM::Processing.
Definition at line 103 of file SpectrumProduct.cxx.
References CLAM_DEBUG_ASSERT, CLAM::InPort< Token >::Consume(), CLAM::InPort< Token >::GetData(), CLAM::OutPort< Token >::GetData(), CLAM::Spectrum::GetSize(), mInput1, mInput2, mOutput, CLAM::OutPort< Token >::Produce(), and CLAM::Spectrum::SetSize().
Definition at line 55 of file SpectrumProduct.cxx.
References CLAM_ASSERT, CLAM_DEBUG_ASSERT, and CLAM::Processing::IsRunning().
|
inline |
Definition at line 136 of file SpectrumProduct.hxx.
bool CLAM::SpectrumProduct::SetPrototypes | ( | const Spectrum & | in1, |
const Spectrum & | in2, | ||
const Spectrum & | out | ||
) |
Change the internal type state.
Apart from prototype configuration, the Size, Scale and SpectralRange attributes of each Spectrum are also checked.
Definition at line 124 of file SpectrumProduct.cxx.
References CLAM::SpecTypeFlags::bComplex, CLAM::SpecTypeFlags::bMagPhase, CLAM::SpecTypeFlags::bMagPhaseBPF, CLAM::SpecTypeFlags::bPolar, CLAM_ASSERT, CLAM::EScale::eLinear, CLAM::EScale::eLog, CLAM::Spectrum::GetConfig(), CLAM::Spectrum::GetSize(), and CLAM::Spectrum::GetType().
bool CLAM::SpectrumProduct::SetPrototypes | ( | ) |
Definition at line 310 of file SpectrumProduct.cxx.
References CLAM_ASSERT.
bool CLAM::SpectrumProduct::UnsetPrototypes | ( | ) |
Definition at line 316 of file SpectrumProduct.cxx.
Definition at line 110 of file SpectrumProduct.hxx.
Referenced by Do().
Definition at line 111 of file SpectrumProduct.hxx.
Referenced by Do().
Definition at line 112 of file SpectrumProduct.hxx.
Referenced by Do().