Changeset 319

Timestamp:

11/11/08 12:32:37 (2 months ago)

Author:

bruederle

Message:

inserted some examples into plotting docstrings

Files:

• trunk/src/plotting.py (modified) (5 diffs)

trunk/src/plotting.py

@@ -75 +75 @@
-    Inputs:
-        progress - a float between 0. and 1.
+        
+    Example:
+        >> progress_bar(0.7)
+            |===================================               |
-    """
-    progressConditionStr = "ERROR: The argument of function NeuroTools.plotting.progress_bar(...) must be a float between 0. and 1.!"
@@ -126 +130 @@
-        xmin, xmax  - the limits of the x axis
-        ymin, ymax  - the limits of the y axis
+        
+    Example:
+        >> x = range(10)
+        >> y = []
+        >> for i in x: y.append(i*i)
+        >> pylab.plot(x,y)
+        >> plotting.set_axis_limits(pylab, 0., 10., 0., 100.)
-    """
-    if hasattr(subplot, 'xlim'):
@@ -146 +157 @@
-        xlabel  - a string for the x label
-        ylabel  - a string for the y label
+        
+    Example:
+        >> x = range(10)
+        >> y = []
+        >> for i in x: y.append(i*i)
+        >> pylab.plot(x,y)
+        >> plotting.set_labels(pylab, 'x', 'y=x^2')
-    """
-    if hasattr(subplot, 'xlabel'):
@@ -192 +210 @@
-        mat      - a 2D numpy array of floats between 0 and 1
-        filename - string specifying the filename where to save the data, has to end on '.png'
+    
+    Example:
+        >> import numpy
+        >> a = numpy.random.random([100,100]) # creates a 2D numpy array with random values between 0. and 1.
+        >> save_2D_image(a,'randomarray100x100.png')
-    """
-    assert PILIMAGEUSE, "ERROR: Since PIL has not been detected, the function NeuroTools.plotting.save_2D_image(...) is not supported!"
@@ -215 +238 @@
-        filename       - string specifying the filename where to save the data, has to end on '.zip'
-        frame_duration - specifier for the duration per frame, will be stored as additional meta-data
+        
+    Example:
+        >> import numpy
+        >> framelist = []
+        >> for i in range(100): framelist.append(numpy.random.random([100,100])) # creates a list of 2D numpy arrays with random values between 0. and 1.
+        >> save_2D_movie(framelist, 'randommovie100x100x100.zip', 0.1)
-    """
-    try: