clFIRDecimator Class Reference

FIR decimation filter class implementation. More...

#include <FIRDecimator.hh>

Inheritance diagram for clFIRDecimator:

[legend]Collaboration diagram for clFIRDecimator:

[legend]List of all members.

Public Member Functions
	clFIRDecimator ()
	~clFIRDecimator ()
void	Uninitialize ()
	Uninitialize decimator.
void	Put (const float *, long)
	Feed data into decimator.
void	Put (const double *, long)
bool	Get (float *, long)
	Get data from decimator.
bool	Get (double *, long)
Private Attributes
clDSPAlloc	DecBuf
clDSPOp	DSP
clReBuffer	InBuf

---

Detailed Description

FIR decimation filter class implementation.

Data is filtered using FIR filter and then decimated by factor 2, 4 or 8.

Definition at line 41 of file FIRDecimator.hh.

---

Constructor & Destructor Documentation

clFIRDecimator::clFIRDecimator (   )

Definition at line 34 of file FIRDecimator.cc.

clFIRDecimator::~clFIRDecimator (   )

Definition at line 39 of file FIRDecimator.cc. References Uninitialize().

---

Member Function Documentation

void clFIRDecimator::Uninitialize (   )

Uninitialize decimator. Reimplemented from clFIRMultiRate. Definition at line 45 of file FIRDecimator.cc. References DecBuf, clAlloc::Free(), and clFIRMultiRate::Uninitialize(). Referenced by clRecDecimator::Uninitialize(), and ~clFIRDecimator().

void clFIRDecimator::Put (  const float *  , long  )

Feed data into decimator. Parameters: SrcData  Source data SrcCount  Source data count Definition at line 52 of file FIRDecimator.cc. References InBuf, and clReBuffer::Put(). Referenced by clRecDecimator::Put().

void clFIRDecimator::Put (  const 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 58 of file FIRDecimator.cc. References InBuf, and clReBuffer::Put().

bool clFIRDecimator::Get (  float *  , long  )

Get data from decimator. Parameters: DestData  Destination buffer DestCount  Number of samples to fetch Returns: Success Definition at line 64 of file FIRDecimator.cc. References DecBuf, clDSPOp::Decimate(), DSP, clFIRMultiRate::fGain, clFIRMultiRate::FIR, clDSPOp::FIRFilter(), clReBuffer::Get(), InBuf, clFIRMultiRate::lFactor, clDSPOp::Mul(), and clAlloc::Size(). Referenced by clRecDecimator::Put().

bool clFIRDecimator::Get (  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 80 of file FIRDecimator.cc. References DecBuf, clDSPOp::Decimate(), clFIRMultiRate::dGain, DSP, clFIRMultiRate::FIR, clDSPOp::FIRFilter(), clReBuffer::Get(), InBuf, clFIRMultiRate::lFactor, clDSPOp::Mul(), and clAlloc::Size().

---

Member Data Documentation

clDSPAlloc clFIRDecimator::DecBuf [private]

Definition at line 43 of file FIRDecimator.hh. Referenced by Get(), and Uninitialize().

clDSPOp clFIRDecimator::DSP [private]

Definition at line 44 of file FIRDecimator.hh. Referenced by Get().

clReBuffer clFIRDecimator::InBuf [private]

Definition at line 45 of file FIRDecimator.hh. Referenced by Get(), and Put().

---

The documentation for this class was generated from the following files:

• FIRDecimator.hh
• FIRDecimator.cc

---