Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial


PoleZero Class Reference

#include <PoleZero.h>

Inheritance diagram for PoleZero:

Filter Stk List of all members.

Detailed Description

STK one-pole, one-zero filter class.

This protected Filter subclass implements a one-pole, one-zero digital filter. A method is provided for creating an allpass filter with a given coefficient. Another method is provided to create a DC blocking filter.

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


Public Member Functions

 PoleZero ()
 Default constructor creates a first-order pass-through filter.
 ~PoleZero ()
 Class destructor.
void clear (void)
 Clears the internal states of the filter.
void setB0 (StkFloat b0)
 Set the b[0] coefficient value.
void setB1 (StkFloat b1)
 Set the b[1] coefficient value.
void setA1 (StkFloat a1)
 Set the a[1] coefficient value.
void setAllpass (StkFloat coefficient)
 Set the filter for allpass behavior using coefficient.
void setBlockZero (StkFloat thePole=0.99)
 Create a DC blocking filter with the given 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.
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 PoleZero::setAllpass StkFloat  coefficient  ) 
 

Set the filter for allpass behavior using coefficient.

This method uses coefficient to create an allpass filter, which has unity gain at all frequencies. Note that the coefficient magnitude must be less than one to maintain stability.

void PoleZero::setBlockZero StkFloat  thePole = 0.99  ) 
 

Create a DC blocking filter with the given pole position in the z-plane.

This method sets the given pole position, together with a zero at z=1, to create a DC blocking filter. thePole should be close to one to minimize low-frequency attenuation.

void PoleZero::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& PoleZero::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.