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

clFIRMultiRate Class Reference

Base class for FIR based multirate filters. More...

#include <FIRMultiRate.hh>

Inheritance diagram for clFIRMultiRate:

Inheritance graph
[legend]
Collaboration diagram for clFIRMultiRate:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 clFIRMultiRate ()
 ~clFIRMultiRate ()
bool Initialize (long, const float *, bool=false)
 Initialize filter, filtering factor must be 2, 3, 4 or 8.

bool Initialize (long, const double *, bool=false)
void Uninitialize ()
 Uninitialize filter.


Protected Attributes

float fGain
 Filter gain.

double dGain
 Filter gain.

long lFactor
 Rate change factor.

clDSPOp FIR

Detailed Description

Base class for FIR based multirate filters.

Data is is filtered using FIR filter by factor 2, 3, 4 or 8.

Definition at line 35 of file FIRMultiRate.hh.


Constructor & Destructor Documentation

clFIRMultiRate::clFIRMultiRate  ) 
 

Definition at line 51 of file FIRMultiRate.cc.

clFIRMultiRate::~clFIRMultiRate  ) 
 

Definition at line 56 of file FIRMultiRate.cc.

References Uninitialize().


Member Function Documentation

bool clFIRMultiRate::Initialize long  ,
const float *  ,
bool  = false
 

Initialize filter, filtering factor must be 2, 3, 4 or 8.

You can re-initialize without uninitializing first.

The NULL pointer is used to select correct overloaded function matching input datatype.

Parameters:
FactorP Rate change factor
NullPtr NULL pointer
HighPass High-pass filter?

Definition at line 62 of file FIRMultiRate.cc.

References fGain, FIR, and clDSPOp::FIRAllocate().

Referenced by clRecInterpolator::Initialize(), and clRecDecimator::Initialize().

bool clFIRMultiRate::Initialize long  ,
const double *  ,
bool  = false
 

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 123 of file FIRMultiRate.cc.

References dGain, FIR, and clDSPOp::FIRAllocate().

void clFIRMultiRate::Uninitialize  ) 
 

Uninitialize filter.

Reimplemented in clFIRDecimator, and clFIRInterpolator.

Definition at line 184 of file FIRMultiRate.cc.

References FIR, and clDSPOp::FIRFree().

Referenced by clFIRInterpolator::Uninitialize(), clFIRDecimator::Uninitialize(), and ~clFIRMultiRate().


Member Data Documentation

float clFIRMultiRate::fGain [protected]
 

Filter gain.

Definition at line 38 of file FIRMultiRate.hh.

Referenced by Initialize().

double clFIRMultiRate::dGain [protected]
 

Filter gain.

Definition at line 39 of file FIRMultiRate.hh.

Referenced by Initialize().

long clFIRMultiRate::lFactor [protected]
 

Rate change factor.

Definition at line 40 of file FIRMultiRate.hh.

clDSPOp clFIRMultiRate::FIR [protected]
 

Definition at line 41 of file FIRMultiRate.hh.

Referenced by Initialize(), and Uninitialize().


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