← Back to branch summary

~ubuntu-branches/ubuntu/trusty/python-gnuplot/trusty

« back to all changes in this revision

Viewing changes to doc/_Gnuplot.py_Gnuplot.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2002-04-11 08:52:48 UTC
  • Revision ID: james.westby@ubuntu.com-20020411085248-r5kbl460aa2g9kdb
Tags: upstream-1.5
Import upstream version 1.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/_Gnuplot.py_Gnuplot.html
 
1
<html>
 
2
 
 
3
        <head>
 
4
        <title>Class: Gnuplot</title>
 
5
        </head>
 
6
 
 
7
        <body bgcolor="#ffffff">
 
8
 
 
9
        <p><i><a href="index.html">Table of Contents</a></i></p>
 
10
        
 
11
        <table border="0" cellpadding="5" cellspacing="0" width="100%">
 
12
        <tr bgcolor="#88bbee">
 
13
            <th rowspan="2"
 
14
                valign="top"
 
15
                align="left"
 
16
                width="10%"><font color="#000000">Class: Gnuplot</font>
 
17
            </th>
 
18
            <th align="right"><font color="#000000">./_Gnuplot.py</font></th>
 
19
        </tr>
 
20
        <tr>
 
21
        <td>
 
22
        <dl><dt><p><strong>Interface to a gnuplot program.</strong><p>
 
23
</dt><dd><p>    A Gnuplot represents a higher-level interface to a gnuplot
 
24
    program.  It can plot 'PlotItem's, which represent each thing to
 
25
    be plotted on the current graph.  It keeps a reference to each of
 
26
    the <code>PlotItems</code> used in the current plot, so that they (and their
 
27
    associated temporary files) are not deleted prematurely.</p>
 
28
 
 
29
<p>    Members:</p>
 
30
<dl><dt>        <code>itemlist</code></dt><dd><p>a list of the PlotItems that are associated with
 
31
            the current plot.  These are deleted whenever a new plot
 
32
            command is issued via the <code>plot</code> method.</p>
 
33
 
 
34
</dd>
 
35
<dt>        <code>plotcmd</code></dt><dd><p><code>plot</code> or <code>splot</code>, depending on what was the last
 
36
            plot command.</p>
 
37
 
 
38
</dd></dl>
 
39
 
 
40
<p>    Methods:</p>
 
41
<dl><dt>        <code>__init__</code></dt><dd><p>if a filename argument is specified, the
 
42
            commands will be written to that file instead of being
 
43
            piped to gnuplot.</p>
 
44
 
 
45
</dd>
 
46
<dt>        <code>plot</code></dt><dd><p>clear the old plot and old <code>PlotItems</code>, then plot
 
47
            the arguments in a fresh plot command.  Arguments can be:
 
48
            a <code>PlotItem</code>, which is plotted along with its internal
 
49
            options; a string, which is plotted as a <code>Func</code>; or
 
50
            anything else, which is plotted as a <code>Data</code>.</p>
 
51
 
 
52
</dd>
 
53
<dt>        <code>splot</code></dt><dd><p>like <code>plot</code>, except for 3-d plots.</p>
 
54
 
 
55
</dd>
 
56
<dt>        <code>hardcopy</code></dt><dd><p>replot the plot to a postscript file (if
 
57
            filename argument is specified) or pipe it to the printer
 
58
            as postscript othewise.  If the option <code>color</code> is set to
 
59
            true, then output color postscript.</p>
 
60
 
 
61
</dd>
 
62
<dt>        <code>replot</code></dt><dd><p>replot the old items, adding any arguments as
 
63
            additional items as in the plot method.</p>
 
64
 
 
65
</dd>
 
66
<dt>        <code>refresh</code></dt><dd><p>issue (or reissue) the plot command using the
 
67
            current <code>PlotItems</code>.</p>
 
68
 
 
69
</dd>
 
70
<dt>        <code>__call__</code></dt><dd><p>pass an arbitrary string to the gnuplot process,
 
71
            followed by a newline.</p>
 
72
 
 
73
</dd>
 
74
<dt>        <code>xlabel</code>, <code>ylabel</code>, <code>title</code></dt><dd><p>set corresponding plot
 
75
            attribute.</p>
 
76
 
 
77
</dd>
 
78
<dt>        <code>interact</code></dt><dd><p>read lines from stdin and send them, one by one,
 
79
            to the gnuplot interpreter.  Basically you can type
 
80
            commands directly to the gnuplot command processor.</p>
 
81
 
 
82
</dd>
 
83
<dt>        <code>load</code></dt><dd><p>load a file (using the gnuplot <code>load</code> command).</p>
 
84
 
 
85
</dd>
 
86
<dt>        <code>save</code></dt><dd><p>save gnuplot commands to a file (using gnuplot
 
87
            <code>save</code> command) If any of the 'PlotItem's is a temporary
 
88
            file, it will be deleted at the usual time and the save
 
89
            file will be pretty useless :-).</p>
 
90
 
 
91
</dd>
 
92
<dt>        <code>clear</code></dt><dd><p>clear the plot window (but not the itemlist).</p>
 
93
 
 
94
</dd>
 
95
<dt>        <code>reset</code></dt><dd><p>reset all gnuplot settings to their defaults and
 
96
            clear the current itemlist.</p>
 
97
 
 
98
</dd>
 
99
<dt>        <code>set_string</code></dt><dd><p>set or unset a gnuplot option whose value is a
 
100
            string.</p>
 
101
 
 
102
</dd>
 
103
<dt>        <code>_clear_queue</code></dt><dd><p>clear the current <code>PlotItem</code> list.</p>
 
104
 
 
105
</dd>
 
106
<dt>        <code>_add_to_queue</code></dt><dd><p>add the specified items to the current
 
107
            <code>PlotItem</code> list.</p>
 
108
 
 
109
</dd></dl>
 
110
 
 
111
 
 
112
</dd></dl>
 
113
        
 
114
        <table border="0" cellpadding="5" cellspacing="0" width="100%%">
 
115
        
 
116
        <tr>
 
117
            <th bgcolor="#99ccff"
 
118
                rowspan="2"
 
119
                valign="top"
 
120
                align="left"
 
121
                width="20%"
 
122
                >
 
123
                <font color="#000000">
 
124
                  <a name="Methods">Methods</a>&nbsp;
 
125
                </font>
 
126
            </th>
 
127
            <th bgcolor="#99ccff"
 
128
                valign="top"
 
129
                align="left"
 
130
                >
 
131
                <font color="#000000">&nbsp;</font>
 
132
            </th>
 
133
        </tr>
 
134
        <tr>
 
135
        <td>
 
136
        
 
137
<table border="0" cellspacing="2" cellpadding="2" width="100%">
 
138
<tr><td align="LEFT" valign="TOP">
 
139
<a href="#__call__">__call__</a><br>
 
140
<a href="#__init__">__init__</a><br>
 
141
<a href="#_add_to_queue">_add_to_queue</a><br>
 
142
<a href="#_clear_queue">_clear_queue</a><br>
 
143
<a href="#clear">clear</a><br>
 
144
<a href="#hardcopy">hardcopy</a><br>
 
145
<a href="#interact">interact</a><br>
 
146
<a href="#load">load</a><br>
 
147
<a href="#plot">plot</a><br>
 
148
<a href="#refresh">refresh</a><br>
 
149
</td>
 
150
<td align="LEFT" valign="TOP">
 
151
<a href="#replot">replot</a><br>
 
152
<a href="#reset">reset</a><br>
 
153
<a href="#save">save</a><br>
 
154
<a href="#set">set</a><br>
 
155
<a href="#set_boolean">set_boolean</a><br>
 
156
<a href="#set_range">set_range</a><br>
 
157
<a href="#set_string">set_string</a><br>
 
158
<a href="#splot">splot</a><br>
 
159
<a href="#title">title</a><br>
 
160
<a href="#xlabel">xlabel</a><br>
 
161
</td>
 
162
<td align="LEFT" valign="TOP">
 
163
<a href="#ylabel">ylabel</a><br>
 
164
</td>
 
165
</tr></table>
 
166
 
 
167
 
 
168
        <tr>
 
169
            <th bgcolor="#99ccff"
 
170
                rowspan="2"
 
171
                valign="top"
 
172
                align="left"
 
173
                width="20%"
 
174
                >
 
175
                <font color="#000000">
 
176
                  <a name="__call__"></a>&nbsp;
 
177
                </font>
 
178
            </th>
 
179
            <th bgcolor="#99ccff"
 
180
                valign="top"
 
181
                align="left"
 
182
                >
 
183
                <font color="#000000">__call__&nbsp;</font>
 
184
            </th>
 
185
        </tr>
 
186
        <tr>
 
187
        <td>
 
188
        <pre>
 
189
__call__ ( self,  s )
 
190
 
 
191
</pre><dl><dt><p><strong>Send a command string to gnuplot.</strong><p>
 
192
</dt><dd><p>        Send the string s as a command to gnuplot, followed by a
 
193
        newline.  All communication with the gnuplot process (except
 
194
        for inline data) is through this method.</p>
 
195
 
 
196
 
 
197
</dd></dl>
 
198
 
 
199
        <tr>
 
200
            <th bgcolor="#99ccff"
 
201
                rowspan="2"
 
202
                valign="top"
 
203
                align="left"
 
204
                width="20%"
 
205
                >
 
206
                <font color="#000000">
 
207
                  <a name="__init__"></a>&nbsp;
 
208
                </font>
 
209
            </th>
 
210
            <th bgcolor="#99ccff"
 
211
                valign="top"
 
212
                align="left"
 
213
                >
 
214
                <font color="#000000">__init__&nbsp;</font>
 
215
            </th>
 
216
        </tr>
 
217
        <tr>
 
218
        <td>
 
219
        <pre>
 
220
__init__ (
 
221
        self,
 
222
        filename=None,
 
223
        persist=None,
 
224
        debug=0,
 
225
        )
 
226
 
 
227
</pre><dl><dt><p><strong>Create a Gnuplot object.</strong><p>
 
228
</dt><dd><p>        Create a <code>Gnuplot</code> object.  By default, this starts a gnuplot
 
229
        process and prepares to write commands to it.</p>
 
230
 
 
231
<p>        Keyword arguments:</p>
 
232
<dl><dt>          <code>filename=<string></code></dt><dd><p>if a filename is specified, the
 
233
              commands are instead written to that file (e.g., for
 
234
              later use using <code>load</code>).</p>
 
235
 
 
236
</dd>
 
237
<dt>          <code>persist=1</code></dt><dd><p>start gnuplot with the <code>-persist</code> option
 
238
              (which creates a new plot window for each plot command).
 
239
              (This option is not available on older versions of
 
240
              gnuplot.)</p>
 
241
 
 
242
</dd>
 
243
<dt>          <code>debug=1</code></dt><dd><p>echo the gnuplot commands to stderr as well as
 
244
              sending them to gnuplot.</p>
 
245
 
 
246
</dd></dl>
 
247
 
 
248
 
 
249
</dd></dl>
 
250
 
 
251
        <tr>
 
252
            <th bgcolor="#99ccff"
 
253
                rowspan="2"
 
254
                valign="top"
 
255
                align="left"
 
256
                width="20%"
 
257
                >
 
258
                <font color="#000000">
 
259
                  <a name="_add_to_queue"></a>&nbsp;
 
260
                </font>
 
261
            </th>
 
262
            <th bgcolor="#99ccff"
 
263
                valign="top"
 
264
                align="left"
 
265
                >
 
266
                <font color="#000000">_add_to_queue&nbsp;</font>
 
267
            </th>
 
268
        </tr>
 
269
        <tr>
 
270
        <td>
 
271
        <pre>
 
272
_add_to_queue ( self,  items )
 
273
 
 
274
</pre><dl><dt><p><strong>Add a list of items to the itemlist (but don't plot them).</strong><p>
 
275
</dt><dd><p>        <code>items</code> is a sequence of items, each of which should be a
 
276
        <code>PlotItem</code> of some kind, a string (interpreted as a function
 
277
        string for gnuplot to evaluate), or a Numeric array (or
 
278
        something that can be converted to a Numeric array).</p>
 
279
 
 
280
 
 
281
</dd></dl>
 
282
 
 
283
        <tr>
 
284
            <th bgcolor="#99ccff"
 
285
                rowspan="2"
 
286
                valign="top"
 
287
                align="left"
 
288
                width="20%"
 
289
                >
 
290
                <font color="#000000">
 
291
                  <a name="_clear_queue"></a>&nbsp;
 
292
                </font>
 
293
            </th>
 
294
            <th bgcolor="#99ccff"
 
295
                valign="top"
 
296
                align="left"
 
297
                >
 
298
                <font color="#000000">_clear_queue&nbsp;</font>
 
299
            </th>
 
300
        </tr>
 
301
        <tr>
 
302
        <td>
 
303
        <pre>
 
304
_clear_queue ( self )
 
305
 
 
306
</pre><p>Clear the <code>PlotItems</code> from the queue.</p>
 
307
 
 
308
 
 
309
        <tr>
 
310
            <th bgcolor="#99ccff"
 
311
                rowspan="2"
 
312
                valign="top"
 
313
                align="left"
 
314
                width="20%"
 
315
                >
 
316
                <font color="#000000">
 
317
                  <a name="clear"></a>&nbsp;
 
318
                </font>
 
319
            </th>
 
320
            <th bgcolor="#99ccff"
 
321
                valign="top"
 
322
                align="left"
 
323
                >
 
324
                <font color="#000000">clear&nbsp;</font>
 
325
            </th>
 
326
        </tr>
 
327
        <tr>
 
328
        <td>
 
329
        <pre>
 
330
clear ( self )
 
331
 
 
332
</pre><p>Clear the plot window (without affecting the current itemlist).</p>
 
333
 
 
334
 
 
335
        <tr>
 
336
            <th bgcolor="#99ccff"
 
337
                rowspan="2"
 
338
                valign="top"
 
339
                align="left"
 
340
                width="20%"
 
341
                >
 
342
                <font color="#000000">
 
343
                  <a name="hardcopy"></a>&nbsp;
 
344
                </font>
 
345
            </th>
 
346
            <th bgcolor="#99ccff"
 
347
                valign="top"
 
348
                align="left"
 
349
                >
 
350
                <font color="#000000">hardcopy&nbsp;</font>
 
351
            </th>
 
352
        </tr>
 
353
        <tr>
 
354
        <td>
 
355
        <pre>
 
356
hardcopy (
 
357
        self,
 
358
        filename=None,
 
359
        mode=None,
 
360
        eps=None,
 
361
        enhanced=None,
 
362
        color=None,
 
363
        solid=None,
 
364
        duplexing=None,
 
365
        fontname=None,
 
366
        fontsize=None,
 
367
        )
 
368
 
 
369
</pre><dl><dt><p><strong>Create a hardcopy of the current plot.</strong><p>
 
370
</dt><dd><p>        Create a postscript hardcopy of the current plot to the
 
371
        default printer (if configured) or to the specified filename.</p>
 
372
 
 
373
<p>        Note that gnuplot remembers the postscript suboptions across
 
374
        terminal changes.  Therefore if you set, for example, color=1
 
375
        for one hardcopy then the next hardcopy will also be color
 
376
        unless you explicitly choose color=0.  Alternately you can
 
377
        force all of the options to their defaults by setting
 
378
        mode='default'.  I consider this to be a bug in gnuplot.</p>
 
379
 
 
380
<p>        Keyword arguments:</p>
 
381
<dl><dt>          <code>filename=<string></code></dt><dd><p>if a filename is specified, save the
 
382
              output in that file; otherwise print it immediately
 
383
              using the <code>default_lpr</code> configuration option.</p>
 
384
 
 
385
</dd>
 
386
<dt>          <code>mode=<string></code></dt><dd><p>set the postscript submode (<code>landscape</code>,
 
387
              <code>portrait</code>, <code>eps</code>, or <code>default</code>).  The default is
 
388
              to leave this option unspecified.</p>
 
389
 
 
390
</dd>
 
391
<dt>          <code>eps=<bool></code></dt><dd><p>shorthand for <code>mode="eps"</code>; asks gnuplot to
 
392
              generate encapsulated postscript.</p>
 
393
 
 
394
</dd>
 
395
<dt>          <code>enhanced=<bool></code></dt><dd><p>if set (the default), then generate
 
396
              enhanced postscript, which allows extra features like
 
397
              font-switching, superscripts, and subscripts in axis
 
398
              labels.  (Some old gnuplot versions do not support
 
399
              enhanced postscript; if this is the case set
 
400
              gp.GnuplotOpts.prefer_enhanced_postscript=None.)</p>
 
401
 
 
402
</dd>
 
403
<dt>          <code>color=<bool></code></dt><dd><p>if set, create a plot with color.  Default
 
404
              is to leave this option unchanged.</p>
 
405
 
 
406
</dd>
 
407
<dt>          <code>solid=<bool></code></dt><dd><p>if set, force lines to be solid (i.e., not
 
408
              dashed).</p>
 
409
 
 
410
</dd>
 
411
<dt>          <code>duplexing=<string></code></dt><dd><p>set duplexing option (<code>defaultplex</code>,
 
412
              <code>simplex</code>, or <code>duplex</code>).  Only request double-sided
 
413
              printing if your printer can handle it.  Actually this
 
414
              option is probably meaningless since hardcopy() can only
 
415
              print a single plot at a time.</p>
 
416
 
 
417
</dd>
 
418
<dt>          <code>fontname=<string></code></dt><dd><p>set the default font to <string>,
 
419
              which must be a valid postscript font.  The default is
 
420
              to leave this option unspecified.</p>
 
421
 
 
422
</dd>
 
423
<dt>          <code>fontsize=<double></code></dt><dd><p>set the default font size, in
 
424
              postscript points.</p>
 
425
 
 
426
</dd></dl>
 
427
 
 
428
<p>        Note that this command will return immediately even though it
 
429
        might take gnuplot a while to actually finish working.  Be
 
430
        sure to pause briefly before issuing another command that
 
431
        might cause the temporary files to be deleted.</p>
 
432
 
 
433
 
 
434
</dd></dl>
 
435
 
 
436
        <tr>
 
437
            <th bgcolor="#99ccff"
 
438
                rowspan="2"
 
439
                valign="top"
 
440
                align="left"
 
441
                width="20%"
 
442
                >
 
443
                <font color="#000000">
 
444
                  <a name="interact"></a>&nbsp;
 
445
                </font>
 
446
            </th>
 
447
            <th bgcolor="#99ccff"
 
448
                valign="top"
 
449
                align="left"
 
450
                >
 
451
                <font color="#000000">interact&nbsp;</font>
 
452
            </th>
 
453
        </tr>
 
454
        <tr>
 
455
        <td>
 
456
        <pre>
 
457
interact ( self )
 
458
 
 
459
</pre><dl><dt><p><strong>Allow user to type arbitrary commands to gnuplot.</strong><p>
 
460
</dt><dd><p>        Read stdin, line by line, and send each line as a command to
 
461
        gnuplot.  End by typing C-d.</p>
 
462
 
 
463
 
 
464
</dd></dl>
 
465
 
 
466
        <tr>
 
467
            <th bgcolor="#99ccff"
 
468
                rowspan="2"
 
469
                valign="top"
 
470
                align="left"
 
471
                width="20%"
 
472
                >
 
473
                <font color="#000000">
 
474
                  <a name="load"></a>&nbsp;
 
475
                </font>
 
476
            </th>
 
477
            <th bgcolor="#99ccff"
 
478
                valign="top"
 
479
                align="left"
 
480
                >
 
481
                <font color="#000000">load&nbsp;</font>
 
482
            </th>
 
483
        </tr>
 
484
        <tr>
 
485
        <td>
 
486
        <pre>
 
487
load ( self,  filename )
 
488
 
 
489
</pre><p>Load a file using gnuplot's <code>load</code> command.</p>
 
490
 
 
491
 
 
492
        <tr>
 
493
            <th bgcolor="#99ccff"
 
494
                rowspan="2"
 
495
                valign="top"
 
496
                align="left"
 
497
                width="20%"
 
498
                >
 
499
                <font color="#000000">
 
500
                  <a name="plot"></a>&nbsp;
 
501
                </font>
 
502
            </th>
 
503
            <th bgcolor="#99ccff"
 
504
                valign="top"
 
505
                align="left"
 
506
                >
 
507
                <font color="#000000">plot&nbsp;</font>
 
508
            </th>
 
509
        </tr>
 
510
        <tr>
 
511
        <td>
 
512
        <pre>
 
513
plot (
 
514
        self,
 
515
        *items,
 
516
        *keyw,
 
517
        )
 
518
 
 
519
</pre><dl><dt><p><strong>Draw a new plot.</strong><p>
 
520
</dt><dd><p>        Clear the current plot and create a new 2-d plot containing
 
521
        the specified items.  Each arguments should be of the
 
522
        following types:</p>
 
523
 
 
524
<dl><dt>        <code>PlotItem</code> (e.g., <code>Data</code>, <code>File</code>, <code>Func</code>)</dt><dd><p>This is the most
 
525
            flexible way to call plot because the PlotItems can
 
526
            contain suboptions.  Moreover, PlotItems can be saved to
 
527
            variables so that their lifetime is longer than one plot
 
528
            command; thus they can be replotted with minimal overhead.</p>
 
529
 
 
530
</dd>
 
531
<dt>        <code>string</code> (e.g., <code>sin(x)</code>)</dt><dd><p>The string is interpreted as
 
532
            <code>Func(string)</code> (a function that is computed by gnuplot).</p>
 
533
 
 
534
</dd>
 
535
<dt>        Anything else</dt><dd><p>The object, which should be convertible to an
 
536
            array, is passed to the <code>Data</code> constructor, and thus
 
537
            plotted as data.  If the conversion fails, an exception is
 
538
            raised.</p>
 
539
 
 
540
</dd></dl>
 
541
 
 
542
</dd></dl>
 
543
 
 
544
        <tr>
 
545
            <th bgcolor="#99ccff"
 
546
                rowspan="2"
 
547
                valign="top"
 
548
                align="left"
 
549
                width="20%"
 
550
                >
 
551
                <font color="#000000">
 
552
                  <a name="refresh"></a>&nbsp;
 
553
                </font>
 
554
            </th>
 
555
            <th bgcolor="#99ccff"
 
556
                valign="top"
 
557
                align="left"
 
558
                >
 
559
                <font color="#000000">refresh&nbsp;</font>
 
560
            </th>
 
561
        </tr>
 
562
        <tr>
 
563
        <td>
 
564
        <pre>
 
565
refresh ( self )
 
566
 
 
567
</pre><dl><dt><p><strong>Refresh the plot, using the current 'PlotItem's.</strong><p>
 
568
</dt><dd><p>        Refresh the current plot by reissuing the gnuplot plot command
 
569
        corresponding to the current itemlist.</p>
 
570
 
 
571
 
 
572
</dd></dl>
 
573
 
 
574
        <tr>
 
575
            <th bgcolor="#99ccff"
 
576
                rowspan="2"
 
577
                valign="top"
 
578
                align="left"
 
579
                width="20%"
 
580
                >
 
581
                <font color="#000000">
 
582
                  <a name="replot"></a>&nbsp;
 
583
                </font>
 
584
            </th>
 
585
            <th bgcolor="#99ccff"
 
586
                valign="top"
 
587
                align="left"
 
588
                >
 
589
                <font color="#000000">replot&nbsp;</font>
 
590
            </th>
 
591
        </tr>
 
592
        <tr>
 
593
        <td>
 
594
        <pre>
 
595
replot (
 
596
        self,
 
597
        *items,
 
598
        *keyw,
 
599
        )
 
600
 
 
601
</pre><dl><dt><p><strong>Replot the data, possibly adding new 'PlotItem's.</strong><p>
 
602
</dt><dd><p>        Replot the existing graph, using the items in the current
 
603
        itemlist.  If arguments are specified, they are interpreted as
 
604
        additional items to be plotted alongside the existing items on
 
605
        the same graph.  See <code>plot</code> for details.</p>
 
606
 
 
607
 
 
608
</dd></dl>
 
609
 
 
610
        <tr>
 
611
            <th bgcolor="#99ccff"
 
612
                rowspan="2"
 
613
                valign="top"
 
614
                align="left"
 
615
                width="20%"
 
616
                >
 
617
                <font color="#000000">
 
618
                  <a name="reset"></a>&nbsp;
 
619
                </font>
 
620
            </th>
 
621
            <th bgcolor="#99ccff"
 
622
                valign="top"
 
623
                align="left"
 
624
                >
 
625
                <font color="#000000">reset&nbsp;</font>
 
626
            </th>
 
627
        </tr>
 
628
        <tr>
 
629
        <td>
 
630
        <pre>
 
631
reset ( self )
 
632
 
 
633
</pre><p>Reset all gnuplot settings to their defaults and clear itemlist.</p>
 
634
 
 
635
 
 
636
        <tr>
 
637
            <th bgcolor="#99ccff"
 
638
                rowspan="2"
 
639
                valign="top"
 
640
                align="left"
 
641
                width="20%"
 
642
                >
 
643
                <font color="#000000">
 
644
                  <a name="save"></a>&nbsp;
 
645
                </font>
 
646
            </th>
 
647
            <th bgcolor="#99ccff"
 
648
                valign="top"
 
649
                align="left"
 
650
                >
 
651
                <font color="#000000">save&nbsp;</font>
 
652
            </th>
 
653
        </tr>
 
654
        <tr>
 
655
        <td>
 
656
        <pre>
 
657
save ( self,  filename )
 
658
 
 
659
</pre><p>Save the current plot commands using gnuplot's <code>save</code> command.</p>
 
660
 
 
661
 
 
662
        <tr>
 
663
            <th bgcolor="#99ccff"
 
664
                rowspan="2"
 
665
                valign="top"
 
666
                align="left"
 
667
                width="20%"
 
668
                >
 
669
                <font color="#000000">
 
670
                  <a name="set"></a>&nbsp;
 
671
                </font>
 
672
            </th>
 
673
            <th bgcolor="#99ccff"
 
674
                valign="top"
 
675
                align="left"
 
676
                >
 
677
                <font color="#000000">set&nbsp;</font>
 
678
            </th>
 
679
        </tr>
 
680
        <tr>
 
681
        <td>
 
682
        <pre>
 
683
set ( self,  **keyw )
 
684
 
 
685
</pre><p>Set one or more settings at once from keyword arguments.
 
686
        The allowed settings and their treatments are determined from
 
687
        the optiontypes mapping.</p>
 
688
 
 
689
        
 
690
        <table border="0" cellpadding="5" cellspacing="0" width="100%%">
 
691
        
 
692
        <tr>
 
693
            <th bgcolor="#99ccff"
 
694
                rowspan="2"
 
695
                valign="top"
 
696
                align="left"
 
697
                width="20%"
 
698
                >
 
699
                <font color="#000000">
 
700
                  <a name="Exceptions">Exceptions</a>&nbsp;
 
701
                </font>
 
702
            </th>
 
703
            <th bgcolor="#99ccff"
 
704
                valign="top"
 
705
                align="left"
 
706
                >
 
707
                <font color="#000000">&nbsp;</font>
 
708
            </th>
 
709
        </tr>
 
710
        <tr>
 
711
        <td>
 
712
        
 
713
<pre>
 
714
'option %s is not supported'
 
715
 
 
716
</pre>
 
717
 
 
718
        </td>
 
719
        </tr>
 
720
        </table>
 
721
        
 
722
        <tr>
 
723
            <th bgcolor="#99ccff"
 
724
                rowspan="2"
 
725
                valign="top"
 
726
                align="left"
 
727
                width="20%"
 
728
                >
 
729
                <font color="#000000">
 
730
                  <a name="set_boolean"></a>&nbsp;
 
731
                </font>
 
732
            </th>
 
733
            <th bgcolor="#99ccff"
 
734
                valign="top"
 
735
                align="left"
 
736
                >
 
737
                <font color="#000000">set_boolean&nbsp;</font>
 
738
            </th>
 
739
        </tr>
 
740
        <tr>
 
741
        <td>
 
742
        <pre>
 
743
set_boolean (
 
744
        self,
 
745
        option,
 
746
        value,
 
747
        )
 
748
 
 
749
</pre><p>Set an on/off option.  It is assumed that the way to turn
 
750
        the option on is to type `set <option>' and to turn it off,
 
751
        `set no<option>'.</p>
 
752
 
 
753
 
 
754
        <tr>
 
755
            <th bgcolor="#99ccff"
 
756
                rowspan="2"
 
757
                valign="top"
 
758
                align="left"
 
759
                width="20%"
 
760
                >
 
761
                <font color="#000000">
 
762
                  <a name="set_range"></a>&nbsp;
 
763
                </font>
 
764
            </th>
 
765
            <th bgcolor="#99ccff"
 
766
                valign="top"
 
767
                align="left"
 
768
                >
 
769
                <font color="#000000">set_range&nbsp;</font>
 
770
            </th>
 
771
        </tr>
 
772
        <tr>
 
773
        <td>
 
774
        <pre>
 
775
set_range (
 
776
        self,
 
777
        option,
 
778
        value,
 
779
        )
 
780
 
 
781
</pre><p>Set a range option (xrange, yrange, trange, urange, etc.).
 
782
        The value can be a string (which is passed as-is, without
 
783
        quotes) or a tuple (minrange,maxrange) of numbers or string
 
784
        expressions recognized by gnuplot.  If either range is None
 
785
        then that range is passed as `*' (which means to
 
786
        autoscale).</p>
 
787
 
 
788
 
 
789
        <tr>
 
790
            <th bgcolor="#99ccff"
 
791
                rowspan="2"
 
792
                valign="top"
 
793
                align="left"
 
794
                width="20%"
 
795
                >
 
796
                <font color="#000000">
 
797
                  <a name="set_string"></a>&nbsp;
 
798
                </font>
 
799
            </th>
 
800
            <th bgcolor="#99ccff"
 
801
                valign="top"
 
802
                align="left"
 
803
                >
 
804
                <font color="#000000">set_string&nbsp;</font>
 
805
            </th>
 
806
        </tr>
 
807
        <tr>
 
808
        <td>
 
809
        <pre>
 
810
set_string (
 
811
        self,
 
812
        option,
 
813
        s=None,
 
814
        )
 
815
 
 
816
</pre><p>Set a string option, or if s is omitted, unset the option.</p>
 
817
 
 
818
 
 
819
        <tr>
 
820
            <th bgcolor="#99ccff"
 
821
                rowspan="2"
 
822
                valign="top"
 
823
                align="left"
 
824
                width="20%"
 
825
                >
 
826
                <font color="#000000">
 
827
                  <a name="splot"></a>&nbsp;
 
828
                </font>
 
829
            </th>
 
830
            <th bgcolor="#99ccff"
 
831
                valign="top"
 
832
                align="left"
 
833
                >
 
834
                <font color="#000000">splot&nbsp;</font>
 
835
            </th>
 
836
        </tr>
 
837
        <tr>
 
838
        <td>
 
839
        <pre>
 
840
splot (
 
841
        self,
 
842
        *items,
 
843
        *keyw,
 
844
        )
 
845
 
 
846
</pre><dl><dt><p><strong>Draw a new three-dimensional plot.</strong><p>
 
847
</dt><dd><p>        Clear the current plot and create a new 3-d plot containing
 
848
        the specified items.  Arguments can be of the following types:</p>
 
849
 
 
850
<dl><dt>        <code>PlotItem</code> (e.g., <code>Data</code>, <code>File</code>, <code>Func</code>, <code>GridData</code> )</dt><dd><p>This
 
851
            is the most flexible way to call plot because the
 
852
            PlotItems can contain suboptions.  Moreover, PlotItems can
 
853
            be saved to variables so that their lifetime is longer
 
854
            than one plot command--thus they can be replotted with
 
855
            minimal overhead.</p>
 
856
 
 
857
</dd>
 
858
<dt>        <code>string</code> (e.g., <code>sin(x*y)</code>)</dt><dd><p>The string is interpreted as a
 
859
            <code>Func()</code> (a function that is computed by gnuplot).</p>
 
860
 
 
861
</dd>
 
862
<dt>        Anything else</dt><dd><p>The object is converted to a Data() item, and
 
863
            thus plotted as data.  Note that each data point should
 
864
            normally have at least three values associated with it
 
865
            (i.e., x, y, and z).  If the conversion fails, an
 
866
            exception is raised.</p>
 
867
 
 
868
</dd></dl>
 
869
 
 
870
</dd></dl>
 
871
 
 
872
        <tr>
 
873
            <th bgcolor="#99ccff"
 
874
                rowspan="2"
 
875
                valign="top"
 
876
                align="left"
 
877
                width="20%"
 
878
                >
 
879
                <font color="#000000">
 
880
                  <a name="title"></a>&nbsp;
 
881
                </font>
 
882
            </th>
 
883
            <th bgcolor="#99ccff"
 
884
                valign="top"
 
885
                align="left"
 
886
                >
 
887
                <font color="#000000">title&nbsp;</font>
 
888
            </th>
 
889
        </tr>
 
890
        <tr>
 
891
        <td>
 
892
        <pre>
 
893
title ( self,  s=None )
 
894
 
 
895
</pre><p>Set the plot's title.</p>
 
896
 
 
897
 
 
898
        <tr>
 
899
            <th bgcolor="#99ccff"
 
900
                rowspan="2"
 
901
                valign="top"
 
902
                align="left"
 
903
                width="20%"
 
904
                >
 
905
                <font color="#000000">
 
906
                  <a name="xlabel"></a>&nbsp;
 
907
                </font>
 
908
            </th>
 
909
            <th bgcolor="#99ccff"
 
910
                valign="top"
 
911
                align="left"
 
912
                >
 
913
                <font color="#000000">xlabel&nbsp;</font>
 
914
            </th>
 
915
        </tr>
 
916
        <tr>
 
917
        <td>
 
918
        <pre>
 
919
xlabel ( self,  s=None )
 
920
 
 
921
</pre><p>Set the plot's xlabel.</p>
 
922
 
 
923
 
 
924
        <tr>
 
925
            <th bgcolor="#99ccff"
 
926
                rowspan="2"
 
927
                valign="top"
 
928
                align="left"
 
929
                width="20%"
 
930
                >
 
931
                <font color="#000000">
 
932
                  <a name="ylabel"></a>&nbsp;
 
933
                </font>
 
934
            </th>
 
935
            <th bgcolor="#99ccff"
 
936
                valign="top"
 
937
                align="left"
 
938
                >
 
939
                <font color="#000000">ylabel&nbsp;</font>
 
940
            </th>
 
941
        </tr>
 
942
        <tr>
 
943
        <td>
 
944
        <pre>
 
945
ylabel ( self,  s=None )
 
946
 
 
947
</pre><p>Set the plot's ylabel.</p>
 
948
 
 
949
</td></tr>
 
950
        </td>
 
951
        </tr>
 
952
        </table>
 
953
        
 
954
        </td>
 
955
        </tr>
 
956
        </table>
 
957
 
 
958
        <hr>
 
959
 
 
960
        <p><i><a href="index.html">Table of Contents</a></i></p>
 
961
 
 
962
        <i>This document was automatically generated on Fri Jan 26 13:13:18 2001
 
963
        by <a href="http://happydoc.sourceforge.net">HappyDoc</a> version r0_9_2</i>
 
964
 
 
965
        </body>
 
966
        </html>
 
967
        
 
 
b'\\ No newline at end of file'