CLAM-Development  1.4.0
Public Member Functions
CLAM::SpectrumSubstracter2 Class Reference

This calss performs the substraction of two Spectrum processing data objects. More...

#include <SpectrumSubstracter2.hxx>

List of all members.

Public Member Functions

 SpectrumSubstracter2 ()
 SpectrumSubstracter2 (const SpecSubstracter2Config &c)
 ~SpectrumSubstracter2 ()
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 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.
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.

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 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 calss performs the substraction of two Spectrum processing data objects.

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:
See also:
SpectrumSubstracter2

Definition at line 60 of file SpectrumSubstracter2.hxx.


Constructor & Destructor Documentation

CLAM::SpectrumSubstracter2::SpectrumSubstracter2 ( )

Definition at line 43 of file SpectrumSubstracter2.cxx.

References CLAM::Processing::Configure().

CLAM::SpectrumSubstracter2::SpectrumSubstracter2 ( const SpecSubstracter2Config c)

Definition at line 53 of file SpectrumSubstracter2.cxx.

References CLAM::Processing::Configure().

CLAM::SpectrumSubstracter2::~SpectrumSubstracter2 ( )
inline

Definition at line 119 of file SpectrumSubstracter2.hxx.


Member Function Documentation

bool CLAM::SpectrumSubstracter2::Do ( void  )
virtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 129 of file SpectrumSubstracter2.cxx.

References CLAM::InPort< Token >::Consume(), CLAM::InPort< Token >::GetData(), CLAM::OutPort< Token >::GetData(), CLAM::Spectrum::GetSize(), CLAM::OutPort< Token >::Produce(), and CLAM::Spectrum::SetSize().

Referenced by CLAM::SMSAnalysisCore::Do().

bool CLAM::SpectrumSubstracter2::Do ( Spectrum in1,
Spectrum in2,
Spectrum out 
)
const ProcessingConfig& CLAM::SpectrumSubstracter2::GetConfig ( ) const
inlinevirtual

Configuration getter.

Gets the configuration parameters used to create the object.

Returns:
Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.

Reimplemented from CLAM::Processing.

Definition at line 121 of file SpectrumSubstracter2.hxx.

bool CLAM::SpectrumSubstracter2::MayDisableExecution ( ) const
inline

Definition at line 141 of file SpectrumSubstracter2.hxx.

bool CLAM::SpectrumSubstracter2::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 144 of file SpectrumSubstracter2.cxx.

References CLAM::SpecTypeFlags::bComplex, CLAM::SpecTypeFlags::bMagPhase, CLAM::SpecTypeFlags::bMagPhaseBPF, CLAM::SpecTypeFlags::bPolar, CLAM_ASSERT, CLAM::EScale::eLinear, CLAM::EScale::eLog, CLAM::Spectrum::GetSize(), and CLAM::Spectrum::GetType().

bool CLAM::SpectrumSubstracter2::SetPrototypes ( )

Definition at line 325 of file SpectrumSubstracter2.cxx.

References CLAM_ASSERT.

bool CLAM::SpectrumSubstracter2::UnsetPrototypes ( )

Definition at line 332 of file SpectrumSubstracter2.cxx.


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