CLAM-Development
1.4.0
|
This calss performs the substraction of two Spectrum processing data objects. More...
#include <SpectrumSubstracter2.hxx>
Public Member Functions | |
SpectrumSubstracter2 () | |
SpectrumSubstracter2 (const SpecSubstracter2Config &c) | |
~SpectrumSubstracter2 () | |
const ProcessingConfig & | GetConfig () 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 |
![]() | |
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 | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
![]() | |
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 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:
Definition at line 60 of file SpectrumSubstracter2.hxx.
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().
|
inline |
Definition at line 119 of file SpectrumSubstracter2.hxx.
|
virtual |
Supervised mode execution method (using ports)
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().
Definition at line 81 of file SpectrumSubstracter2.cxx.
References CLAM_ASSERT, CLAM_DEBUG_ASSERT, and CLAM::Processing::IsRunning().
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::Processing.
Definition at line 121 of file SpectrumSubstracter2.hxx.
|
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.