class LineFilter : public Pipe

Line Removal.

Inheritance:


Public Methods

LineFilter(void)
Default constructor.
LineFilter(double f, double w = 0., int fid = -1)
Constructor.
~LineFilter(void)
Virtual destructor.
TSeries apply(const TSeries& ts)
Return cleaned TSeries.
TSeries operator)(const TSeries& ts)
The argument time series is filtered to remove lines, and the argument TSeries ts is left unchanged
void dataCheck(const TSeries& ts) const
Check the data for validity
bool isDataValid(const TSeries& ts) const
Check the data for validity
void reset(void)
Clear/release the internal History vector and reset the current time

Inherited from Pipe:

Public Methods

virtual bool inUse(void) const
KeyChain& getInputKeys(void) const
KeyChain& getOutputKeys(void) const
virtual Time getStartTime(void) const
virtual Time getCurrentTime(void) const

Inherited from FilterBase:

Public Methods

virtual bool rootGetStartTime(Time& t) const throw()
virtual bool rootGetCurrentTime(Time& t) const throw()

Documentation

The LineFilter class containes methods to track and remove quasi- monochromatic lines. a TSeries by 2^N. The TSeries data are filtered before decimation to remove aliasing.
LineFilter(void)
Build an empty LineFilter.

LineFilter(double f, double w = 0., int fid = -1)
Constructor.

~LineFilter(void)
Destroy the LineFilter object and release the function storage.

TSeries apply(const TSeries& ts)
The argument time series is filtered to remove lines, and the argument TSeries ts is left unchanged.

TSeries operator)(const TSeries& ts)
The argument time series is filtered to remove lines, and the argument TSeries ts is left unchanged

void dataCheck(const TSeries& ts) const
Check the data for validity. If the data are not applicable for line removal, an exception is thrown.

bool isDataValid(const TSeries& ts) const
Check the data for validity. Performs the same data checks as dataCheck() but returns a boolean status instead f throwing an exception.

void reset(void)
Clear/release the internal History vector and reset the current time


This class has no child classes.
Author:
Sergey Klimenko
Version:
1.2 ; Modified November 17, 2000

alphabetic index hierarchy of classes


generated by doc++