CLAM::FundFreqDetectConfig Class Reference

Config class for FundFreqDetect Processing. More...

#include <FundFreqDetectConfig.hxx>

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]`