Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   Tutorial


SubNoise Class Reference

#include <SubNoise.h>

Inheritance diagram for SubNoise:

Noise Generator Stk List of all members.

Detailed Description

STK sub-sampled noise generator.

Generates a new random number every "rate" ticks using the C rand() function. The quality of the rand() function varies from one OS to another.

by Perry R. Cook and Gary P. Scavone, 1995 - 2004.

Definition at line 18 of file SubNoise.h.

Public Member Functions

 SubNoise (int subRate=16)
 Default constructor sets sub-sample rate to 16.

 ~SubNoise ()
 Class destructor.

int subRate (void) const
 Return the current sub-sampling rate.

void setRate (int subRate)
 Set the sub-sampling rate.

StkFloat tick ()
 Return a sub-sampled random number between -1.0 and 1.0.

StkFloat * tick (StkFloat *vector, unsigned int vectorSize)
 Compute vectorSize outputs and return them in vector.

StkFramestick (StkFrames &frames, unsigned int channel=1)
 Fill a channel of the StkFrames object with computed outputs.


Member Function Documentation

StkFrames& SubNoise::tick StkFrames frames,
unsigned int  channel = 1
[virtual]
 

Fill a channel of the StkFrames object with computed outputs.

The channel argument should be one or greater (the first channel is specified by 1). An StkError will be thrown if the channel argument is zero or it is greater than the number of channels in the StkFrames object.

Reimplemented from Noise.


The documentation for this class was generated from the following file:
The Synthesis ToolKit in C++ (STK)
©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.