Marsyas  0.5.0-beta1
Public Member Functions
Peak2Rms Class Reference

Peak to Rms ratio across samples. More...

#include <Peak2Rms.h>

Inherits MarSystem.

Public Member Functions

MarSystemclone () const
void myProcess (realvec &in, realvec &out)
 Processes data.
void myUpdate (MarControlPtr sender)
 Updates internal state due to a control change.
 Peak2Rms (std::string name)
 Peak2Rms (const Peak2Rms &a)
 ~Peak2Rms ()

Detailed Description

Peak to Rms ratio across samples.

Author:
Adam Tindale

Computes the Peak to Rms ratio for a mono channel. For multiple streams of data a separate instance is needed using a fanout.

Definition at line 37 of file Peak2Rms.h.


Constructor & Destructor Documentation

Peak2Rms ( std::string  name)

Definition at line 24 of file Peak2Rms.cpp.

Peak2Rms ( const Peak2Rms a)

Definition at line 28 of file Peak2Rms.cpp.

~Peak2Rms ( )

Definition at line 32 of file Peak2Rms.cpp.


Member Function Documentation

MarSystem * clone ( ) const [virtual]

Implements MarSystem.

Definition at line 37 of file Peak2Rms.cpp.

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

Processes data.

Parameters:
inInput data to read.
outOutput data to write.

Implement this method in subclass to define specific data processing.

Implements MarSystem.

Definition at line 52 of file Peak2Rms.cpp.

void myUpdate ( MarControlPtr  sender) [virtual]

Updates internal state due to a control change.

Parameters:
senderThe control that triggered the update; more precisely, any control passed to the update() method - could be an invalid one.

Implement this method in subclass to define specific response to control changes.

Reimplemented from MarSystem.

Definition at line 43 of file Peak2Rms.cpp.


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