summaryrefslogtreecommitdiff
path: root/doc/pyspike.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/pyspike.rst')
-rw-r--r--doc/pyspike.rst58
1 files changed, 35 insertions, 23 deletions
diff --git a/doc/pyspike.rst b/doc/pyspike.rst
index 6aa36e7..74ab439 100644
--- a/doc/pyspike.rst
+++ b/doc/pyspike.rst
@@ -1,60 +1,72 @@
pyspike package
===============
-Submodules
-----------
-pyspike.isi_distance module
+Classes
----------------------------------------
-.. automodule:: pyspike.isi_distance
+SpikeTrain
+........................................
+.. automodule:: pyspike.SpikeTrain
:members:
:undoc-members:
:show-inheritance:
-pyspike.spike_distance module
-----------------------------------------
-
-.. automodule:: pyspike.spike_distance
+PieceWiseConstFunc
+........................................
+.. automodule:: pyspike.PieceWiseConstFunc
:members:
:undoc-members:
:show-inheritance:
-pyspike.spike_sync module
-----------------------------------------
+PieceWiseLinFunc
+........................................
+.. automodule:: pyspike.PieceWiseLinFunc
+ :members:
+ :undoc-members:
+ :show-inheritance:
-.. automodule:: pyspike.spike_sync
+DiscreteFunc
+........................................
+.. automodule:: pyspike.DiscreteFunc
:members:
:undoc-members:
:show-inheritance:
-pyspike.PieceWiseConstFunc module
-----------------------------------------
+Functions
+----------
-.. automodule:: pyspike.PieceWiseConstFunc
+ISI-distance
+........................................
+.. automodule:: pyspike.isi_distance
:members:
:undoc-members:
:show-inheritance:
-pyspike.PieceWiseLinFunc module
-----------------------------------------
-
-.. automodule:: pyspike.PieceWiseLinFunc
+SPIKE-distance
+........................................
+.. automodule:: pyspike.spike_distance
:members:
:undoc-members:
:show-inheritance:
-pyspike.DiscreteFunc module
-----------------------------------------
+SPIKE-synchronization
+........................................
+.. automodule:: pyspike.spike_sync
+ :members:
+ :undoc-members:
+ :show-inheritance:
-.. automodule:: pyspike.DiscreteFunc
+PSTH
+........................................
+.. automodule:: pyspike.psth
:members:
:undoc-members:
:show-inheritance:
-pyspike.spikes module
-----------------------------------------
+Helper functions
+........................................
.. automodule:: pyspike.spikes
:members:
:undoc-members: