Base Relacs Plugins  0.9.8
Public Member Functions | Protected Attributes | List of all members
LowPass Class Reference

#include <lowpass.h>

Inheritance diagram for LowPass:
Inheritance graph
[legend]
Collaboration diagram for LowPass:
Collaboration graph
[legend]

Public Member Functions

 LowPass (const string &ident="", int mode=0)
 
 ~LowPass (void)
 
virtual int init (const InData &indata, InData &outdata)
 
virtual int adjust (const InData &indata, InData &outdata)
 
virtual void notify (void)
 
virtual int filter (const InData &indata, InData &outdata)
 
- Public Member Functions inherited from Filter
 Filter (const string &ident, int mode, FilterType type, int outtraces=0, const string &name="", const string &pluginset="", const string &author="unknown", const string &version="unknown", const string &date=__DATE__)
 
virtual ~Filter (void)
 
virtual int init (const InList &indata, InList &outdata)
 
virtual int init (const EventData &inevents, InData &outdata)
 
virtual int init (const EventList &inevents, InList &outdata)
 
virtual int init (const InData &indata, EventData &outevents, const EventList &other, const EventData &stimuli)
 
virtual int init (const InList &indata, EventList &outevents, const EventList &other, const EventData &stimuli)
 
virtual int init (const EventData &inevents, EventData &outevents, const EventList &other, const EventData &stimuli)
 
virtual int init (const EventList &inevents, EventList &outevents, const EventList &other, const EventData &stimuli)
 
virtual int adjust (const InList &indata, InList &outdata)
 
virtual int adjust (const EventData &inevents, InData &outdata)
 
virtual int adjust (const EventList &inevents, InList &outdata)
 
virtual int adjust (const InData &indata)
 
virtual int adjust (const InList &indata)
 
virtual int adjust (const EventData &inevents)
 
virtual int adjust (const EventList &inevents)
 
virtual int autoConfigure (const InData &indata, double tbegin, double tend)
 
virtual int autoConfigure (const InList &indata, double tbegin, double tend)
 
virtual int autoConfigure (const EventData &inevents, double tbegin, double tend)
 
virtual int autoConfigure (const EventList &inevents, double tbegin, double tend)
 
virtual int filter (const InList &indata, InList &outdata)
 
virtual int filter (const EventData &inevents, InData &outdata)
 
virtual int filter (const EventList &inevents, InList &outdata)
 
virtual int detect (const InData &data, EventData &outevents, const EventList &other, const EventData &stimuli)
 
virtual int detect (const InList &data, EventList &outevents, const EventList &other, const EventData &stimuli)
 
virtual int detect (const EventData &inevents, EventData &outevents, const EventList &other, const EventData &stimuli)
 
virtual int detect (const EventList &inevents, EventList &outevents, const EventList &other, const EventData &stimuli)
 
virtual void save (const string &param)
 
void save (void)
 
const string & ident (void) const
 
virtual void setIdent (const string &ident)
 
virtual void setName (const string &name)
 
FilterType type (void) const
 
int outTraces (void) const
 
int mode (void) const
 
void setMode (int mode)
 
- Public Member Functions inherited from ConfigDialog
 ConfigDialog (const string &configident="", int configgroup=0, const string &name="", const string &author="", const string &version="", const string &date=__DATE__)
 
virtual ~ConfigDialog (void)
 
string name (void) const
 
string author (void) const
 
virtual void setAuthor (const string &author)
 
string version (void) const
 
virtual void setVersion (const string &version)
 
string date (void) const
 
virtual void setDate (const string &date)
 
virtual OptWidgetdialogOptions (OptDialog *od, string *tabhotkeys=0)
 
virtual void dialogButtons (OptDialog *od)
 
virtual void dialogEmptyMessage (OptDialog *od)
 
int dialogSelectMask (void) const
 
void setDialogSelectMask (int mask)
 
void addDialogSelectMask (int mask)
 
int dialogReadOnlyMask (void) const
 
void setDialogReadOnlyMask (int mask)
 
void addDialogReadOnlyMask (int mask)
 
int dialogStyle (void) const
 
void setDialogStyle (int style)
 
void addDialogStyle (int style)
 
string dialogCaption (void) const
 
void setDialogCaption (const string &caption)
 
bool dialogHeader (void) const
 
void setDialogHeader (bool d)
 
string headerBackgroundColor (void) const
 
void setHeaderBackgroundColor (const string &color)
 
string headerForegroundColor (void) const
 
void setHeaderForegroundColor (const string &color)
 
string headerImageFile (void) const
 
void setHeaderImageFile (const string &file)
 
virtual void dialogHeaderWidget (OptDialog *od)
 
bool dialogHelp (void) const
 
void setDialogHelp (bool d)
 
string helpCaption (void) const
 
void setHelpCaption (const string &caption)
 
string helpPath (int inx=0) const
 
int helpPathes (void) const
 
void clearHelpPathes (void)
 
void setHelpPath (const string &path)
 
void addHelpPath (const string &path)
 
virtual string helpFileName (void) const
 
bool dialogOpen (void) const
 
bool helpOpen (void) const
 
QWidget * mainWidget (void)
 
virtual void setMainWidget (QWidget *widget)
 
void lock () const
 
void unlock () const
 
bool tryLock (int timeout=1)
 
QMutex * mutex (void)
 
- Public Member Functions inherited from ConfigClass
 ConfigClass (const string &ident, int group=0, int mode=0xffff, int selectmask=0)
 
 ConfigClass (const ConfigClass &C)
 
virtual ~ConfigClass (void)
 
const string & configIdent (void) const
 
void setConfigIdent (const string &ident)
 
int configGroup (void) const
 
void setConfigGroup (int group)
 
int configMode (void) const
 
void setConfigMode (int mode)
 
void addConfigMode (int mode)
 
void delConfigMode (int mode)
 
int configSelectMask (void) const
 
void setConfigSelectMask (int mask)
 
void addConfig (void)
 
void readConfig (void)
 
virtual void readConfig (StrQueue &sq)
 
virtual void saveConfig (ofstream &str)
 
virtual int configSize (void) const
 
virtual void config (void)
 
virtual void preConfig (void)
 

Protected Attributes

OptWidget LFW
 
double Tau
 
double DeltaT
 
double TFac
 
InDataIterator Index
 
float X
 
- Protected Attributes inherited from ConfigDialog
Options DialogOptions
 

Additional Inherited Members

- Public Types inherited from Filter
enum  FilterType
 
- Public Types inherited from ConfigClass
enum  Action
 
- Public Slots inherited from ConfigDialog
virtual void dialog (void)
 
virtual void help (void)
 
virtual void notifyDialog (const Options &opt)
 
- Signals inherited from ConfigDialog
void dialogAccepted (void)
 
void dialogAction (int r)
 
void dialogClosed (int r)
 
- Static Public Member Functions inherited from ConfigClass
static void setConfigureClasses (ConfigureClasses *cfg)
 
- Protected Slots inherited from ConfigDialog
void notificationFromDialog (const Parameter &p)
 
virtual void dClosed (int r)
 
virtual void hClosed (int r)
 
- Protected Member Functions inherited from ConfigDialog
void setDialogOpen (bool open=true)
 
void setHelpOpen (bool open=true)
 

Detailed Description

[Filter] A simple first-order low-pass filter

Author
Jan Benda

The input x(t) is filtered with the ordinary differential equation

\[ \tau \frac{dy}{dt} = x - y \]

to result in the low-pass filtered output y(t). The cut-off frequency of the filter is at

\[ f_c = \frac{1}{2 \pi \tau} \]

Add the low-pass filter with the following lines to a relacs.cfg file:

*FilterDetectors
  Filter1
        name: LV-1
      filter: LowPass
  inputtrace: V-1
        save: false
        plot: true
  buffersize: 500000
Options
  • tau=1000ms: Filter time constant (number)
Version
0.2 (May 12 2012)

Constructor & Destructor Documentation

LowPass ( const string &  ident = "",
int  mode = 0 
)
~LowPass ( void  )

The destructor.

Member Function Documentation

int init ( const InData indata,
InData outdata 
)
virtual
int adjust ( const InData indata,
InData outdata 
)
virtual
void notify ( void  )
virtual
int filter ( const InData indata,
InData outdata 
)
virtual

Reimplemented from Filter.

References InData::end(), LowPass::Index, InData::push(), LowPass::TFac, and LowPass::X.

Member Data Documentation

OptWidget LFW
protected
double Tau
protected
double DeltaT
protected

Referenced by LowPass::init(), and LowPass::notify().

double TFac
protected
InDataIterator Index
protected

Referenced by LowPass::filter(), and LowPass::init().

float X
protected

Referenced by LowPass::filter(), and LowPass::init().


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