Changeset 304

Show
Ignore:
Timestamp:
11/07/08 16:07:32 (2 months ago)
Author:
pierre
Message:

Minors typo bugs in the docstrings. Remove some useless blank lines, and the import of utilities in the init file since utilities.py has been removed

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/src/__init__.py

    r302 r304  
    1 __all__ = ['analysis', 'parameters', 'plotting', 'sandbox', 'signals', 'stgen', 'utilities', 'io'] 
     1__all__ = ['analysis', 'parameters', 'plotting', 'sandbox', 'signals', 'stgen', 'io'] 
    22 
    33######################################################### 

  • trunk/src/plotting.py

    r298 r304  
    8080        useTex         - enables or disables the use of LaTeX for all labels and texts 
    8181                         (for details on how to do that, see http://www.scipy.org/Cookbook/Matplotlib/UsingTex). 
    82  
    8382    """ 
    8483    inches_per_pt = 1.0/72.27               # Convert pt to inch 
    …… 
    154153        useTex         - enables or disables the use of LaTeX for all labels and texts 
    155154                         (for details on how to do that, see http://www.scipy.org/Cookbook/Matplotlib/UsingTex) 
    156  
    157155    """ 
    158156    pylab.rcParams.update(pylab_params(fig_width_pt=fig_width_pt, ratio=ratio, text_fontsize=text_fontsize, \ 

  • trunk/src/signals.py

    r302 r304  
    5555        See also 
    5656            SpikeTrain 
    57  
    5857        """ 
    5958 
    …… 
    270269        See also 
    271270            isi 
    272  
    273271        """ 
    274272        isi = self.isi() 
    …… 
    308306        See also 
    309307            time_histogram 
    310  
    311308        """ 
    312309        if newnum: 
    …… 
    613610    See also 
    614611        load_spikelist 
    615  
    616612    """ 
    617613    ####################################################################### 
    …… 
    11651161        See also: 
    11661162            cv_isi, cv_isi_hist, cv_local 
    1167          
    11681163        """ 
    11691164         
    …… 
    12161211        See also 
    12171212            cv_isi, cv_isi_hist, cv_kl 
    1218          
    12191213        """ 
    12201214        if t_start == None: 
    …… 
    17101704                      if None, this is the one calling the function 
    17111705            cost    - The cost parameter. See the paper for more informations. BY default, set to 0.5 
    1712  
    17131706        """ 
    17141707        if spklist == None: 
    …… 
    20822075    See also 
    20832076        AnalogSignalList, load_currentlist, load_vmlist, load_conductancelist, load 
    2084  
    20852077    """ 
    20862078    def __init__(self, signal, dt, t_start=None, t_stop=None): 
    …… 
    22172209            t_start - begining of the new SpikeTrain, in ms. 
    22182210            t_stop  - end of the new SpikeTrain, in ms. 
    2219  
    22202211        """ 
    22212212        signal = self.signal[numpy.floor(t_start/self.dt):numpy.floor(t_stop/self.dt)] 
    …… 
    22782269            >> vm.event_triggered_average(spktrain, average=True) 
    22792270            >> vm.event_triggered_average(range(0,1000,10), average=False, display=True) 
    2280          
    22812271        """ 
    22822272         
    …… 
    23922382    See also 
    23932383        load_currentlist load_vmlist, load_conductancelist 
    2394  
    23952384    """ 
    23962385    def __init__(self, signals, id_list, dt, t_start=None, t_stop=None, dims=None): 
    …… 
    27252714            >> vmlist.event_triggered_average(spikelist, average=True, mode = 'all') 
    27262715            >> vmlist.event_triggered_average({'1':[200,300,'3':[234,788]]}, average=False, display=True) 
    2727          
    27282716        """ 
    27292717        if isinstance(eventdict, SpikeList): 
    …… 
    30133001    See also: 
    30143002        load_spikelist, load_conductancelist, load_vmlist, load_currentlist 
    3015      
    30163003    """ 
    30173004    if datatype == 's': 

  • trunk/src/stgen.py

    r302 r304  
    1616 
    1717    Inputs: 
    18         x   - unit in seconds 
    19         b   - units in seconds 
     18        x   - in units of seconds 
    2019        a   - dimensionless 
    21      
     20        b   - in units of seconds 
    2221    """ 
    2322 
    …… 
    6160        Examples: 
    6261            >> x = StGen() 
    63  
    6462        """ 
    6563 
    …… 
    129127 
    130128        Inputs: 
     129            rate   - an array of the rates (Hz) where rate[i] is active on interval  
     130                     [t[i],t[i+1]] 
    131131            t      - an array specifying the time bins (in milliseconds) at which to  
    132132                     specify the rate 
    133             rate   - an array of the rates (Hz) where rate[i] is active on interval  
    134                      [t[i],t[i+1]] 
    135             t_stop - lenght of time to simulate process (in ms) 
     133            t_stop - length of time to simulate process (in ms) 
    136134            array  - if True, a numpy array of sorted spikes is returned, 
    137135                     rather than a SpikeList object. 
    …… 
    192190 
    193191        Inputs: 
     192            a,b    - arrays of the parameters of the gamma PDF where a[i] and b[i]  
     193                     will be active on interval [t[i],t[i+1]] 
    194194            t      - an array specifying the time bins (in milliseconds) at which to  
    195195                     specify the rate 
    196             a,b    - arrays of the parameters of the gamma PDF where a[i] and b[i]  
    197                      will be active on interval [t[i],t[i+1]] 
    198             t_stop - lenght of time to simulate process (in ms) 
     196            t_stop - length of time to simulate process (in ms) 
    199197            array  - if True, a numpy array of sorted spikes is returned, 
    200198                     rather than a SpikeList object. 
    …… 
    202200        Note:  
    203201            t_start=t[0] 
    204             a is a dimensionless quantity >0, but typically on the order of 2-10.  
     202            a is a dimensionless quantity > 0, but typically on the order of 2-10.  
    205203            a = 1 results in a poisson process. 
    206204            b is assumed to be in units of 1/Hz (seconds). 
    …… 
    218216        See also: 
    219217            inh_poisson_generator, gamma_hazard 
    220  
    221218        """ 
    222219