Changeset 318

Show
Ignore:
Timestamp:
11/11/08 12:16:28 (2 months ago)
Author:
bruederle
Message:

added module docstring according to Pierre's formatting instructions

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/src/plotting.py

    r304 r318  
    11""" 
    2 plotting.py 
    3  
    4 Routines and classes that make plotting and image processing  
    5 with Matplotlib and the Python Imaging Library (PIL) easier. 
     2NeuroTools.plotting 
     3=================== 
     4 
     5This module contains a collection of tools for plotting and image processing that  
     6shall facilitate the generation and handling of NeuroTools data visualizations. 
     7It utilizes the Matplotlib and the Python Imaging Library (PIL) packages. 
     8 
     9 
     10Classes 
     11------- 
     12 
     13SimpleMultiplot     - object that creates and handles a figure consisting of multiple panels, all with the same datatype and the same x-range. 
     14 
     15 
     16Functions 
     17--------- 
     18 
     19get_display         - returns a pylab object with a plot() function to draw the plots. 
     20progress_bar        - prints a progress bar to stdout, filled to the given ratio. 
     21pylab_params        - returns a dictionary with a set of parameters that help to nicely format figures by updating the pylab run command parameters dictionary 'pylab.rcParams'. 
     22set_axis_limits     - defines the axis limits in a plot. 
     23set_labels          - defines the axis labels of a plot. 
     24set_pylab_params    - updates a set of parameters within the the pylab run command parameters dictionary 'pylab.rcParams' in order to achieve nicely formatted figures. 
     25save_2D_image       - saves a 2D numpy array of gray shades between 0 and 1 to a PNG file. 
     26save_2D_movie       - saves a list of 2D numpy arrays of gray shades between 0 and 1 to a zipped tree of PNG files. 
    627""" 
    7  
    828 
    929import sys, numpy