CLAM-Development  1.4.0
Public Member Functions | Public Attributes
CLAM::SpectrumProduct Class Reference

This class performs the product of two Spectrum processing data objects. More...

#include <SpectrumProduct.hxx>

List of all members.

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
- 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 ProcessingConfigGetConfig () 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)
InPortBaseGetInPort (const std::string &name)
OutPortBaseGetOutPort (const std::string &name)
InControlBaseGetInControl (const std::string &name)
OutControlBaseGetOutControl (const std::string &name)
InPortBaseGetInPort (unsigned index)
OutPortBaseGetOutPort (unsigned index)
InControlBaseGetInControl (unsigned index)
OutControlBaseGetOutControl (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< SpectrummInput1
InPort< SpectrummInput2
OutPort< SpectrummOutput

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.
InControlRegistryGetInControls ()
 Accessor to published Controls manager.
OutControlRegistryGetOutControls ()
 Accessor to published Controls manager.
InPortRegistryGetInPorts ()
 Accessor to published Ports manager.
OutPortRegistryGetOutPorts ()
 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
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Detailed Description

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:

Todo:
Possible optimisations (which require more states):

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.


Constructor & Destructor Documentation

CLAM::SpectrumProduct::SpectrumProduct ( const Config c = Config())

Definition at line 41 of file SpectrumProduct.cxx.

References CLAM::Processing::Configure().

CLAM::SpectrumProduct::~SpectrumProduct ( )
virtual

Definition at line 51 of file SpectrumProduct.cxx.


Member Function Documentation

bool CLAM::SpectrumProduct::Do ( )
virtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

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().

bool CLAM::SpectrumProduct::Do ( Spectrum in1,
Spectrum in2,
Spectrum out 
)

Definition at line 55 of file SpectrumProduct.cxx.

References CLAM_ASSERT, CLAM_DEBUG_ASSERT, and CLAM::Processing::IsRunning().

bool CLAM::SpectrumProduct::MayDisableExecution ( ) const
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.


Member Data Documentation

InPort<Spectrum> CLAM::SpectrumProduct::mInput1

Definition at line 110 of file SpectrumProduct.hxx.

Referenced by Do().

InPort<Spectrum> CLAM::SpectrumProduct::mInput2

Definition at line 111 of file SpectrumProduct.hxx.

Referenced by Do().

OutPort<Spectrum> CLAM::SpectrumProduct::mOutput

Definition at line 112 of file SpectrumProduct.hxx.

Referenced by Do().


The documentation for this class was generated from the following files: