CompoundPye  0.93
Modelling and Simulation Framework for Neural Networks of Arthropod Compound Eyes
 All Classes Namespaces Functions Variables Pages
CompoundPye.src.Components.highpass_filter.HighpassFilter Class Reference

Component with a predefined transfer function turning it into a high-pass filter. More...

Inheritance diagram for CompoundPye.src.Components.highpass_filter.HighpassFilter:
CompoundPye.src.Components.highpass_filter.HighpassFilter2

Public Member Functions

def __init__
 Initializes a HighpassFilter object. More...
 
def update
 Updates the Component. More...
 

Public Attributes

 input_pre
 In addition to a normal Component's variables, a HighpassFilter requires the previous input value for an update. More...
 

Detailed Description

Component with a predefined transfer function turning it into a high-pass filter.

It's probably better if time_const_output is of the same order as dt.

Todo:
Investigate the influence of time_const_output. Should I rather set it to dt, such that dt/time_const=1?

Constructor & Destructor Documentation

def CompoundPye.src.Components.highpass_filter.HighpassFilter.__init__ (   self,
  time_const_RC,
  time_const_output,
  debug = False 
)

Initializes a HighpassFilter object.

Parameters
time_const_RCTime constant as in an electrical high-pass filter.
dtBased on wikipedia's description of a high-pass filter, the time-step dt is required for the transfer function.
debugSet False, if you don't want to see debugging output, set True if you want to see debugging output.

Member Function Documentation

def CompoundPye.src.Components.highpass_filter.HighpassFilter.update (   self,
  input,
  dt 
)

Updates the Component.

Similar to Component.update, but it additionally requires to store the current value in HighpassFilter.input_pre.

Member Data Documentation

CompoundPye.src.Components.highpass_filter.HighpassFilter.input_pre

In addition to a normal Component's variables, a HighpassFilter requires the previous input value for an update.


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