Changeset 313 for trunk/src/io.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/io.py (modified) (1 diff)

trunk/src/io.py

@@ +1 @@
+"""
+NeuroTools.io
+==================
+
+A collection of functions to handle all the inputs/outputs of the NeuroTools.signals
+file, used by the loaders.
+
+Classes
+-------
+
+FileHandler        - abstract class which should be overriden, managing how a file will load/write
+                     its data
+StandardTextFile   - object used to manipulate text representation of NeuroTools objects (spikes or
+                     analog signals)
+StandardPickleFile - object used to manipulate pickle representation of NeuroTools objects (spikes or
+                     analog signals)
+DataHandler        - object to establish the interface between NeuroTools.signals and NeuroTools.io
+
+All those objects can be used with NeuroTools.signals
+
+    >> data = StandardTextFile("my_data.dat")
+    >> spikes = load(data,'s')
+"""
+
+
 from NeuroTools import check_dependency