LSSOFilter Class Reference
[Signal processing methods]

Base class for least squares filter with a single output value. More...

#include <LSSOFilter.h>

Inheritance diagram for LSSOFilter:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void CalcOutput (const gplib::rvec &Input, gplib::rvec &Output)
 The way to calculate the output is the same for all single output filters, we implement it here.
double CalcOutput (const gplib::rvec &Input)
 For single channel output we can also just return the output as a double.
const gplib::rvec & GetWeights ()
 Return the current set of weights.
virtual const gplib::rvec & GetWeightsAsVector ()
 Implement the abstract function from adaptive filter, in this case just another name for GetWeights.
virtual void PrintWeights (std::ostream &output)
 Print the weights to output stream.
 LSSOFilter (const int filterlength)
 The constructor only needs the filter length, outputsize for Adaptive filter is 1.
virtual ~LSSOFilter ()

Friends

class LMSCanceller
 We declare friend classes for easier access to the Weight vector.
class RLSCanceller
class AMRLSCanceller
class WienerInterpolator


Detailed Description

Base class for least squares filter with a single output value.

***************************************************** Base class for Least-Square filters with a single output value currently used for LMS and RLS filters, implements all virtual functions from CAdaptiveFilters apart from AdaptFilter, which depends on the functionality of the individual filter

Definition at line 19 of file LSSOFilter.h.


Constructor & Destructor Documentation

LSSOFilter::LSSOFilter ( const int  filterlength  ) 

The constructor only needs the filter length, outputsize for Adaptive filter is 1.

Definition at line 7 of file LSSOFilter.cpp.

LSSOFilter::~LSSOFilter (  )  [virtual]

Definition at line 15 of file LSSOFilter.cpp.


Member Function Documentation

double LSSOFilter::CalcOutput ( const gplib::rvec &  Input  )  [inline]

For single channel output we can also just return the output as a double.

Definition at line 28 of file LSSOFilter.h.

References CalcOutput().

void LSSOFilter::CalcOutput ( const gplib::rvec &  Input,
gplib::rvec &  Output 
) [virtual]

The way to calculate the output is the same for all single output filters, we implement it here.

Implements AdaptiveFilter.

Definition at line 26 of file LSSOFilter.cpp.

References AdaptiveFilter::SetOutput().

Referenced by CalcOutput().

const gplib::rvec& LSSOFilter::GetWeights (  )  [inline]

Return the current set of weights.

Definition at line 35 of file LSSOFilter.h.

Referenced by WienerInterpolator::CalcCoefficients(), and main().

virtual const gplib::rvec& LSSOFilter::GetWeightsAsVector (  )  [inline, virtual]

Implement the abstract function from adaptive filter, in this case just another name for GetWeights.

Implements AdaptiveFilter.

Definition at line 40 of file LSSOFilter.h.

void LSSOFilter::PrintWeights ( std::ostream &  output  )  [virtual]

Print the weights to output stream.

Implements AdaptiveFilter.

Definition at line 19 of file LSSOFilter.cpp.


Friends And Related Function Documentation

friend class AMRLSCanceller [friend]

Definition at line 52 of file LSSOFilter.h.

friend class LMSCanceller [friend]

We declare friend classes for easier access to the Weight vector.

Definition at line 50 of file LSSOFilter.h.

friend class RLSCanceller [friend]

Definition at line 51 of file LSSOFilter.h.

friend class WienerInterpolator [friend]

Definition at line 53 of file LSSOFilter.h.


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

Generated on Tue Aug 4 16:04:20 2009 for GPLIB++ by  doxygen 1.5.8