CLAM::FundFreqDetectConfig Class Reference

Config class for FundFreqDetect Processing. More...

#include <FundFreqDetectConfig.hxx>

List of all members.

Public Member Functions
	DYNAMIC_TYPE_USING_INTERFACE (FundFreqDetectConfig, 17, ProcessingConfig)
	DYN_ATTRIBUTE (0, public, TData, ReferenceFundFreq)
	DYN_ATTRIBUTE (1, public, TData, LowestFundFreq)
	Lowest frequency allowed for the fundamental.
	DYN_ATTRIBUTE (2, public, TData, HighestFundFreq)
	Highest frequency allowed for the fundamental.
	DYN_ATTRIBUTE (3, public, TData, MaxCandMagDiff)
	Maximum magnitude difference allowed between candidates (default: 30dB).
	DYN_ATTRIBUTE (4, public, TData, MaxFundFreqError)
	Maximun allowed Two-Way Mismatch (TWM) error (default: 10).
	DYN_ATTRIBUTE (5, public, TData, PMp)
	Parameter to weight candidates (Harmonic Error Constants).
	DYN_ATTRIBUTE (6, public, TData, PMq)
	Parameter to weight candidates (Harmonic Error Constants).
	DYN_ATTRIBUTE (7, public, TData, PMr)
	Parameter to weight candidates (Harmonic Error Constants).
	DYN_ATTRIBUTE (8, public, TData, MPp)
	Parameter to weight candidates (Harmonic Error Constants).
	DYN_ATTRIBUTE (9, public, TData, MPq)
	Parameter to weight candidates (Harmonic Error Constants).
	DYN_ATTRIBUTE (10, public, TData, MPr)
	Parameter to weight candidates (Harmonic Error Constants).
	DYN_ATTRIBUTE (11, public, TSize, PMnPeaks)
	Harmonic peaks to weight error (default: 10).
	DYN_ATTRIBUTE (12, public, TSize, MPnPeaks)
	Harmonic peaks to weight error (default: 10).
	DYN_ATTRIBUTE (13, public, TData, PMCont)
	Harmonic error contributions (default: 1).
	DYN_ATTRIBUTE (14, public, TData, MPCont)
	Harmonic error contributions (default: 1).
	DYN_ATTRIBUTE (15, public, TSize, NInt)
	Number of integer frequency ratios considered as candidates (default: 5).
	DYN_ATTRIBUTE (16, public, TSize, NMaxCandidates)
	Maximum number of candidates.
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.

---

Member Function Documentation

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().

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	0	,
		public	,
		TData	,
		ReferenceFundFreq
	)

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	1	,
		public	,
		TData	,
		LowestFundFreq
	)

Lowest frequency allowed for the fundamental.

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	2	,
		public	,
		TData	,
		HighestFundFreq
	)

Highest frequency allowed for the fundamental.

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	3	,
		public	,
		TData	,
		MaxCandMagDiff
	)

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

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	4	,
		public	,
		TData	,
		MaxFundFreqError
	)

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

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	5	,
		public	,
		TData	,
		PMp
	)

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

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	6	,
		public	,
		TData	,
		PMq
	)

Parameter to weight candidates (Harmonic Error Constants).

Default: 1.4.

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	7	,
		public	,
		TData	,
		PMr
	)

Parameter to weight candidates (Harmonic Error Constants).

Default: 0.5.

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	8	,
		public	,
		TData	,
		MPp
	)

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

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	9	,
		public	,
		TData	,
		MPq
	)

Parameter to weight candidates (Harmonic Error Constants).

Default: 1.4.

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	10	,
		public	,
		TData	,
		MPr
	)

Parameter to weight candidates (Harmonic Error Constants).

Default: 0.5.

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	11	,
		public	,
		TSize	,
		PMnPeaks
	)

Harmonic peaks to weight error (default: 10).

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	12	,
		public	,
		TSize	,
		MPnPeaks
	)

Harmonic peaks to weight error (default: 10).

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	13	,
		public	,
		TData	,
		PMCont
	)

Harmonic error contributions (default: 1).

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	14	,
		public	,
		TData	,
		MPCont
	)

Harmonic error contributions (default: 1).

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	15	,
		public	,
		TSize	,
		NInt
	)

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

CLAM::FundFreqDetectConfig::DYN_ATTRIBUTE	(	16	,
		public	,
		TSize	,
		NMaxCandidates
	)

Maximum number of candidates.

CLAM::FundFreqDetectConfig::DYNAMIC_TYPE_USING_INTERFACE	(	FundFreqDetectConfig	,
		17	,
		ProcessingConfig
	)

---

The documentation for this class was generated from the following files:

• FundFreqDetectConfig.hxx
• FundFreqDetectConfig.cxx