Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial


OneZero Class Reference

#include <OneZero.h>

Inheritance diagram for OneZero:

Filter Stk List of all members.

Detailed Description

STK one-zero filter class.

This protected Filter subclass implements a one-zero digital filter. A method is provided for setting the zero position along the real axis of the z-plane while maintaining a constant filter gain.

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


Public Member Functions

 OneZero ()
 Default constructor creates a first-order low-pass filter.
 OneZero (StkFloat theZero)
 Overloaded constructor which sets the zero position during instantiation.
 ~OneZero ()
 Class destructor.
void clear (void)
 Clears the internal state of the filter.
void setB0 (StkFloat b0)
 Set the b[0] coefficient value.
void setB1 (StkFloat b1)
 Set the b[1] coefficient value.
void setZero (StkFloat theZero)
 Set the zero 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.
StkFramestick (StkFrames &frames, unsigned int channel=0)
 Take a channel of the StkFrames object as inputs to the filter and replace with corresponding outputs.


Member Function Documentation

void OneZero::setZero StkFloat  theZero  ) 
 

Set the zero position in the z-plane.

This method sets the zero position along the real-axis of the z-plane and normalizes the coefficients for a maximum gain of one. A positive zero value produces a high-pass filter, while a negative zero value produces a low-pass filter. This method does not affect the filter gain value.

void OneZero::setGain StkFloat  gain  )  [virtual]
 

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.

StkFrames& OneZero::tick StkFrames frames,
unsigned int  channel = 0
[virtual]
 

Take a channel of the StkFrames object as inputs to the filter and replace with corresponding outputs.

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

Reimplemented from Filter.


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