CompoundPye  0.93
Modelling and Simulation Framework for Neural Networks of Arthropod Compound Eyes
 All Classes Namespaces Functions Variables Pages
CompoundPye.src.Surroundings.Stimuli.stimulus.Stimulus Class Reference

The basic Stimulus class, which can be used to add a Stimulus to a Surrounding-object. More...

Inheritance diagram for CompoundPye.src.Surroundings.Stimuli.stimulus.Stimulus:
CompoundPye.src.Surroundings.Stimuli.one_dim_box.OneDimBox CompoundPye.src.Surroundings.Stimuli.one_dim_sine.OneDimSine

Public Member Functions

def __init__
 Initializes a Stimulus object. More...
 
def update
 Updates the Stimulus, that is, the Stimulus moves according to its velocity. More...
 

Detailed Description

The basic Stimulus class, which can be used to add a Stimulus to a Surrounding-object.

The user can specify the spatial extend or length of the Stimulus, which creates an array empty array of specified length/extend. This array can be filled with arbitrary values representing the visual intensities of the Stimulus. The array will be added to the intensities stored in a Surroundings-object. The Stimulus moves in the Surroundings according to the specified velocity.

Constructor & Destructor Documentation

def CompoundPye.src.Surroundings.Stimuli.stimulus.Stimulus.__init__ (   self,
  intensity_dim,
  spatial_extend,
  starting_point,
  velocity 
)

Initializes a Stimulus object.

Parameters
intensity_dimDimension of the intensity, e.g. 1 for a bright-dark Stimulus or 3 for a RGB colored Stimulus.
starting_pointIndex of the left-most pixel of the stimulus.
velocityStimulus velocity in pixel/time unit.

Member Function Documentation

def CompoundPye.src.Surroundings.Stimuli.stimulus.Stimulus.update (   self,
  dt 
)

Updates the Stimulus, that is, the Stimulus moves according to its velocity.

Parameters
dtTime step for the update.

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