CLAM::CircularShift Class Reference

#include <CircularShift.hxx>

Inheritance diagram for CLAM::CircularShift:

List of all members.

---

Detailed Description

This Processing class takes an input audio buffer and shifts it to get zero-phase conditions in the STFT.

Definition at line 42 of file CircularShift.hxx.

Public Member Functions
	CircularShift ()
	CircularShift (const CircularShiftConfig &c)
	~CircularShift ()
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do (void)
	Supervised mode execution method (using ports).
bool	Do (const DataArray &input, DataArray &out)
bool	Do (Spectrum &input, Spectrum &out)
bool	Do (const Audio &input, Audio &out)
bool	SetPrototypes (Spectrum &inputs, const Spectrum &out)
	Not implemented yet.
bool	SetPrototypes ()
	Not implemented yet.
bool	UnsetPrototypes ()
	Not implemented yet.
bool	MayDisableExecution () const
	Not implemented yet.
void	SetAmount (TSize amount)
Protected Member Functions
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
bool	ConcreteConfigure (const ProcessingConfig &)
	Config change method.
Protected Attributes
CircularShiftConfig	mConfig
AudioInPort	mInput
AudioOutPort	mOutput
InControl	mSteps

---

Constructor & Destructor Documentation

CLAM::CircularShift::CircularShift

(

)

Definition at line 31 of file CircularShift.cxx.

References CLAM::Processing::Configure().

CLAM::CircularShift::CircularShift

(

const CircularShiftConfig &

c

)

Definition at line 39 of file CircularShift.cxx.

References CLAM::Processing::Configure().

CLAM::CircularShift::~CircularShift

(

)

Definition at line 47 of file CircularShift.cxx.

---

Member Function Documentation

const char* CLAM::CircularShift::GetClassName

(

)

const [inline, protected, virtual]

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

Implements CLAM::Processing.

Definition at line 53 of file CircularShift.hxx.

bool CLAM::CircularShift::ConcreteConfigure

(

const ProcessingConfig &

c

)

[protected, virtual]

Config change method.

Reimplemented from CLAM::Processing.

Definition at line 53 of file CircularShift.cxx.

References CLAM::Processing::CopyAsConcreteConfig(), CLAM::InControl::DoControl(), mConfig, and mSteps.

const ProcessingConfig& CLAM::CircularShift::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.

Reimplemented from CLAM::Processing.

Definition at line 66 of file CircularShift.hxx.

References mConfig.

bool CLAM::CircularShift::Do

(

void

)

[virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 80 of file CircularShift.cxx.

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

Referenced by CLAM::SpectralSynthesis::Do(), CLAM::SpectralAnalysis::Do(), Do(), and CLAM::AudioWindowing::Do().

bool CLAM::CircularShift::Do	(	const DataArray &	input,
		DataArray &	out
	)

Definition at line 90 of file CircularShift.cxx.

References CLAM_ASSERT, CLAM::InControl::GetLastValue(), and mSteps.

bool CLAM::CircularShift::Do	(	Spectrum &	input,
		Spectrum &	out
	)

Definition at line 127 of file CircularShift.cxx.

References CLAM_ASSERT, and Do().

bool CLAM::CircularShift::Do	(	const Audio &	input,
		Audio &	out
	)

Definition at line 135 of file CircularShift.cxx.

References Do().

bool CLAM::CircularShift::SetPrototypes	(	Spectrum &	inputs,
		const Spectrum &	out
	)

Not implemented yet.

Definition at line 63 of file CircularShift.cxx.

bool CLAM::CircularShift::SetPrototypes

(

)

Not implemented yet.

Definition at line 68 of file CircularShift.cxx.

bool CLAM::CircularShift::UnsetPrototypes

(

)

Not implemented yet.

Definition at line 73 of file CircularShift.cxx.

bool CLAM::CircularShift::MayDisableExecution

(

)

const [inline]

Not implemented yet.

Definition at line 83 of file CircularShift.hxx.

void CLAM::CircularShift::SetAmount

(

TSize

amount

)

[inline]

Definition at line 85 of file CircularShift.hxx.

References CLAM::InControl::DoControl(), and mSteps.

---

Member Data Documentation

CircularShiftConfig CLAM::CircularShift::mConfig [protected]

Definition at line 45 of file CircularShift.hxx.

Referenced by ConcreteConfigure(), and GetConfig().

AudioInPort CLAM::CircularShift::mInput [protected]

Definition at line 47 of file CircularShift.hxx.

Referenced by Do().

AudioOutPort CLAM::CircularShift::mOutput [protected]

Definition at line 48 of file CircularShift.hxx.

Referenced by Do().

InControl CLAM::CircularShift::mSteps [protected]

Definition at line 50 of file CircularShift.hxx.

Referenced by ConcreteConfigure(), Do(), and SetAmount().

---

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

• CircularShift.hxx
• CircularShift.cxx