iso::synth::FFTThreshold Class Reference

#include <iso_synth_fft_threshold.h>

Inherits iso::synth::ProcessUnit.

Inheritance diagram for iso::synth::FFTThreshold:

[legend]Collaboration diagram for iso::synth::FFTThreshold:

[legend]List of all members.

Public Member Functions
	FFTThreshold ()
	default constructor
	FFTThreshold (const String &pName)
	name constructor
	FFTThreshold (unsigned int pOverlap)
	parameter based contructor
	FFTThreshold (const String &pName, unsigned int pOverlap)
	parameter based contructor
	FFTThreshold (unsigned int pChannelCount, unsigned int pOverlap)
	parameter based contructor
	FFTThreshold (const String &pName, unsigned int pChannelCount, unsigned int pOverlap)
	parameter based contructor
	FFTThreshold (unsigned int pOverlap, unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate, FanInType pFanInType=FANIN_ADD)
	name and parameter based constructor
	FFTThreshold (const base::String &pName, unsigned int pOverlap, unsigned int pFrameCount, unsigned int pChannelCount, unsigned int pRate, FanInType pFanInType=FANIN_ADD)
	name and parameter based constructor
	FFTThreshold (const FFTThreshold &pUnit)
	copy constructor
	FFTThreshold (const String &pName, const FFTThreshold &pUnit)
	name & copy constructor
	FFTThreshold (const data::Values &pValues) throw (SynthException)
	values based constructor
	~FFTThreshold ()
	destructor
virtual void	process (Buffer *pBuffer=NULL) throw (SynthException)
	processes buffer
void	setRelative (bool pRelative)
	set relative threshold
virtual String	info (bool pPropagate=false, bool pShowPorts=true) const
	obtain textual unit information
Static Public Attributes
static const String	sClassName
	default name
Protected Member Functions
void	init ()
	initializes switch ports
Protected Attributes
ControlPort *	mThreshold
	threshold control port
unsigned int	mOverlap
	number of overlaps
bool	mRelative
	relative thresholding flag
Static Protected Attributes
static unsigned int	sUnitCount
	total number of units created so far
Friends
std::ostream &	operator<< (std::ostream &pOstream, const FFTThreshold &pUnit)
	print unit information

---

Constructor & Destructor Documentation

FFTThreshold::FFTThreshold

(

)

default constructor

FFTThreshold::FFTThreshold

(

const String &

pName

)

name constructor

Parameters:

pName

unit name

FFTThreshold::FFTThreshold

(

unsigned int

pOverlap

)

parameter based contructor

Parameters:

pOverlap

number of overlaps

FFTThreshold::FFTThreshold	(	const String &	pName,
		unsigned int	pOverlap
	)

parameter based contructor

Parameters:

	pName	unit name
	pOverlap	number of overlaps

FFTThreshold::FFTThreshold	(	unsigned int	pChannelCount,
		unsigned int	pOverlap
	)

parameter based contructor

Parameters:

	pChannelCount	number of channels
	pOverlap	number of overlaps

FFTThreshold::FFTThreshold	(	const String &	pName,
		unsigned int	pChannelCount,
		unsigned int	pOverlap
	)

parameter based contructor

Parameters:

	pName	unit name
	pChannelCount	number of channels
	pOverlap	number of overlaps

FFTThreshold::FFTThreshold	(	unsigned int	pOverlap,
		unsigned int	pFrameCount,
		unsigned int	pChannelCount,
		unsigned int	pRate,
		FanInType	pFanInType = FANIN_ADD
	)

name and parameter based constructor

Parameters:

	pOverlap	number of overlaps
	pFrameCount	number of frames
	pChannelCount	number of channels
	pRate	samping rate
	pFanInType	strategy for combining audio buffers in case this unit is connected to several units

FFTThreshold::FFTThreshold	(	const base::String &	pName,
		unsigned int	pOverlap,
		unsigned int	pFrameCount,
		unsigned int	pChannelCount,
		unsigned int	pRate,
		FanInType	pFanInType = FANIN_ADD
	)

name and parameter based constructor

Parameters:

	pName	unit name
	pOverlap	number of overlaps
	pFrameCount	number of frames
	pChannelCount	number of channels
	pRate	samping rate
	pFanInType	strategy for combining audio buffers in case this unit is connected to several units

FFTThreshold::FFTThreshold

(

const FFTThreshold &

pUnit

)

copy constructor

Parameters:

pUnit

unit to copy properties from

FFTThreshold::FFTThreshold	(	const String &	pName,
		const FFTThreshold &	pUnit
	)

name & copy constructor

Parameters:

	pName	unit name
	pUnit	unit to copy properties from

FFTThreshold::FFTThreshold

(

const data::Values &

pValues

)

throw (SynthException)

values based constructor

Parameters:

pValues

unit values

Exceptions:

SynthException

failed to create unit

pValues structure & data types: 0: const String& : unit name 1: unsigned int : number of window overlaps 2: unsigned int : number of frames 3: unsigned int : number of channels 4: unsigned int : samping rate

FFTThreshold::~FFTThreshold

(

)

destructor

---

Member Function Documentation

void FFTThreshold::process

(

Buffer *

pBuffer = NULL

)

throw (SynthException) [virtual]

processes buffer

Parameters:

pBuffer

buffer to process

Reimplemented from iso::synth::ProcessUnit.

void FFTThreshold::setRelative

(

bool

pRelative

)

set relative threshold

Parameters:

pRelative

( true: absolute frequency amplitudes are thresholded, false: normalized freqency amplitudes are thresholded )

base::String FFTThreshold::info	(	bool	pPropagate = false,
		bool	pShowPorts = true
	)			const [virtual]

obtain textual unit information

Parameters:

	pPropagate	if true, the unit calls the info methods of its input ports
	pShowPorts	print port information

Returns:

String containing unit information

Reimplemented from iso::synth::ProcessUnit.

void FFTThreshold::init

(

)

[protected]

initializes switch ports

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	pOstream,
		const FFTThreshold &	pUnit
	)			[friend]

print unit information

---

Member Data Documentation

const base::String FFTThreshold::sClassName [static]

default name

Reimplemented from iso::synth::ProcessUnit.

unsigned int FFTThreshold::sUnitCount [static, protected]

total number of units created so far

Reimplemented from iso::synth::ProcessUnit.

ControlPort* iso::synth::FFTThreshold::mThreshold [protected]

threshold control port

unsigned int iso::synth::FFTThreshold::mOverlap [protected]

number of overlaps

bool iso::synth::FFTThreshold::mRelative [protected]

relative thresholding flag

false: absolute frequency amplitudes are thresholded true: normalized frequency amplitudes are thresholded

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/unit/proc/fft/iso_synth_fft_threshold.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/unit/proc/fft/iso_synth_fft_threshold.cpp

---