CLAM-Development  1.4.0
Public Member Functions
CLAM::AudioDescriptors Class Reference

#include <AudioDescriptors.hxx>

List of all members.

Public Member Functions

 DYNAMIC_TYPE_USING_INTERFACE (AudioDescriptors, 8, DescriptorAbs)
 DYN_ATTRIBUTE (0, public, TData, Mean)
 The mean value of the absolute value of the audio samples amplitude.
 DYN_ATTRIBUTE (1, public, TData, Variance)
 The variance of audio samples amplitude.
 DYN_ATTRIBUTE (2, public, TData, TemporalCentroid)
 The temporal centroid is time where signal energy is "concentrated".
 DYN_ATTRIBUTE (3, public, TData, LogAttackTime)
 The log-attack time is the (base 10) logarithm of the rise time.
 DYN_ATTRIBUTE (4, public, TData, Energy)
 The squared sum of audio samples amplitudes.
 DYN_ATTRIBUTE (5, public, TData, ZeroCrossingRate)
 The zero-crossing rate is a measure of the number of time the signal value cross the zero axe, averaged over the whole signal.
 DYN_ATTRIBUTE (6, public, TData, RiseTime)
 The rise time is the time duration between the signal reached 2% of it maximum value to the time it reaches 80% of its maximum value.
 DYN_ATTRIBUTE (7, public, TData, Decrease)
 The temporal decrease is a measure of the amount of decrease in the signal energy.
 AudioDescriptors (Audio *pAudio)
 AudioDescriptors (TData initVal)
const AudioGetpAudio () const
void SetpAudio (Audio *pAudio)
void ConcreteCompute ()
- Public Member Functions inherited from CLAM::DescriptorTmpl< abs >
 DescriptorTmpl (int n)
 DescriptorTmpl (const DescriptorTmpl< abs > &prototype, bool shareData=false, bool deep=true)
virtual ~DescriptorTmpl ()
virtual void Compute ()
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 ComponentGetAttributeAsComponent (unsigned i) const
ComponentGetAttributeAsComponent (unsigned i)
void FullfilsInvariant () const
virtual ComponentDeepCopy () 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 ()

Additional Inherited Members

- Protected Member Functions inherited from CLAM::DescriptorTmpl< abs >
void InitStats (DataArray *pData)
- Protected Attributes inherited from CLAM::DescriptorTmpl< abs >
StatsTmpl< abs > * mpStats

Detailed Description

Definition at line 38 of file AudioDescriptors.hxx.


Constructor & Destructor Documentation

CLAM::AudioDescriptors::AudioDescriptors ( Audio pAudio)

Definition at line 34 of file AudioDescriptors.cxx.

CLAM::AudioDescriptors::AudioDescriptors ( TData  initVal)

Definition at line 40 of file AudioDescriptors.cxx.

References CLAM::DynamicType::UpdateData().


Member Function Documentation

void CLAM::AudioDescriptors::ConcreteCompute ( )
virtual
CLAM::AudioDescriptors::DYN_ATTRIBUTE ( ,
public  ,
TData  ,
Mean   
)

The mean value of the absolute value of the audio samples amplitude.

The result is in signal units.

See also:
Stats::GetMean
CLAM::AudioDescriptors::DYN_ATTRIBUTE ( ,
public  ,
TData  ,
Variance   
)

The variance of audio samples amplitude.

The result is in signal difference squared units.

See also:
Stats::GetVariance
CLAM::AudioDescriptors::DYN_ATTRIBUTE ( ,
public  ,
TData  ,
TemporalCentroid   
)

The temporal centroid is time where signal energy is "concentrated".

For a "silence" signal the centroid will be placed in the middle of the signal. It is computed by computing the statistical centroid over the absolute value of the signal. Measured in seconds.

See also:
Stats::GetCentroid
CLAM::AudioDescriptors::DYN_ATTRIBUTE ( ,
public  ,
TData  ,
LogAttackTime   
)

The log-attack time is the (base 10) logarithm of the rise time.

For a silent signal, log-attack time is -5. Measured in log10(seconds).

CLAM::AudioDescriptors::DYN_ATTRIBUTE ( ,
public  ,
TData  ,
Energy   
)

The squared sum of audio samples amplitudes.

This measure is not limited to the range [0,1]. Measured in squared signal units.

See also:
Stats::GetEnergy
CLAM::AudioDescriptors::DYN_ATTRIBUTE ( ,
public  ,
TData  ,
ZeroCrossingRate   
)

The zero-crossing rate is a measure of the number of time the signal value cross the zero axe, averaged over the whole signal.

Measured in crossings/second.

CLAM::AudioDescriptors::DYN_ATTRIBUTE ( ,
public  ,
TData  ,
RiseTime   
)

The rise time is the time duration between the signal reached 2% of it maximum value to the time it reaches 80% of its maximum value.

For a silent signal, rise time is 0. Measured in seconds.

CLAM::AudioDescriptors::DYN_ATTRIBUTE ( ,
public  ,
TData  ,
Decrease   
)

The temporal decrease is a measure of the amount of decrease in the signal energy.

Measured in dB per seconds??

CLAM::AudioDescriptors::DYNAMIC_TYPE_USING_INTERFACE ( AudioDescriptors  ,
,
DescriptorAbs   
)
const Audio * CLAM::AudioDescriptors::GetpAudio ( ) const

Definition at line 64 of file AudioDescriptors.cxx.

void CLAM::AudioDescriptors::SetpAudio ( Audio pAudio)

Definition at line 70 of file AudioDescriptors.cxx.

References CLAM::DescriptorTmpl< abs >::InitStats().


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