class AuAmplitude

This class implements routines to get amplitude values

Public Classes

enum Mode

Mode which can be used for calcCacheAmp

Public Fields

typedef pair ValuePair

Value Pair based on the template class pair (STL)

Public Methods

static ValuePair calcCacheAmp(const AudioCache& cache, const Mode which)

Function to calculate the range of the loaded amplitudes in the audio cache and returns it depending on the parameter which

Public

enum Mode

Mode which can be used for calcCacheAmp

enum Mode

Mode which can be used for calcCacheAmp.
MAX = maximal amplitude range
MIN = minimal amplitude range
AVE = average (above and below 0) range
ABS = absolute range (from 0 to sum of max pos and max neg amplitude)
SUM = sum of all amplitudes (the integral/the energy).

typedef pair ValuePair

Value Pair based on the template class pair (STL). It is used by calcCacheAmp as return value.

static ValuePair calcCacheAmp(const AudioCache& cache, const Mode which)

Function to calculate the range of the loaded amplitudes in the audio cache and returns it depending on the parameter which. which can be: MAX/MIN/AVE/ABS/SUM, so that calcCacheAmp returns the maximal amplitude range, the minimal, the average (above and below 0), an absolute range (from 0 to sum of max pos and max neg amplitude) or the sum of all amplitudes (the integral/the energy)

Throws:

Exception , if the mode is unknown

Returns:

the range (two values: positive first) as a ValuePair

Parameters:

cache - audio cache containing the signal
which - calculation mode

This class has no child classes.

Author:

Silvia Pfeiffer, Peter Tomczyk

Version:

$Id: amplitud.h,v 1.3 1998/01/12 12:42:12 tomczyk Exp $

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de