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

#include <SpectralPeak.hxx>

Public Member Functions
	DYNAMIC_TYPE_USING_INTERFACE (SpectralPeak, 6, ProcessingData)
	DYN_ATTRIBUTE (0, public, EScale, Scale)
	DYN_ATTRIBUTE (1, public, TData, Freq)
	DYN_ATTRIBUTE (2, public, TData, Mag)
	DYN_ATTRIBUTE (3, public, TData, BinPos)
	DYN_ATTRIBUTE (4, public, TData, Phase)
	DYN_ATTRIBUTE (5, public, int, BinWidth)
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.

Member Function Documentation

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

CLAM::SpectralPeak::DYN_ATTRIBUTE	(	0	,
		public	,
		EScale	,
		Scale
	)

CLAM::SpectralPeak::DYN_ATTRIBUTE	(	1	,
		public	,
		TData	,
		Freq
	)

CLAM::SpectralPeak::DYN_ATTRIBUTE	(	2	,
		public	,
		TData	,
		Mag
	)

CLAM::SpectralPeak::DYN_ATTRIBUTE	(	3	,
		public	,
		TData	,
		BinPos
	)

CLAM::SpectralPeak::DYN_ATTRIBUTE	(	4	,
		public	,
		TData	,
		Phase
	)

CLAM::SpectralPeak::DYN_ATTRIBUTE	(	5	,
		public	,
		int	,
		BinWidth
	)

CLAM::SpectralPeak::DYNAMIC_TYPE_USING_INTERFACE	(	SpectralPeak	,
		6	,
		ProcessingData
	)

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:

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Function Documentation

Friends And Related Function Documentation