CLAM::SinTrackingConfig Class Reference

Config class for the SinTracking Processing. More...

#include <SinTrackingConfig.hxx>

List of all members.

Public Member Functions

 SinTrackingConfig ()
 SinTrackingConfig (const SinTrackingConfig &prototype, const bool shareData=false, const bool deep=true)
 __COMMON_DYNAMIC_TYPE (SinTrackingConfig, 3)
 __COMMON_DYN_ATTRIBUTE (0, public, TData, Threshold) protected
 Frequency deviation in percentage allowed for a peak to be continued (default: 20).
bool LoadThreshold (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (1, public, TSize, nMaxSines) protected
 Maximum number of sines which can be tracked at once (default: 50).
bool LoadnMaxSines (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (2, public, bool, IsHarmonic) protected
 Determines if an algorithm specialized for inharmonic input is used or one specialized harmonic input is used.
bool LoadIsHarmonic (CLAM::Storage &s)
void DefaultInit ()
 The concrete dynamic type constructor calls DefaultInit().
void DefaultValues ()

Detailed Description

Config class for the SinTracking Processing.

Definition at line 33 of file SinTrackingConfig.hxx.

Constructor & Destructor Documentation

CLAM::SinTrackingConfig::SinTrackingConfig (  )  [inline]

Definition at line 36 of file SinTrackingConfig.hxx.

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

Definition at line 36 of file SinTrackingConfig.hxx.

Member Function Documentation

CLAM::SinTrackingConfig::__COMMON_DYN_ATTRIBUTE ( 2  ,
public  ,
bool  ,
IsHarmonic   
) [inline]

Determines if an algorithm specialized for inharmonic input is used or one specialized harmonic input is used.

Default: false.

Definition at line 45 of file SinTrackingConfig.hxx.

CLAM::SinTrackingConfig::__COMMON_DYN_ATTRIBUTE ( 1  ,
public  ,
TSize  ,
nMaxSines   
) [inline]

Maximum number of sines which can be tracked at once (default: 50).

Definition at line 40 of file SinTrackingConfig.hxx.

CLAM::SinTrackingConfig::__COMMON_DYN_ATTRIBUTE ( 0  ,
public  ,
TData  ,
Threshold   
) [inline]

Frequency deviation in percentage allowed for a peak to be continued (default: 20).

Definition at line 38 of file SinTrackingConfig.hxx.

CLAM::SinTrackingConfig::__COMMON_DYNAMIC_TYPE ( SinTrackingConfig  ,
3   
)
void CLAM::SinTrackingConfig::DefaultInit ( void   ) 

The concrete dynamic type constructor calls DefaultInit().

This allows user to initialize his/her object. But we define DefaultInit() here because we don't want to force writting one DefaultInit() function for each concrete dynamic type. If a dynamic type concrete class defines some (not-default) constructors, this should also call the DefaultInit().

See also:
CopyInit()

Reimplemented from CLAM::DynamicType.

Definition at line 26 of file SinTrackingConfig.cxx.

References DefaultValues(), and CLAM::DynamicType::UpdateData().

void CLAM::SinTrackingConfig::DefaultValues (  ) 

Definition at line 35 of file SinTrackingConfig.cxx.

Referenced by DefaultInit().

bool CLAM::SinTrackingConfig::LoadIsHarmonic ( CLAM::Storage &  s  )  [inline]

Definition at line 45 of file SinTrackingConfig.hxx.

bool CLAM::SinTrackingConfig::LoadnMaxSines ( CLAM::Storage &  s  )  [inline]

Definition at line 40 of file SinTrackingConfig.hxx.

bool CLAM::SinTrackingConfig::LoadThreshold ( CLAM::Storage &  s  )  [inline]

Definition at line 38 of file SinTrackingConfig.hxx.

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