Changeset 463 for trunk

Timestamp:

09/02/10 15:48:38 (21 months ago)

Author:

pierre

Message:

Fix documentation of the gamma_generator function

Files:

• trunk/src/stgen.py (modified) (3 diffs)

trunk/src/stgen.py

@@ -257 +257 @@
     def gamma_generator(self, a, b, t_start=0.0, t_stop=1000.0, array=False,debug=False):
         """
-        Returns a SpikeTrain whose spikes are a realization of a Poisson process
-        with the given rate (Hz) and stopping time t_stop (milliseconds).
+        Returns a SpikeTrain whose spikes are a realization of a gamma process
+        with the given shape a, b and stopping time t_stop (milliseconds). 
+        (average rate will be a*b)
 
         Note: t_start is always 0.0, thus all realizations are as if 
@@ -271 +272 @@
 
         Examples:
-            >> gen.poisson_generator(50, 0, 1000)
-            >> gen.poisson_generator(20, 5000, 10000, array=True)
+            >> gen.gamma_generator(10, 1/10., 0, 1000)
+            >> gen.gamma_generator(20, 1/5., 5000, 10000, array=True)
          
         See also:
@@ -465 +466 @@
             # find index in "t" time
             t_i = numpy.searchsorted(t[t_i:],ps[i],'right')-1+t_i
-            if rn[i]<gamma_hazard_scipy((ps[i]-t_last)/1000.0,a[t_i],b[t_i])/rmax:
+            if rn[i]<gamma_hazard((ps[i]-t_last)/1000.0,a[t_i],b[t_i])/rmax:
                 # keep spike
                 t_last = ps[i]