CLAM::DescriptorTmpl< abs > Class Template Reference

Abstract class for all descriptors. More...

#include <Descriptor.hxx>

List of all members.

Public Member Functions
	DescriptorTmpl (int n)
	DescriptorTmpl (const DescriptorTmpl< abs > &prototype, bool shareData=false, bool deep=true)
virtual	~DescriptorTmpl ()
virtual void	Compute ()
virtual void	ConcreteCompute ()=0
void	SetPrototype (const DescriptorTmpl< abs > &proto)
Public Member Functions inherited from CLAM::ProcessingData
	ProcessingData (const int n)
	Constructor of an object that will contain the number of attributes passed by parameter.
	ProcessingData (const ProcessingData &prototype, bool shareData=false, bool deep=true)
	Copy constructor of a ProcessingData object.
virtual	~ProcessingData ()
Public Member Functions inherited from CLAM::DynamicType
	DynamicType (const int nAttr)
	Constructs a DynamicType object that can hold.
	DynamicType (const DynamicType &prototype, const bool shareData, const bool deepCopy)
	Copy constructor of a dynamic Type.
	DynamicType (const DynamicType &prototype)
virtual	~DynamicType ()
virtual const char *	GetClassName () const =0
	Return the class name.
void	CopyInit (const DynamicType &dt)
	This method allows custom code for the copy-constructor of a dynamic type, since the copy-constructor is macro expanded and can not be overwritted.
bool	UpdateData ()
	Method used to resize the data space of the dynamic type, necessary when some AddXXX() / RemoveXXX() (where XXX is an attribute name) has been done.
unsigned	GetNDynamicAttributes () const
const char *	GetDynamicAttributeName (unsigned i)
virtual const std::type_info &	GetTypeId (unsigned i) const =0
bool	AttributeIsComponent (unsigned i) const
bool	AttributeIsDynamictype (unsigned i) const
bool	IsAttributeInstantiated (unsigned i) const
const void *	GetAttributeAsVoidPtr (unsigned i) const
const Component *	GetAttributeAsComponent (unsigned i) const
Component *	GetAttributeAsComponent (unsigned i)
void	FullfilsInvariant () const
virtual Component *	DeepCopy () const
void	Debug () const
virtual void	StoreOn (CLAM::Storage &storage) const
	Stores component's subitems on the given Storage.
virtual void	LoadFrom (CLAM::Storage &storage)
	Loads component's subitems from the given Storage.
Public Member Functions inherited from CLAM::Component
virtual	~Component ()

Protected Member Functions
void	InitStats (DataArray *pData)

Protected Attributes
StatsTmpl< abs > *	mpStats

---

Detailed Description

template<bool abs>
class CLAM::DescriptorTmpl< abs >

Abstract class for all descriptors.

Parameters:

Whether

to calculate the descriptors over absolute values or not (signed).

Todo:

This class could abstract more common behaviour from subclasses by becoming template

Definition at line 40 of file Descriptor.hxx.

---

Constructor & Destructor Documentation

template<bool abs>

CLAM::DescriptorTmpl< abs >::DescriptorTmpl ( int  n )

inline

Definition at line 43 of file Descriptor.hxx.

References CLAM::DescriptorTmpl< abs >::mpStats.

template<bool abs>

CLAM::DescriptorTmpl< abs >::DescriptorTmpl ( const DescriptorTmpl< abs > &  prototype, bool  shareData = false, bool  deep = true  )

inline

Definition at line 44 of file Descriptor.hxx.

References CLAM::DescriptorTmpl< abs >::mpStats.

template<bool abs>

virtual CLAM::DescriptorTmpl< abs >::~DescriptorTmpl ( )

inlinevirtual

Definition at line 49 of file Descriptor.hxx.

References CLAM::DescriptorTmpl< abs >::mpStats.

---

Member Function Documentation

template<bool abs>

virtual void CLAM::DescriptorTmpl< abs >::Compute ( )

inlinevirtual

Reimplemented in CLAM::SegmentDescriptors, and CLAM::FrameDescriptors.

Definition at line 57 of file Descriptor.hxx.

References CLAM_ASSERT, CLAM::DescriptorTmpl< abs >::ConcreteCompute(), and CLAM::DescriptorTmpl< abs >::mpStats.

Referenced by CLAM::DescriptorComputation::Do().

template<bool abs>

virtual void CLAM::DescriptorTmpl< abs >::ConcreteCompute ( )

pure virtual

Implemented in CLAM::SpectralDescriptors, CLAM::SpectralPeakDescriptors, CLAM::AudioDescriptors, CLAM::SegmentDescriptors, and CLAM::FrameDescriptors.

Referenced by CLAM::DescriptorTmpl< abs >::Compute().

template<bool abs>

void CLAM::DescriptorTmpl< abs >::InitStats ( DataArray *  pData )

inlineprotected

Definition at line 73 of file Descriptor.hxx.

References CLAM::DescriptorTmpl< abs >::mpStats.

Referenced by CLAM::AudioDescriptors::SetpAudio(), CLAM::SpectralPeakDescriptors::SetpSpectralPeakArray(), and CLAM::SpectralDescriptors::SetpSpectrum().

template<bool abs>

void CLAM::DescriptorTmpl< abs >::SetPrototype ( const DescriptorTmpl< abs > &  proto )

inline

Definition at line 63 of file Descriptor.hxx.

References CLAM::DescriptorTmpl< abs >::mpStats.

---

Member Data Documentation

template<bool abs>

StatsTmpl<abs>* CLAM::DescriptorTmpl< abs >::mpStats

protected

Definition at line 79 of file Descriptor.hxx.

Referenced by CLAM::DescriptorTmpl< abs >::Compute(), CLAM::SpectralDescriptors::ComputeLowFreqEnergyRelation(), CLAM::SpectralDescriptors::ComputeRolloff(), CLAM::SpectralDescriptors::ComputeSpectralFlatness(), CLAM::AudioDescriptors::ConcreteCompute(), CLAM::SpectralPeakDescriptors::ConcreteCompute(), CLAM::SpectralDescriptors::ConcreteCompute(), CLAM::SpectralDescriptors::CopyInit(), CLAM::SpectralDescriptors::DefaultInit(), CLAM::DescriptorTmpl< abs >::DescriptorTmpl(), CLAM::DescriptorTmpl< abs >::InitStats(), CLAM::DescriptorTmpl< abs >::SetPrototype(), and CLAM::DescriptorTmpl< abs >::~DescriptorTmpl().

---

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

• Descriptor.hxx