GPLIB++
Public Member Functions | List of all members
gplib::IterDecon Class Reference

The iterative deconvolution algorithm, mainly used for receiver function computation. More...

#include <IterDecon.h>

Inheritance diagram for gplib::IterDecon:
Inheritance graph
[legend]

Public Member Functions

virtual const gplib::rvec & GetWeightsAsVector ()
 return the Weights as a vector, in this case the same as GetWeights More...
 
const gplib::rvec & GetWeights ()
 return the Weights More...
 
virtual void PrintWeights (std::ostream &output)
 print weights to a file More...
 
virtual void AdaptFilter (const gplib::rvec &Input, const gplib::rvec &Desired)
 Adapt the filter weights given the Input and Desired vectors. More...
 
virtual void CalcOutput (const gplib::rvec &Input, gplib::rvec &Output)
 Calculate the filter output given Input. More...
 
 IterDecon (const int inputsize, TsSpectrum &Spec)
 Input and output length have to be the same, so only one parameter for the constructor. More...
 
virtual ~IterDecon ()
 
- Public Member Functions inherited from gplib::AdaptiveFilter
const gplib::rvec & GetFilterOutput () const
 Access to the last calculated output (not sure if needed) More...
 
const gplib::rvec & GetEpsilon () const
 Return the last estimation error. More...
 
 AdaptiveFilter (const int inputsize, const int outputsize)
 The constructor needs to know the length of the input and output vectors for memory allocation. More...
 
virtual ~AdaptiveFilter ()
 

Additional Inherited Members

- Protected Member Functions inherited from gplib::AdaptiveFilter
unsigned int GetInputLength ()
 Access function for derived classes for the inputlength. More...
 
unsigned int GetOutputLength ()
 Access function for derived classes for the outputlength. More...
 
void SetEpsilon (const gplib::rvec &MyEps)
 Possibility for derived classes to set estimation error. More...
 
void SetOutput (const gplib::rvec &Out)
 Possibility for derived classes to set output. More...
 

Detailed Description

The iterative deconvolution algorithm, mainly used for receiver function computation.

Implements iterative deconvolution used for receiver function calculations but it is basically just another adaptive filter

Definition at line 15 of file IterDecon.h.

Constructor & Destructor Documentation

gplib::IterDecon::IterDecon ( const int  inputsize,
TsSpectrum Spec 
)

Input and output length have to be the same, so only one parameter for the constructor.

Definition at line 10 of file IterDecon.cpp.

gplib::IterDecon::~IterDecon ( )
virtual

Definition at line 17 of file IterDecon.cpp.

Member Function Documentation

void gplib::IterDecon::AdaptFilter ( const gplib::rvec &  Input,
const gplib::rvec &  Desired 
)
virtual

Adapt the filter weights given the Input and Desired vectors.

Implements gplib::AdaptiveFilter.

Definition at line 27 of file IterDecon.cpp.

void gplib::IterDecon::CalcOutput ( const gplib::rvec &  Input,
gplib::rvec &  Output 
)
virtual

Calculate the filter output given Input.

Implements gplib::AdaptiveFilter.

Definition at line 45 of file IterDecon.cpp.

References gplib::AdaptiveFilter::SetOutput().

const gplib::rvec& gplib::IterDecon::GetWeights ( )
inline

return the Weights

Definition at line 28 of file IterDecon.h.

virtual const gplib::rvec& gplib::IterDecon::GetWeightsAsVector ( )
inlinevirtual

return the Weights as a vector, in this case the same as GetWeights

Implements gplib::AdaptiveFilter.

Definition at line 23 of file IterDecon.h.

void gplib::IterDecon::PrintWeights ( std::ostream &  output)
virtual

print weights to a file

Implements gplib::AdaptiveFilter.

Definition at line 21 of file IterDecon.cpp.


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