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

The basic Surroundings-class handles the surroundings of the agent. More...

Inherited by CompoundPye.src.Surroundings.video.VideoSurroundings.

Public Member Functions

def __init__
 Initializes a Surroundings-object. More...
 
def set_sensor
 PROBABLY NOT NECCESSARY HERE. More...
 
def add_stimulus
 Adds a new Stimulus to the list of stimuli. More...
 
def update
 Updates the Surroundings-object. More...
 
def update_one
 Updates the Surroundings-object (one-dimensional case). More...
 
def update_two
 Updates the Surroundings-object (two-dimensional case). More...
 

Public Attributes

 conversion
 conversion factor radian -> pixel More...
 

Detailed Description

The basic Surroundings-class handles the surroundings of the agent.

It stores information about stimuli that the agent can see.

Constructor & Destructor Documentation

def CompoundPye.src.Surroundings.surroundings.Surroundings.__init__ (   self,
  n_pixel,
  background = 0.0,
  intensity_dim = 1 
)

Initializes a Surroundings-object.

Parameters
n_pixelInteger or list of integers specifying the number of pixels of the surroundings.
intensity_dimNEEDS SOME EXPLANATION THAT MAKES SENSE! Dimension of the surroundings, either one or two (the surroundings is actually thought of as a projection of the n-dim. surroundings to an (n-1)-dimensional hyper-plane, which is why the its dimension < 3.

Member Function Documentation

def CompoundPye.src.Surroundings.surroundings.Surroundings.add_stimulus (   self,
  stimulus_class,
  object_params,
  object_params_dict 
)

Adds a new Stimulus to the list of stimuli.

Parameters
stimulus_classA class to create the new Stimulus-object.
object_paramsList of parameters to pass on to the constructor of the class.
object_params_dictDictionary of keyword-parameters to pass on to the constructor of the class.
def CompoundPye.src.Surroundings.surroundings.Surroundings.set_sensor (   self,
  sensor,
  center,
  filter_func,
  filter_params = [],
  filter_kw_params = {} 
)

PROBABLY NOT NECCESSARY HERE.

Todo:
check whether this function is ever used, or it MotionDetectorModel.Sensors.sensor.Sensor.set_receptive_field is always used directly.
def CompoundPye.src.Surroundings.surroundings.Surroundings.update (   self,
  dt 
)

Updates the Surroundings-object.

Actual update happens in function Surroundings.update_one or Surroundings.update_two, depending on the input dimension of the Surroundings-object.

Parameters
dtTime-step of the update.
def CompoundPye.src.Surroundings.surroundings.Surroundings.update_one (   self,
  dt 
)

Updates the Surroundings-object (one-dimensional case).

Parameters
dtTime-step of the update.
def CompoundPye.src.Surroundings.surroundings.Surroundings.update_two (   self,
  dt 
)

Updates the Surroundings-object (two-dimensional case).

Parameters
dtTime-step of the update.

Member Data Documentation

CompoundPye.src.Surroundings.surroundings.Surroundings.conversion

conversion factor radian -> pixel


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