summaryrefslogtreecommitdiff
path: root/doc/pyspike.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/pyspike.rst')
-rw-r--r--doc/pyspike.rst79
1 files changed, 79 insertions, 0 deletions
diff --git a/doc/pyspike.rst b/doc/pyspike.rst
new file mode 100644
index 0000000..3b10d2a
--- /dev/null
+++ b/doc/pyspike.rst
@@ -0,0 +1,79 @@
+pyspike package
+===============
+
+
+Classes
+----------------------------------------
+
+SpikeTrain
+........................................
+.. automodule:: pyspike.SpikeTrain
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+PieceWiseConstFunc
+........................................
+.. automodule:: pyspike.PieceWiseConstFunc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+PieceWiseLinFunc
+........................................
+.. automodule:: pyspike.PieceWiseLinFunc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+DiscreteFunc
+........................................
+.. automodule:: pyspike.DiscreteFunc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Functions
+----------
+
+ISI-distance
+........................................
+.. automodule:: pyspike.isi_distance
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SPIKE-distance
+........................................
+.. automodule:: pyspike.spike_distance
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SPIKE-synchronization
+........................................
+.. automodule:: pyspike.spike_sync
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+PSTH
+........................................
+.. automodule:: pyspike.psth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Directionality
+........................................
+.. automodule:: pyspike.spike_directionality
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Helper functions
+........................................
+.. automodule:: pyspike.spikes
+ :members:
+ :undoc-members:
+ :show-inheritance: