CLAM::FundFreqDetectConfig Class Reference

Config class for FundFreqDetect Processing. More...

#include <FundFreqDetectConfig.hxx>

List of all members.

Public Member Functions

 FundFreqDetectConfig ()
 FundFreqDetectConfig (const FundFreqDetectConfig &prototype, const bool shareData=false, const bool deep=true)
 __COMMON_DYNAMIC_TYPE (FundFreqDetectConfig, 17)
 __COMMON_DYN_ATTRIBUTE (0, public, TData, ReferenceFundFreq) protected
bool LoadReferenceFundFreq (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (1, public, TData, LowestFundFreq) protected
 Lowest frequency allowed for the fundamental.
bool LoadLowestFundFreq (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (2, public, TData, HighestFundFreq) protected
 Highest frequency allowed for the fundamental.
bool LoadHighestFundFreq (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (3, public, TData, MaxCandMagDiff) protected
 Maximum magnitude difference allowed between candidates (default: 30dB).
bool LoadMaxCandMagDiff (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (4, public, TData, MaxFundFreqError) protected
 Maximun allowed Two-Way Mismatch (TWM) error (default: 10).
bool LoadMaxFundFreqError (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (5, public, TData, PMp) protected
 Parameter to weight candidates (Harmonic Error Constants).
bool LoadPMp (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (6, public, TData, PMq) protected
 Parameter to weight candidates (Harmonic Error Constants).
bool LoadPMq (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (7, public, TData, PMr) protected
 Parameter to weight candidates (Harmonic Error Constants).
bool LoadPMr (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (8, public, TData, MPp) protected
 Parameter to weight candidates (Harmonic Error Constants).
bool LoadMPp (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (9, public, TData, MPq) protected
 Parameter to weight candidates (Harmonic Error Constants).
bool LoadMPq (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (10, public, TData, MPr) protected
 Parameter to weight candidates (Harmonic Error Constants).
bool LoadMPr (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (11, public, TSize, PMnPeaks) protected
 Harmonic peaks to weight error (default: 10).
bool LoadPMnPeaks (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (12, public, TSize, MPnPeaks) protected
 Harmonic peaks to weight error (default: 10).
bool LoadMPnPeaks (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (13, public, TData, PMCont) protected
 Harmonic error contributions (default: 1).
bool LoadPMCont (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (14, public, TData, MPCont) protected
 Harmonic error contributions (default: 1).
bool LoadMPCont (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (15, public, TSize, NInt) protected
 Number of integer frequency ratios considered as candidates (default: 5).
bool LoadNInt (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (16, public, TSize, NMaxCandidates) protected
 Maximum number of candidates.
bool LoadNMaxCandidates (CLAM::Storage &s)
void DefaultInit ()
 The concrete dynamic type constructor calls DefaultInit().
void DefaultValues ()

Detailed Description

Config class for FundFreqDetect Processing.

Definition at line 35 of file FundFreqDetectConfig.hxx.


Constructor & Destructor Documentation

CLAM::FundFreqDetectConfig::FundFreqDetectConfig (  )  [inline]

Definition at line 38 of file FundFreqDetectConfig.hxx.

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

Definition at line 38 of file FundFreqDetectConfig.hxx.


Member Function Documentation

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( 16  ,
public  ,
TSize  ,
NMaxCandidates   
) [inline]

Maximum number of candidates.

Definition at line 76 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( 15  ,
public  ,
TSize  ,
NInt   
) [inline]

Number of integer frequency ratios considered as candidates (default: 5).

Definition at line 74 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( 14  ,
public  ,
TData  ,
MPCont   
) [inline]

Harmonic error contributions (default: 1).

Definition at line 72 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( 13  ,
public  ,
TData  ,
PMCont   
) [inline]

Harmonic error contributions (default: 1).

Definition at line 70 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( 12  ,
public  ,
TSize  ,
MPnPeaks   
) [inline]

Harmonic peaks to weight error (default: 10).

Definition at line 68 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( 11  ,
public  ,
TSize  ,
PMnPeaks   
) [inline]

Harmonic peaks to weight error (default: 10).

Definition at line 66 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( 10  ,
public  ,
TData  ,
MPr   
) [inline]

Parameter to weight candidates (Harmonic Error Constants).

Default: 0.5.

Definition at line 64 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
MPq   
) [inline]

Parameter to weight candidates (Harmonic Error Constants).

Default: 1.4.

Definition at line 62 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
MPp   
) [inline]

Parameter to weight candidates (Harmonic Error Constants).

Default: 0.5. Note, if the CLAM_OPTIMIZE is active this parameter is not configurable and is always taken to be the default 0.5

Definition at line 60 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
PMr   
) [inline]

Parameter to weight candidates (Harmonic Error Constants).

Default: 0.5.

Definition at line 56 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
PMq   
) [inline]

Parameter to weight candidates (Harmonic Error Constants).

Default: 1.4.

Definition at line 54 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
PMp   
) [inline]

Parameter to weight candidates (Harmonic Error Constants).

Default: 0.5. Note, if the CLAM_OPTIMIZE is active this parameter is not configurable and is always taken to be the default 0.5

Definition at line 52 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
MaxFundFreqError   
) [inline]

Maximun allowed Two-Way Mismatch (TWM) error (default: 10).

Definition at line 48 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
MaxCandMagDiff   
) [inline]

Maximum magnitude difference allowed between candidates (default: 30dB).

Definition at line 46 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
HighestFundFreq   
) [inline]

Highest frequency allowed for the fundamental.

Definition at line 44 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
LowestFundFreq   
) [inline]

Lowest frequency allowed for the fundamental.

Definition at line 42 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
ReferenceFundFreq   
) [inline]

Definition at line 40 of file FundFreqDetectConfig.hxx.

CLAM::FundFreqDetectConfig::__COMMON_DYNAMIC_TYPE ( FundFreqDetectConfig  ,
17   
)
void CLAM::FundFreqDetectConfig::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 28 of file FundFreqDetectConfig.cxx.

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

void CLAM::FundFreqDetectConfig::DefaultValues (  ) 

Definition at line 37 of file FundFreqDetectConfig.cxx.

Referenced by DefaultInit().

bool CLAM::FundFreqDetectConfig::LoadHighestFundFreq ( CLAM::Storage s  )  [inline]

Definition at line 44 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadLowestFundFreq ( CLAM::Storage s  )  [inline]

Definition at line 42 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadMaxCandMagDiff ( CLAM::Storage s  )  [inline]

Definition at line 46 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadMaxFundFreqError ( CLAM::Storage s  )  [inline]

Definition at line 48 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadMPCont ( CLAM::Storage s  )  [inline]

Definition at line 72 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadMPnPeaks ( CLAM::Storage s  )  [inline]

Definition at line 68 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadMPp ( CLAM::Storage s  )  [inline]

Definition at line 60 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadMPq ( CLAM::Storage s  )  [inline]

Definition at line 62 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadMPr ( CLAM::Storage s  )  [inline]

Definition at line 64 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadNInt ( CLAM::Storage s  )  [inline]

Definition at line 74 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadNMaxCandidates ( CLAM::Storage s  )  [inline]

Definition at line 76 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadPMCont ( CLAM::Storage s  )  [inline]

Definition at line 70 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadPMnPeaks ( CLAM::Storage s  )  [inline]

Definition at line 66 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadPMp ( CLAM::Storage s  )  [inline]

Definition at line 52 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadPMq ( CLAM::Storage s  )  [inline]

Definition at line 54 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadPMr ( CLAM::Storage s  )  [inline]

Definition at line 56 of file FundFreqDetectConfig.hxx.

bool CLAM::FundFreqDetectConfig::LoadReferenceFundFreq ( CLAM::Storage s  )  [inline]

Definition at line 40 of file FundFreqDetectConfig.hxx.


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