CLAM-Development
1.4.0
|
This class is dedicated to find magnitude SpectralPeaks in a given spectral frame. More...
#include <SpectralPeakDetect.hxx>
Public Member Functions | |
SpectralPeakDetect () | |
Base constructor of class. | |
SpectralPeakDetect (const SpectralPeakDetectConfig &c) | |
Constructor with an object of SpectralPeakDetectConfig class by parameter. | |
virtual | ~SpectralPeakDetect () |
Destructor of the class. | |
const ProcessingConfig & | GetConfig () const |
This method allows to obtain the SpectralPeakDetectConfig object of the class. | |
bool | Do (void) |
Supervised Do() function. | |
bool | Do (const Spectrum &input, SpectralPeakArray &out) |
Unsupervised Do function, receives an Spectrum object input, and the output of method is an SpectralPeakArray (passed by parameter) | |
bool | SetPrototypes (Spectrum &inputs, const SpectralPeakArray &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. |
Protected Member Functions | |
const char * | GetClassName () const |
This method returns the name of the object. | |
bool | ConcreteConfigure (const ProcessingConfig &) |
Config change method. | |
![]() | |
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 | |
SpectralPeakDetectConfig | mConfig |
InPort< Spectrum > | mInput |
OutPort< SpectralPeakArray > | mOutput |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Additional Inherited Members | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
This class is dedicated to find magnitude SpectralPeaks in a given spectral frame.
The spectral frame has to be in phase/magnitudes (in dB's) format for the algorithm.
In order to get a better frequency solution, the precise SpectralPeakBinPosition is interpolated. The Magnitude at this interpolated BinPos is calculated a 3-point curve-fit, phase is interpolated linearly.
The type of the output is SpectralPeakArray
Definition at line 48 of file SpectralPeakDetect.hxx.
CLAM::SpectralPeakDetect::SpectralPeakDetect | ( | ) |
Base constructor of class.
Calls Configure method with a SpectralPeakDetectConfig initialised by default
Definition at line 33 of file SpectralPeakDetect.cxx.
References CLAM::Processing::Configure().
CLAM::SpectralPeakDetect::SpectralPeakDetect | ( | const SpectralPeakDetectConfig & | c = SpectralPeakDetectConfig() | ) |
Constructor with an object of SpectralPeakDetectConfig class by parameter.
c | SpectralPeakDetectConfig object created by the user |
Definition at line 40 of file SpectralPeakDetect.cxx.
References CLAM::Processing::Configure().
|
virtual |
Destructor of the class.
Definition at line 47 of file SpectralPeakDetect.cxx.
|
protectedvirtual |
Config change method.
The | ProcessingConfig object |
Reimplemented from CLAM::Processing.
Definition at line 53 of file SpectralPeakDetect.cxx.
References CLAM::Processing::CopyAsConcreteConfig(), and mConfig.
|
virtual |
Supervised Do() function.
Implements CLAM::Processing.
Definition at line 77 of file SpectralPeakDetect.cxx.
References CLAM::InPort< Token >::Consume(), Do(), CLAM::EScale::eLog, CLAM::InPort< Token >::GetData(), CLAM::OutPort< Token >::GetData(), mInput, mOutput, CLAM::OutPort< Token >::Produce(), and CLAM::Spectrum::ToDB().
Referenced by CLAM::SMSAnalysisCore::Do(), Do(), and CLAM::SpectralShapeShift::Do().
bool CLAM::SpectralPeakDetect::Do | ( | const Spectrum & | input, |
SpectralPeakArray & | out | ||
) |
Unsupervised Do function, receives an Spectrum object input, and the output of method is an SpectralPeakArray (passed by parameter)
input | The spectrum we want to get the SpectralPeaks |
out | An SpectralPeakArray object where will be setted the SpectralPeaks of Spectrum in. |
Definition at line 101 of file SpectralPeakDetect.cxx.
References CLAM::Array< T >::AddElem(), CLAM_ASSERT, CLAM::Spectrum::GetMag(), CLAM::SpectralPeakArray::GetnMaxPeaks(), CLAM::Spectrum::GetPhase(), CLAM::Spectrum::GetSize(), mConfig, PI, CLAM::SpectralPeakArray::SetnMaxPeaks(), CLAM::SpectralPeakArray::SetnPeaks(), and TWO_PI.
|
inlineprotectedvirtual |
This method returns the name of the object.
Implements CLAM::Processing.
Definition at line 60 of file SpectralPeakDetect.hxx.
|
inlinevirtual |
This method allows to obtain the SpectralPeakDetectConfig object of the class.
Reimplemented from CLAM::Processing.
Definition at line 84 of file SpectralPeakDetect.hxx.
References mConfig.
|
inline |
Definition at line 108 of file SpectralPeakDetect.hxx.
bool CLAM::SpectralPeakDetect::SetPrototypes | ( | Spectrum & | inputs, |
const SpectralPeakArray & | 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 62 of file SpectralPeakDetect.cxx.
bool CLAM::SpectralPeakDetect::SetPrototypes | ( | ) |
Definition at line 67 of file SpectralPeakDetect.cxx.
bool CLAM::SpectralPeakDetect::UnsetPrototypes | ( | ) |
Definition at line 72 of file SpectralPeakDetect.cxx.
|
protected |
Definition at line 51 of file SpectralPeakDetect.hxx.
Referenced by ConcreteConfigure(), Do(), and GetConfig().
Definition at line 53 of file SpectralPeakDetect.hxx.
Referenced by Do().
|
protected |
Definition at line 54 of file SpectralPeakDetect.hxx.
Referenced by Do().