Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

clIIRCascade Class Reference

Class to handle cascaded IIR stages as one filter. More...

#include <IIRCascade.hh>

Inheritance diagram for clIIRCascade:

Inheritance graph
[legend]
Collaboration diagram for clIIRCascade:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 clIIRCascade ()
 ~clIIRCascade ()
bool Initialize (const float[][5], long)
 Initialize filter.

bool Initialize (const double[][5], long)
void Uninitialize ()
 Uninitialize filter.

void Process (float *, long)
 Filter data in-place.

void Process (double *, long)
void Process (float *, const float *, long)
 Filter data out-of-place.

void Process (double *, const double *, long)
void Clear ()
 Clear filter feedback chain.


Protected Attributes

long lStages
clDSPOpIIR

Private Attributes

bool bInitialized

Detailed Description

Class to handle cascaded IIR stages as one filter.

Definition at line 33 of file IIRCascade.hh.


Constructor & Destructor Documentation

clIIRCascade::clIIRCascade  ) 
 

Definition at line 26 of file IIRCascade.cc.

References IIR, and lStages.

clIIRCascade::~clIIRCascade  ) 
 

Definition at line 34 of file IIRCascade.cc.

References Uninitialize().


Member Function Documentation

bool clIIRCascade::Initialize const  float[][5],
long 
 

Initialize filter.

Note:
You can re-initialize without uninitializing first.
Parameters:
Coeffs Array of arrays of 5 coefficient bi-quad stages
StageCount Number of cascaded bi-quad filter stages

Definition at line 41 of file IIRCascade.cc.

References IIR, clDSPOp::IIRInitialize(), lStages, and Uninitialize().

Referenced by clIIRMultiRate::Initialize().

bool clIIRCascade::Initialize const  double[][5],
long 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 56 of file IIRCascade.cc.

References IIR, clDSPOp::IIRInitialize(), lStages, and Uninitialize().

void clIIRCascade::Uninitialize  ) 
 

Uninitialize filter.

Reimplemented in clIIRDecimator, clIIRInterpolator, and clIIRMultiRate.

Definition at line 71 of file IIRCascade.cc.

References IIR, and lStages.

Referenced by Initialize(), clIIRMultiRate::Uninitialize(), and ~clIIRCascade().

void clIIRCascade::Process float *  ,
long 
 

Filter data in-place.

Parameters:
Vect Source & destination vector
Count Vector length

Definition at line 83 of file IIRCascade.cc.

References IIR, clDSPOp::IIRFilter(), and lStages.

Referenced by clIIRDecimator::Get(), and clIIRInterpolator::Put().

void clIIRCascade::Process double *  ,
long 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 92 of file IIRCascade.cc.

References IIR, clDSPOp::IIRFilter(), and lStages.

void clIIRCascade::Process float *  ,
const float *  ,
long 
 

Filter data out-of-place.

Parameters:
Dest Destination vector
Src Source vector
Count Vector length

Definition at line 101 of file IIRCascade.cc.

References IIR, clDSPOp::IIRFilter(), and lStages.

void clIIRCascade::Process double *  ,
const double *  ,
long 
 

Definition at line 111 of file IIRCascade.cc.

References IIR, clDSPOp::IIRFilter(), and lStages.

void clIIRCascade::Clear  ) 
 

Clear filter feedback chain.

Definition at line 121 of file IIRCascade.cc.

References IIR, clDSPOp::IIRClear(), and lStages.


Member Data Documentation

bool clIIRCascade::bInitialized [private]
 

Definition at line 35 of file IIRCascade.hh.

long clIIRCascade::lStages [protected]
 

Definition at line 37 of file IIRCascade.hh.

Referenced by Clear(), clIIRCascade(), Initialize(), Process(), and Uninitialize().

clDSPOp* clIIRCascade::IIR [protected]
 

Definition at line 38 of file IIRCascade.hh.

Referenced by Clear(), clIIRCascade(), Initialize(), Process(), and Uninitialize().


The documentation for this class was generated from the following files:
Generated on Tue Mar 2 19:47:11 2004 for libDSP by doxygen 1.3.6