Comb class public functions

Comb
~Comb
action
getDelay
getMinFund
getScale
output
setDelay
setFund
setLoopTime
setMinFund
setScale

Additional functions inherited from Filter.


Comb(void);
Does nothing important.

~Comb();
Does nothing.

void action(void);
Calculates the next comb-filtered sample.

sampleType getDelay(void);
Returns the current read point in the delay element.

sampleType getMinFund(void);
Returns the fundamental resonanace frequency. The default minimum is < 12 Hz.

sampleType getScale(void);
Returns the scale factor of the feedback gain. The amplitude of the resonances will be 1/(1-g) and the amplitude of the minimum between peaks will be 1/(1+g).

sampleType output(int index);
Returns current output of the comb filter. index does not have any use.

void setDelay(sampleType aDelay);
Sets the readpoint in the delay element. For example, a value of 3 will set the delay length to 3.

void setFund(sampleType aFund);
Sets the delay length in terms of the fundamental resonance frequency. Will give incorrect results if the getMinFund() is greater than aFund.

void setLoopTime(sampleType aLoopTime);
Sets the delay length in terms of the time it takes for a sample to loop through the delay element. Units are seconds.

void setMinFund(sampleType aMin);
Sets the storage size for the delay element. If you try to use the comb filter with a frequency less than aMin, you may get incorrect results.

void setScale(sampleType aScale);
Sets the feedback scale factor. Should be a number between 0 and 1. The amplitude of the resonances will be 1/(1-g) and the amplitude of the minimum between peaks will be 1/(1+g).