PowerToAverageRatio Class Reference
[Analysis]

PowerToAverageRatio (or Power-to-Average Ratio) of a window. More...

#include <PowerToAverageRatio.h>

Inherits Marsyas::MarSystem.


Public Member Functions

MarSystemclone () const
 Implementation of the MarSystem::clone() method.
void myProcess (realvec &in, realvec &out)
 Implementation of the MarSystem::myProcess method.
 PowerToAverageRatio (const PowerToAverageRatio &a)
 PowerToAverageRatio copy constructor.
 PowerToAverageRatio (std::string name)
 PowerToAverageRatio constructor.
 ~PowerToAverageRatio ()
 PowerToAverageRatio destructor.

Private Member Functions

void addControls ()
 Add specific controls needed by this MarSystem.
void myUpdate (MarControlPtr sender)
 Reads changed controls and sets up variables if necessary.


Detailed Description

PowerToAverageRatio (or Power-to-Average Ratio) of a window.

This calculates the PAR for a complete window of samples; it is similar to SCF (Spectral Crest Factor), however SCF calculates the PAR in various frequency bands of observations.

Definition at line 37 of file PowerToAverageRatio.h.


Constructor & Destructor Documentation

PowerToAverageRatio ( std::string  name  ) 

PowerToAverageRatio constructor.

Add any specific controls needed by this MarSystem.

Definition at line 25 of file PowerToAverageRatio.cpp.

References PowerToAverageRatio::addControls().

Referenced by PowerToAverageRatio::clone().


Member Function Documentation

void addControls (  )  [private]

Add specific controls needed by this MarSystem.

Add any specific controls needed by this MarSystem.

Reimplemented from MarSystem.

Definition at line 47 of file PowerToAverageRatio.cpp.

Referenced by PowerToAverageRatio::PowerToAverageRatio().

void myProcess ( realvec in,
realvec out 
) [virtual]

Implementation of the MarSystem::myProcess method.

Iterate over the observations and samples and do the processing.

Implements MarSystem.

Definition at line 70 of file PowerToAverageRatio.cpp.

void myUpdate ( MarControlPtr  sender  )  [private, virtual]

Reads changed controls and sets up variables if necessary.

Use the default MarSystem setup with equal input/output stream format.

Reimplemented from MarSystem.

Definition at line 54 of file PowerToAverageRatio.cpp.

References Marsyas::obsNamesAddPrefix().


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

Generated on Wed May 23 00:02:23 2012 for Marsyas by  doxygen 1.5.6