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

Apply an adaptive filter to a time-series. More...

#include <ApplyFilter.h>

Public Member Functions

void ShowProgress (const bool what)
 Do we want visual feedback of the progess on the screen, if yes draw a simple progress indicator in text mode. More...
 
gplib::rmat GetWeightHistory ()
 Return a matrix with the values of the weights at iterations specified by weightsaveintervall. More...
 
void SetWeightSaveIntervall (const int intervall)
 Set the distance between iterations at which the weights are saved. More...
 
const std::vector
< boost::shared_ptr
< TimeSeriesComponent > > & 
GetOutChannels ()
 Return the vector of output channels. More...
 
const std::vector< std::vector
< double > > & 
GetEpsValues ()
 Return the vector of channel approximation errors. More...
 
void SetShift (const int theshift)
 Set the shift between the input time series and the reference time series. More...
 
void AddInputChannel (TimeSeriesComponent &Channel)
 Add an input channel to the filter. More...
 
void AddReferenceChannel (TimeSeriesComponent &Channel)
 Add a reference channel to the filter, some AdaptiveFilter objects require only one reference. More...
 
void FilterData ()
 Filter the input channels with the current settings. More...
 
 ApplyFilter (AdaptiveFilter &TheFilter, bool keephistory=false)
 The constructor takes the AdaptiveFilter object that determines how the filtering is done, if keephistory is true we store the weights. More...
 
virtual ~ApplyFilter ()
 

Detailed Description

Apply an adaptive filter to a time-series.

Definition at line 15 of file ApplyFilter.h.

Constructor & Destructor Documentation

gplib::ApplyFilter::ApplyFilter ( AdaptiveFilter TheFilter,
bool  keephistory = false 
)

The constructor takes the AdaptiveFilter object that determines how the filtering is done, if keephistory is true we store the weights.

Definition at line 8 of file ApplyFilter.cpp.

gplib::ApplyFilter::~ApplyFilter ( )
virtual

Definition at line 14 of file ApplyFilter.cpp.

Member Function Documentation

void gplib::ApplyFilter::AddInputChannel ( TimeSeriesComponent Channel)

Add an input channel to the filter.

Definition at line 36 of file ApplyFilter.cpp.

References gplib::TimeSeriesComponent::GetData().

Referenced by main().

void gplib::ApplyFilter::AddReferenceChannel ( TimeSeriesComponent Channel)

Add a reference channel to the filter, some AdaptiveFilter objects require only one reference.

Definition at line 45 of file ApplyFilter.cpp.

References gplib::TimeSeriesComponent::GetData(), and gplib::AdaptiveFilter::GetOutputLength().

Referenced by main().

void gplib::ApplyFilter::FilterData ( )
const std::vector<std::vector<double> >& gplib::ApplyFilter::GetEpsValues ( )
inline

Return the vector of channel approximation errors.

Definition at line 47 of file ApplyFilter.h.

Referenced by main().

const std::vector<boost::shared_ptr<TimeSeriesComponent> >& gplib::ApplyFilter::GetOutChannels ( )
inline

Return the vector of output channels.

Definition at line 42 of file ApplyFilter.h.

Referenced by main().

gplib::rmat gplib::ApplyFilter::GetWeightHistory ( )

Return a matrix with the values of the weights at iterations specified by weightsaveintervall.

Return a matrix with the values of the weights at iterations specified by weightsaveintervall. Internally we use a std::vector of ublas::vector and we construct the matrix in this routine. Therefore we return a copy and the access is computationally reasonably expensive. Mostly needed for final display of weights.

Definition at line 23 of file ApplyFilter.cpp.

Referenced by main().

void gplib::ApplyFilter::SetShift ( const int  theshift)
inline

Set the shift between the input time series and the reference time series.

Definition at line 52 of file ApplyFilter.h.

Referenced by main().

void gplib::ApplyFilter::SetWeightSaveIntervall ( const int  intervall)
inline

Set the distance between iterations at which the weights are saved.

Definition at line 37 of file ApplyFilter.h.

Referenced by main().

void gplib::ApplyFilter::ShowProgress ( const bool  what)
inline

Do we want visual feedback of the progess on the screen, if yes draw a simple progress indicator in text mode.

Definition at line 30 of file ApplyFilter.h.

Referenced by main().


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