CLAM::SpectralPeak Class Reference

Class SpectralPeak is a basic spectral domain Processing Data class. More...

#include <SpectralPeak.hxx>

List of all members.

Public Member Functions

 SpectralPeak ()
 SpectralPeak (const SpectralPeak &prototype, const bool shareData=false, const bool deep=true)
 __COMMON_DYNAMIC_TYPE (SpectralPeak, 6)
 __COMMON_DYN_ATTRIBUTE (0, public, EScale, Scale) protected
bool LoadScale (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (1, public, TData, Freq) protected
bool LoadFreq (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (2, public, TData, Mag) protected
bool LoadMag (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (3, public, TData, BinPos) protected
bool LoadBinPos (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (4, public, TData, Phase) protected
bool LoadPhase (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (5, public, int, BinWidth) protected
bool LoadBinWidth (CLAM::Storage &s)
TData operator| (const SpectralPeak &a) const
 Operator for computing distance between spectral peaks only taking into account their frequency.

Protected Member Functions

void DefaultInit ()
 Configuration constructor.

Friends

SpectralPeak operator* (const SpectralPeak &peak, int factor)
 Operator for multiplying a spectral peak by a given factor, just influences its magnitude TODO: does not take into account if the scale is logarithmic or not, should it?

Detailed Description

Class SpectralPeak is a basic spectral domain Processing Data class.

Contains frequency, magnitude, phase, bin position and bin width of a given spectral peak. An array of Spectral Peaks is created by means of the SpectralPeakArray class

See also:
ProcessingData
SpectralPeakArray
Author:
Xavier Amatriain

Definition at line 62 of file SpectralPeak.hxx.


Constructor & Destructor Documentation

CLAM::SpectralPeak::SpectralPeak (  )  [inline]

Definition at line 65 of file SpectralPeak.hxx.

CLAM::SpectralPeak::SpectralPeak ( const SpectralPeak prototype,
const bool  shareData = false,
const bool  deep = true 
) [inline]

Definition at line 65 of file SpectralPeak.hxx.


Member Function Documentation

CLAM::SpectralPeak::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
int  ,
BinWidth   
) [inline]

Definition at line 71 of file SpectralPeak.hxx.

CLAM::SpectralPeak::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
Phase   
) [inline]

Definition at line 70 of file SpectralPeak.hxx.

CLAM::SpectralPeak::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
BinPos   
) [inline]

Definition at line 69 of file SpectralPeak.hxx.

CLAM::SpectralPeak::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
Mag   
) [inline]

Definition at line 68 of file SpectralPeak.hxx.

CLAM::SpectralPeak::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
Freq   
) [inline]

Definition at line 67 of file SpectralPeak.hxx.

CLAM::SpectralPeak::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
EScale  ,
Scale   
) [inline]

Definition at line 66 of file SpectralPeak.hxx.

CLAM::SpectralPeak::__COMMON_DYNAMIC_TYPE ( SpectralPeak  ,
 
)
void CLAM::SpectralPeak::DefaultInit ( void   )  [protected]

Configuration constructor.

Reimplemented from CLAM::DynamicType.

Definition at line 36 of file SpectralPeak.cxx.

References CLAM::EScale::eLinear, and CLAM::DynamicType::UpdateData().

bool CLAM::SpectralPeak::LoadBinPos ( CLAM::Storage s  )  [inline]

Definition at line 69 of file SpectralPeak.hxx.

bool CLAM::SpectralPeak::LoadBinWidth ( CLAM::Storage s  )  [inline]

Definition at line 71 of file SpectralPeak.hxx.

bool CLAM::SpectralPeak::LoadFreq ( CLAM::Storage s  )  [inline]

Definition at line 67 of file SpectralPeak.hxx.

bool CLAM::SpectralPeak::LoadMag ( CLAM::Storage s  )  [inline]

Definition at line 68 of file SpectralPeak.hxx.

bool CLAM::SpectralPeak::LoadPhase ( CLAM::Storage s  )  [inline]

Definition at line 70 of file SpectralPeak.hxx.

bool CLAM::SpectralPeak::LoadScale ( CLAM::Storage s  )  [inline]

Definition at line 66 of file SpectralPeak.hxx.

TData CLAM::SpectralPeak::operator| ( const SpectralPeak a  )  const [inline]

Operator for computing distance between spectral peaks only taking into account their frequency.

Returns:
the frequency distance in Hz (TData)

Definition at line 86 of file SpectralPeak.hxx.

References CLAM::Abs().


Friends And Related Function Documentation

SpectralPeak operator* ( const SpectralPeak peak,
int  factor 
) [friend]

Operator for multiplying a spectral peak by a given factor, just influences its magnitude TODO: does not take into account if the scale is logarithmic or not, should it?

Parameters:
peak A reference to the peak
factor the multiplying factor

Definition at line 97 of file SpectralPeak.hxx.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3