r10807 - /1.3/generic_fns/grace.py -- February 22, 2010 - 11:15

Author: bugman
Date: Mon Feb 22 11:15:09 2010
New Revision: 10807

URL: http://svn.gna.org/viewcvs/relax?rev=10807&view=rev
Log:
The graph title and subtitle can be specified in write_xy_header().


Modified:
    1.3/generic_fns/grace.py

Modified: 1.3/generic_fns/grace.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/grace.py?rev=10807&r1=10806&r2=10807&view=diff
==============================================================================
--- 1.3/generic_fns/grace.py (original)
+++ 1.3/generic_fns/grace.py Mon Feb 22 11:15:09 2010
@@ -379,7 +379,7 @@
             file.write("&\n")
 
 
-def write_xy_header(file=None, paper_size='A4', sets=1, set_names=None, 
set_colours=None, symbols=None, symbol_sizes=None, linestyle=None, 
data_type=None, seq_type=None, axis_labels=None, axis_min=None, 
axis_max=None, legend_pos=None, legend=False, norm=False):
+def write_xy_header(file=None, paper_size='A4', title=None, subtitle=None, 
sets=1, set_names=None, set_colours=None, symbols=None, symbol_sizes=None, 
linestyle=None, data_type=None, seq_type=None, axis_labels=None, 
axis_min=None, axis_max=None, legend_pos=None, legend=False, norm=False):
     """Write the grace header for xy-scatter plots.
 
     Many of these keyword arguments should be supplied in a [X, Y] list 
format, where the first element corresponds to the X data, and the second the 
Y data.  Defaults will be used for any non-supplied args (or lists with 
elements set to None).
@@ -389,6 +389,10 @@
     @type file:                     file object
     @keyword paper_size:            The paper size, i.e. 'A4'.  If set to 
None, this will default to letter size.
     @type paper_size:               str
+    @keyword title:                 The title of the graph.
+    @type title:                    None or str
+    @keyword subtitle:              The sub-title of the graph.
+    @type subtitle:                 None or str
     @keyword sets:                  The number of data sets in the graph G0.
     @type sets:                     int
     @keyword set_names:             The names associated with each graph 
data set G0.Sx.  For example this can be a list of spin identification 
strings.
@@ -438,6 +442,12 @@
     # Graph G0.
     file.write("@with g0\n")
 
+    # The title and subtitle.
+    if title:
+        file.write("@    title \"%s\"\n" % title)
+    if subtitle:
+        file.write("@    subtitle \"%s\"\n" % subtitle)
+
     # Axis specific settings.
     axes = ['x', 'y']
     for i in range(2):