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

Basic component class. More...

Inheritance diagram for CompoundPye.src.Components.component.Component:
CompoundPye.src.Components.component.Component2 CompoundPye.src.Components.linear_input_filter.LinearInputFilter

Public Member Functions

def __init__
 Initializes a Component-object. More...
 
def update
 Updates the Component's internal value and output based on the provided input. More...
 
def get_output
 Returns Component.output . More...
 
def add_connection
 Adds a connections to the Component's list of connections. More...
 

Public Attributes

 value
 Current internal value. More...
 
 output
 Current output of the object, calculated using the object's transfer function Component.activation_func and its internal value Component.value as the function's input. More...
 
 activation_func
 Transfer function of the Component-object. More...
 
 param
 List of parameters for the object's transfer function Component.activation_func. More...
 
 time_const_output
 The Component's time constant, which specifies how much of its previous Component.value remains after each update step. More...
 
 label
 
 attributes
 assign attributes to the neuron, e.g. More...
 
 next_neighbour_single_time
 create only once per pairs of neighbours, True or False More...
 

Detailed Description

Basic component class.

A Component-object is a basic building block of a circuit. It has a list of connections, which contains connections to other Component-objects. Based on the connections between components of a circuit/network, the Circuit-object calculates the input to each Component during one update step. The Component uses the input to update its internal value/membrane potential (self.value). It generates an output based on self.value using its Component.activation_func .

Constructor & Destructor Documentation

def CompoundPye.src.Components.component.Component.__init__ (   self,
  activation_function,
  function_parameters = [],
  time_const_input = 0.05,
  time_const_output = 0.05,
  debug = False 
)

Initializes a Component-object.

Parameters
activation_functionTransfer function that is to be used to generate the Component's output Component.output from its internal value Component.value .
function_parametersList of parameters for the Component's transfer function Component.activation_func .
time_constTime constant, see Component.time_const .
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.component.Component.add_connection (   self,
  weight,
  target 
)

Adds a connections to the Component's list of connections.

Parameters
weightStrength of the connection.
targetTarget of the connections (has to be a Component-object).
def CompoundPye.src.Components.component.Component.get_output (   self)

Returns Component.output .

def CompoundPye.src.Components.component.Component.update (   self,
  input,
  dt 
)

Updates the Component's internal value and output based on the provided input.

Parameters
inputInput used for update.
dtTime step for the update

Member Data Documentation

CompoundPye.src.Components.component.Component.activation_func

Transfer function of the Component-object.

CompoundPye.src.Components.component.Component.attributes

assign attributes to the neuron, e.g.

axis:horizontal or axis:vertical, direction:positive or direction:negative (probably required for further connection)

CompoundPye.src.Components.component.Component.label
Note
changed self.tag to self.label –> any errors?
CompoundPye.src.Components.component.Component.next_neighbour_single_time

create only once per pairs of neighbours, True or False

CompoundPye.src.Components.component.Component.output

Current output of the object, calculated using the object's transfer function Component.activation_func and its internal value Component.value as the function's input.

CompoundPye.src.Components.component.Component.param

List of parameters for the object's transfer function Component.activation_func.

CompoundPye.src.Components.component.Component.time_const_output

The Component's time constant, which specifies how much of its previous Component.value remains after each update step.

CompoundPye.src.Components.component.Component.value

Current internal value.


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