CLAM::AudioWindowing Class Reference

#include <AudioWindowing.hxx>

Inheritance diagram for CLAM::AudioWindowing:

CLAM::ProcessingComposite CLAM::Processing

List of all members.


Detailed Description

Processing class for performing a STFT.

Its main functionality is to obtain a spectrum out of an incoming audio signal, applying windowing, circular shift and zero padding. Its different

Definition at line 42 of file AudioWindowing.hxx.


Public Types

typedef AudioWindowingConfig Config

Public Member Functions

const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
 AudioWindowing (const Config &config=Config())
 ~AudioWindowing ()
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution method (using ports).
bool Do (const Audio &in, Audio &out)

Member Typedef Documentation

Reimplemented from CLAM::Processing.

Definition at line 46 of file AudioWindowing.hxx.


Constructor & Destructor Documentation

CLAM::AudioWindowing::AudioWindowing ( const Config config = Config()  )  [inline]

Definition at line 51 of file AudioWindowing.hxx.

References CLAM::Processing::Configure().

CLAM::AudioWindowing::~AudioWindowing (  ) 

Definition at line 42 of file AudioWindowing.cxx.


Member Function Documentation

const char* CLAM::AudioWindowing::GetClassName (  )  const [inline, virtual]

Override it in every subclass and retur the name of that class.

Reimplemented from CLAM::ProcessingComposite.

Definition at line 49 of file AudioWindowing.hxx.

const ProcessingConfig& CLAM::AudioWindowing::GetConfig (  )  const [inline, virtual]

Configuration getter.

Gets the configuration parameters used to create the object.

Returns:
Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.

Implements CLAM::ProcessingComposite.

Definition at line 60 of file AudioWindowing.hxx.

bool CLAM::AudioWindowing::Do ( void   )  [virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::ProcessingComposite.

Definition at line 128 of file AudioWindowing.cxx.

References CLAM::InPort< Token >::Consume(), and CLAM::AudioInPort::GetAudio().

bool CLAM::AudioWindowing::Do ( const Audio in,
Audio out 
)


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

Generated on Tue Aug 12 22:33:48 2008 for CLAM by  doxygen 1.5.5