Home Information Classes Download Usage Mail List Requirements Links FAQ Tutorial
#include <OnePole.h>
Inheritance diagram for OnePole:
This protected Filter subclass implements a one-pole digital filter. A method is provided for setting the pole position along the real axis of the z-plane while maintaining a constant peak filter gain.
by Perry R. Cook and Gary P. Scavone, 1995 - 2007.
Public Member Functions | |
OnePole () | |
Default constructor creates a first-order low-pass filter. | |
OnePole (StkFloat thePole) | |
Overloaded constructor which sets the pole position during instantiation. | |
~OnePole () | |
Class destructor. | |
void | clear (void) |
Clears the internal state of the filter. | |
void | setB0 (StkFloat b0) |
Set the b[0] coefficient value. | |
void | setA1 (StkFloat a1) |
Set the a[1] coefficient value. | |
void | setPole (StkFloat thePole) |
Set the pole position in the z-plane. | |
void | setGain (StkFloat gain) |
Set the filter gain. | |
StkFloat | getGain (void) const |
Return the current filter gain. | |
StkFloat | lastOut (void) const |
Return the last computed output value. | |
StkFloat | tick (StkFloat sample) |
Input one sample to the filter and return one output. | |
StkFrames & | tick (StkFrames &frames, unsigned int channel=0) |
Take a channel of the StkFrames object as inputs to the filter and replace with corresponding outputs. |
|
Set the pole position in the z-plane. This method sets the pole position along the real-axis of the z-plane and normalizes the coefficients for a maximum gain of one. A positive pole value produces a low-pass filter, while a negative pole value produces a high-pass filter. This method does not affect the filter gain value. |
|
Set the filter gain. The gain is applied at the filter input and does not affect the coefficient values. The default gain value is 1.0. Reimplemented from Filter. |
|
Take a channel of the StkFrames object as inputs to the filter and replace with corresponding outputs.
The Reimplemented from Filter. |
The Synthesis ToolKit in C++ (STK) |
©1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved. |