Changeset 313 for trunk/src/signals.py

Timestamp:

11/10/08 14:37:36 (4 years ago)

Author:

pierre

Message:

Module docstrings for io, and fix the cv ticket

Files:

• trunk/src/signals.py (modified) (4 diffs)

trunk/src/signals.py

@@ -9 +9 @@
 -------
 
-SpikeTrain       - An object representing a spike train, for one cell. Useful for plots, 
+SpikeTrain       - object representing a spike train, for one cell. Useful for plots, 
                    calculations such as ISI, CV, mean rate(), ...
-SpikeList        - An object representing the activity of a population of neurons. Functions as a
+SpikeList        - object representing the activity of a population of neurons. Functions as a
                    dictionary of SpikeTrain objects, with methods to compute firing rate,
                    ISI, CV, cross-correlations, and so on. 
-AnalogSignal     - An object representing an analog signal, with its data. Can be used to do 
+AnalogSignal     - object representing an analog signal, with its data. Can be used to do 
                    threshold detection, event triggered averages, ...
-AnalogSignalList - A list of AnalogSignal objects, again with methods such as mean, std, plot, 
+AnalogSignalList - list of AnalogSignal objects, again with methods such as mean, std, plot, 
                    and so on
-VmList           - An AnalogSignalList object used for Vm traces
-ConductanceList  - An AnalogSignalList object used for conductance traces
-CurrentList      - An AnalogSignalList object used for current traces
+VmList           - AnalogSignalList object used for Vm traces
+ConductanceList  - AnalogSignalList object used for conductance traces
+CurrentList      - AnalogSignalList object used for current traces
 
 Functions
@@ -28 +28 @@
                        Can also load data in a different format, but then you have
                        to write your own File object that will know how to read the data (see io.py)
-load_vmlist          - Function to load a VmList object (inherits from AnalogSignalList) from a file.
+load_vmlist          - function to load a VmList object (inherits from AnalogSignalList) from a file.
                        Same comments on format as previously.
-load_currentlist     - Function to load a CurrentList object (inherits from AnalogSignalList) from a file.
+load_currentlist     - function to load a CurrentList object (inherits from AnalogSignalList) from a file.
                        Same comments on format as previously.
-load_conductancelist - Function to load a ConductanceList object (inherits from AnalogSignalList) from a file.
+load_conductancelist - function to load a ConductanceList object (inherits from AnalogSignalList) from a file.
                        Same comments on format as previously. load_conductancelist returns two 
                        ConductanceLists, one for the excitatory conductance and one for the inhibitory conductance
-load                 - A generic loader for all the previous load methods.
+load                 - a generic loader for all the previous load methods.
 """
 
@@ -308 +308 @@
             return numpy.std(isi)/numpy.mean(isi)
         else:
-            raise Exception("No spikes in the SpikeTrain !")
+            print "Warning, a CV can't be computed because there are not enough spikes"
+            return nan
 
     def fano_factor_isi(self):
@@ -1132 +1133 @@
             cv_isi_hist, cv_local, cv_kl
         """
-        cvs_isi = []
+        cvs_isi = numpy.empty(self.N)
         for id in self.id_list():
-            isi = self.spiketrains[id].isi()
-            if len(isi) > 1:
-                cvs_isi.append(numpy.std(isi)/numpy.mean(isi))
-        if len(cvs_isi) > 0:
-            return numpy.array(cvs_isi)
-        else:
-            raise Exception("No isi can be computed in the SpikeList !")
+            cvs_isi[id] = self.spiketrains[id].cv_isi()
+        return cvs_isi
+