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

The basic Surroundings-class to create one dimensional Surroundings-objects, which handles the 'Surroundings of the motion detector'. More...

Public Member Functions

def __init__
 Creates a OneDim-object. More...
 
def set_sensor
 Sets a Sensor's receptive field to given angles. More...
 
def update
 Updates the agent's Surroundings, that is, it updates all stimuli stored in OneDim.stimuli. More...
 
def add_stimulus
 Adds a new Stimulus to the list of stimuli. More...
 

Detailed Description

The basic Surroundings-class to create one dimensional Surroundings-objects, which handles the 'Surroundings of the motion detector'.

A Surroundings-object is the tool to handle the Surroundings of the motion detector. It holds 'the world' that Sensors of a Circuit/network can see. It stores Stimuli and from them calculates the intensities at each pixel of the Surroundings. The Surroundings are thought of as indeed surrounding the agent, so sometimes angles are used to specify a location in the Surroundings (from 0 to 360 degree in the one dimensional case).

Constructor & Destructor Documentation

def CompoundPye.src.Surroundings.one_dim.OneDim.__init__ (   self,
  n_pixel = 2**10,
  intensity_dimension = 1 
)

Creates a OneDim-object.

Parameters
n_pixelNumber of pixels of the Surroundings.
intensity_dimensionDimension of the intensities, e.g. 1 for bright-dark or 3 for RGB colored Stimuli.

Member Function Documentation

def CompoundPye.src.Surroundings.one_dim.OneDim.add_stimulus (   self,
  object,
  object_params,
  object_params_dict 
)

Adds a new Stimulus to the list of stimuli.

Parameters
objectA 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.one_dim.OneDim.set_sensor (   self,
  sensor,
  phi_min,
  phi_max 
)

Sets a Sensor's receptive field to given angles.

Parameters
sensorSensor-object of which the receptive field should be set.
phi_minMinimum angle of the Surroundings that can be observed by the Sensor.
phi_minMaximum angle of the Surroundings that can be observed by the Sensor.
def CompoundPye.src.Surroundings.one_dim.OneDim.update (   self,
  dt 
)

Updates the agent's Surroundings, that is, it updates all stimuli stored in OneDim.stimuli.

Parameters
dtTime step for the update.

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