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

OneDimSine is a Stimulus with a predefined sine-shape of given length. More...

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

Public Member Functions

def __init__
 Initializes a OneDimSine-object. More...
 
- Public Member Functions inherited from CompoundPye.src.Surroundings.Stimuli.stimulus.Stimulus
def __init__
 Initializes a Stimulus object. More...
 
def update
 Updates the Stimulus, that is, the Stimulus moves according to its velocity. More...
 

Detailed Description

OneDimSine is a Stimulus with a predefined sine-shape of given length.

The user can specify the length, starting point, velocity and some sine specific parameters when creating an object of this class. Spatial values need to be specified in pixels of the Surrouding's intensities-array (see MotionDetectorModel.Surroundings.one_dim.OneDim.intensities).

Constructor & Destructor Documentation

def CompoundPye.src.Surroundings.Stimuli.one_dim_sine.OneDimSine.__init__ (   self,
  length,
  starting_point,
  velocity,
  n_periods = 1.,
  amplitude = .5,
  phase_shift = 0.0,
  offset = .5 
)

Initializes a OneDimSine-object.

Parameters
lengthLength of the sine-wave in pixels.
starting_pointIndex of the left-most pixel of the stimulus.
velocityStimulus velocity in pixel/time unit.
n_periodsNumber of periods in the length of the stimulus.
amplitudeAmplitude of the sine-wave.
phase_shiftInitial phase shift (if you do not want the sine-wave to start at sin(0)).
offsetOffset that is added to the sine function.

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