RectangularWindow Class Reference

This implements a window function which basically does nothing: y = 1.0. More...

#include <TTRectangularWindow.h>

Inheritance diagram for RectangularWindow:

Collaboration diagram for RectangularWindow:

Protected Member Functions
TTErr	calculateValue (const TTFloat64 &x, TTFloat64 &y, TTPtrSizedInt data)
	Calculate y = f(x) for a single value. More...
TTErr	processAudio (TTAudioSignalArrayPtr inputs, TTAudioSignalArrayPtr outputs)
	A standard audio processing method as used by TTBlue objects. More...
TTErr	test (TTValue &returnedTestInfo)
	Unit test for the window function unit. More...

Detailed Description

This implements a window function which basically does nothing: y = 1.0.

It is the same as the Matlab function: w=rectwin(L) Which is an alias for: w = ones(L,1); http://www.mathworks.com/help/toolbox/signal/ref/rectwin.html

This can be expressed also as: w(n) = 1, 0 <= n <= N-1

Values outside of this range could be set to zero, though (at least in theory) we should never receive a request for out-of-range values.

Definition at line 51 of file TTRectangularWindow.h.

Member Function Documentation

TTErr RectangularWindow::calculateValue ( const TTFloat64 &  x, TTFloat64 &  y, TTPtrSizedInt  data  )

inlineprotected

Calculate y = f(x) for a single value.

Parameters

x	The input value to the window function.
y	The resulting value for the window function.
data	Not used.

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 49 of file TTRectangularWindow.cpp.

References kTTErrNone.

Referenced by processAudio().

TTErr RectangularWindow::processAudio ( TTAudioSignalArrayPtr  inputs, TTAudioSignalArrayPtr  outputs  )

protected

A standard audio processing method as used by TTBlue objects.

Parameters

inputs	The input vector that is to be processed.
outputs	The resulting windowed vector.

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Definition at line 56 of file TTRectangularWindow.cpp.

References calculateValue().

Here is the call graph for this function:

TTErr RectangularWindow::test ( TTValue &  returnedTestInfo )

protectedvirtual

Unit test for the window function unit.

Parameters

returnedTestInfo

The outcome from the performed unit test.

Returns

TTErr error code if the method fails to execute, else kTTErrNone.

Reimplemented from TTAudioObjectBase.

Definition at line 31 of file TTRectangularWindow.test.cpp.

References TTAudioSignal::allocWithVectorSize(), TTAudioSignal::mSampleVectors, TTAudioObjectBase::process(), TTObjectBase::setAttributeValue(), TT, TTObjectBaseInstantiate(), and TTObjectBaseRelease().

Here is the call graph for this function:

---

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

• TTRectangularWindow.h
• TTRectangularWindow.cpp
• TTRectangularWindow.test.cpp