Changeset 6245 for misc/tools/plotcsv

Timestamp:

Jan 30, 2009, 1:11:57 PM (16 years ago)

Author:

rwilson

Message:

Improved the 'call from code' interface.

File:

• misc/tools/plotcsv/plotcsv.py (modified) (12 diffs)

misc/tools/plotcsv/plotcsv.py

@@ -1 +1 @@
 #!/usr/bin/env python
 
-'''A module to draw a graph on the screen given a data file.'''
+'''A module to draw a graph on the screen given a data file.
+
+The code is written such that it may be run as a program or imported
+and used as a module.
+'''
 
 import sys
@@ -9 +13 @@
 import time
 import getopt
-try:
-    import pylab
-except:
-    print 'Sorry, you have to install python-matplotlib'
-    sys.exit(10)
+import pylab
 
 
@@ -22 +22 @@
 Y_RANGE = 'y_range'
 FILENAME = 'filename'
+SIZE = 'size'
 TITLE = 'title'
 X_LABEL = 'x_label'
@@ -41 +42 @@
 # @param options A dictionary of plot options.
 def plot_data(x_data, y_data, options):
-    pylab.plot(x_data, y_data)  # x, y
+    pylab.plot(x_data, y_data)
     pylab.title(options.get(TITLE, ''))
     pylab.grid(True)
@@ -66 +67 @@
 # @param options A dictionary of options.
 def plot_file(filename, options=None):
+    # set options defaults
+    opts = options
+    if opts is None:
+        opts = {}
+
+    opts[X_DATACOL] = opts.get(X_DATACOL, '0')
+    opts[Y_DATACOL] = opts.get(Y_DATACOL, '1')
+    opts[SIZE] = opts.get(SIZE, '800,600')
+    opts[Y_RANGE] = opts.get(Y_RANGE, None)
+
     # get contents of data file
     # after this, 'header' is list of column header strings
@@ -80 +91 @@
     # convert column specifiers to 'int' if required
     try:
-        index = int(options[X_DATACOL])
+        index = int(opts[X_DATACOL])
     except:
         try:
-            index = header.index(options[X_DATACOL])
+            index = header.index(opts[X_DATACOL])
         except ValueError:
-            error("Sorry, X column header '%s' isn't in the data file." % options[X_DATACOL])
-    options[X_DATACOL] = index
+            error("Sorry, X column header '%s' isn't in the data file." % opts[X_DATACOL])
+    opts[X_DATACOL] = index
 
     try:
-        index = int(options[Y_DATACOL])
+        index = int(opts[Y_DATACOL])
     except:
         try:
-            index = header.index(options[Y_DATACOL])
+            index = header.index(opts[Y_DATACOL])
         except ValueError:
-            error("Sorry, Y column header '%s' isn't in the data file." % options[Y_DATACOL])
-    options[Y_DATACOL] = index
+            error("Sorry, Y column header '%s' isn't in the data file." % opts[Y_DATACOL])
+    opts[Y_DATACOL] = index
     
     # extract required columns from the data
-    x_col = options[X_DATACOL]
-    y_col = options[Y_DATACOL]
+    x_col = opts[X_DATACOL]
+    y_col = opts[Y_DATACOL]
 
     # get max column number, check requested columns
@@ -114 +125 @@
     y_label = header[y_col].title()
 
-    options[TITLE] = 'File: %s' % filename
-    options[X_LABEL] = x_label
-    options[Y_LABEL] = y_label
+    opts[TITLE] = 'File: %s' % filename
+    opts[X_LABEL] = x_label
+    opts[Y_LABEL] = y_label
 
-    plot_data(x_data, y_data, options)
+    plot_data(x_data, y_data, opts)
 
 
@@ -131 +142 @@
     print '                   -v <range>   force a range in Y axis values, of the form'
     print '                                    <min>,<max>, eq, "-5,10"'
-    print '                   -h           prints this help'
+    print '                   -s <min,max> sets PNG output picture size'
     sys.exit(10)
 
@@ -138 +149 @@
     of_dict = { '-x': X_DATACOL,
                 '-y': Y_DATACOL,
+                '-s': SIZE,
                 '-v': Y_RANGE }
 
@@ -150 +162 @@
     opt_dict = {}
     params = sys.argv[1:]
-    (opts, args) = getopt.gnu_getopt(params, 'x:y:v:h')
+    (opts, args) = getopt.gnu_getopt(params, 'x:y:s:v:')
     if len(args) != 1:
         usage()
@@ -160 +172 @@
 
     # get name of data file
+    if len(args) != 1:
+        usage()
     filename = args[0]
     (filename_minus, _) = filename.split('.', 1)
@@ -166 +180 @@
     opt_dict[X_DATACOL] = opt_dict.get(X_DATACOL, 0)
     opt_dict[Y_DATACOL] = opt_dict.get(Y_DATACOL, 1)
+    opt_dict[SIZE] = opt_dict.get(SIZE, '800,600')
+#    opt_dict[X_RANGE] = opt_dict.get(X_RANGE, None)
     opt_dict[Y_RANGE] = opt_dict.get(Y_RANGE, None)
     opt_dict[FILENAME] = filename_minus
 
     # plot the file
-    plot_file(filename, opt_dict)
+    plot_file(args[0], opt_dict)