CLAM::SpectralSynthesis Class Reference

This is the processing object class we are using to group several other processing objects. More...

#include <SpectralSynthesis.hxx>

List of all members.

Public Member Functions
	SpectralSynthesis (const SpectralSynthesisConfig &cfg)
	SpectralSynthesis ()
	~SpectralSynthesis ()
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do (void)
	Supervised mode execution.
bool	Do (Spectrum &in, Audio &out)
	Unsupervised mode execution.
bool	Do (Frame &in)
bool	Do (Segment &in)
Public Attributes
InPort< Spectrum >	mInput
	Ports.
AudioOutPort	mOutput

---

Detailed Description

This is the processing object class we are using to group several other processing objects.

Definition at line 71 of file SpectralSynthesis.hxx.

---

Constructor & Destructor Documentation

CLAM::SpectralSynthesis::SpectralSynthesis

(

const SpectralSynthesisConfig &

cfg

)

Definition at line 59 of file SpectralSynthesis.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralSynthesis::SpectralSynthesis

(

)

Definition at line 51 of file SpectralSynthesis.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralSynthesis::~SpectralSynthesis

(

)

Definition at line 67 of file SpectralSynthesis.cxx.

---

Member Function Documentation

bool CLAM::SpectralSynthesis::Do

(

Segment &

in

)

Definition at line 201 of file SpectralSynthesis.cxx.

References Do(), CLAM::Segment::GetFrame(), and CLAM::Segment::mCurrentFrameIndex.

bool CLAM::SpectralSynthesis::Do

(

Frame &

in

)

Definition at line 193 of file SpectralSynthesis.cxx.

References Do().

bool CLAM::SpectralSynthesis::Do	(	Spectrum &	in,
		Audio &	out
	)

Unsupervised mode execution.

Definition at line 173 of file SpectralSynthesis.cxx.

References CLAM::BinaryAudioOp< BinOp >::Do(), CLAM::CircularShift::Do(), CLAM::SpectralSynthesisConfig::GetAnalWindowSize(), CLAM::Audio::GetAudioChunk(), and CLAM::SpectralSynthesisConfig::GetHopSize().

bool CLAM::SpectralSynthesis::Do

(

void

)

[virtual]

Supervised mode execution.

Implements CLAM::ProcessingComposite.

Definition at line 164 of file SpectralSynthesis.cxx.

References CLAM::InPort< Token >::Consume(), CLAM::AudioOutPort::GetAudio(), CLAM::InPort< Token >::GetData(), mInput, mOutput, and CLAM::OutPort< Token >::Produce().

Referenced by Do().

const char* CLAM::SpectralSynthesis::GetClassName

(

)

const [inline, virtual]

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

Reimplemented from CLAM::ProcessingComposite.

Definition at line 112 of file SpectralSynthesis.hxx.

const ProcessingConfig& CLAM::SpectralSynthesis::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 115 of file SpectralSynthesis.hxx.

---

Member Data Documentation

InPort<Spectrum> CLAM::SpectralSynthesis::mInput

Ports.

Definition at line 128 of file SpectralSynthesis.hxx.

Referenced by Do().

AudioOutPort CLAM::SpectralSynthesis::mOutput

Definition at line 129 of file SpectralSynthesis.hxx.

Referenced by Do().

---

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

• SpectralSynthesis.hxx
• SpectralSynthesis.cxx