← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/python-gnuplot/intrepid

« back to all changes in this revision

Viewing changes to doc/Gnuplot/PlotItems/_FileItem.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2008-06-24 18:40:22 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20080624184022-lnok0v9ja8uzdj82
Tags: 1.8-1
http://bugs.debian.org/336422
http://bugs.debian.org/424965
http://bugs.debian.org/469313
http://bugs.debian.org/478468
http://bugs.debian.org/450271
* New upstream version.
  - doc file with broken link not shipped anymore. Closes: #336422.
  - Use `with_' instead of `with', which is a keyword in python2.6.
    Closes: #424965.
* Use python-numpy instead of python-numeric. Closes: #469313, #478468.
* Update watch file. Closes: #450271.
* Register documention in section `Programming/Python'.
* Update datafile.py.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Gnuplot/PlotItems/_FileItem.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2
 
          "http://www.w3.org/TR/html40/loose.dtd">
3
 
 
4
 
<html>
5
 
         
6
 
  <head>
7
 
    <title>Class: _FileItem</title>
8
 
  </head>
9
 
 
10
 
  <body bgcolor="#ffffff">
11
 
 
12
 
        <p><i><a href="../../index.html">Table of Contents</a></i></p>
13
 
        
14
 
        <table border="0" cellpadding="5" cellspacing="0" width="100%">
15
 
        <tr>
16
 
            <th rowspan="2"
17
 
                valign="top"
18
 
                align="left"
19
 
                width="10%"
20
 
                bgcolor="#88bbee"><font color="#000000">Class: _FileItem</font>
21
 
            </th>
22
 
            <th bgcolor="#88bbee"
23
 
                width="90%"
24
 
                align="right"><font color="#000000">Gnuplot/PlotItems.py</font>
25
 
            </th>
26
 
        </tr>
27
 
        <tr>
28
 
        <td>
29
 
        
30
 
<h3>A PlotItem representing a file that contains gnuplot data.</h3>
31
 
<p>    This class is not meant for users but rather as a base class for
32
 
    other types of FileItem.</p>
33
 
<table border="0" cellpadding="5" cellspacing="0" width="100%">
34
 
 
35
 
        <tr>
36
 
            <th bgcolor="#99ccff"
37
 
                rowspan="2"
38
 
                valign="top"
39
 
                align="left"
40
 
                width="20%"
41
 
                >
42
 
                <font color="#000000">
43
 
                  <a name="Base Classes">Base Classes</a>&nbsp;
44
 
                </font>
45
 
            </th>
46
 
            <th bgcolor="#99ccff"
47
 
                valign="top"
48
 
                align="left"
49
 
                width="80%"
50
 
                >
51
 
                <font color="#000000">&nbsp;</font>
52
 
            </th>
53
 
        </tr>
54
 
        <tr>
55
 
        <td>
56
 
        
57
 
<a href="PlotItem.html">PlotItem</a><br>
58
 
 
59
 
</td></tr>
60
 
</table>
61
 
<table border="0" cellpadding="5" cellspacing="0" width="100%">
62
 
 
63
 
        <tr>
64
 
            <th bgcolor="#99ccff"
65
 
                rowspan="2"
66
 
                valign="top"
67
 
                align="left"
68
 
                width="20%"
69
 
                >
70
 
                <font color="#000000">
71
 
                  <a name="Methods">Methods</a>&nbsp;
72
 
                </font>
73
 
            </th>
74
 
            <th bgcolor="#99ccff"
75
 
                valign="top"
76
 
                align="left"
77
 
                width="80%"
78
 
                >
79
 
                <font color="#000000">&nbsp;</font>
80
 
            </th>
81
 
        </tr>
82
 
        <tr>
83
 
        <td>
84
 
        
85
 
<a href="#__init__">__init__</a><br>
86
 
<a href="#get_base_command_string">get_base_command_string</a><br>
87
 
<a href="#set_option_binary">set_option_binary</a><br>
88
 
<a href="#set_option_colonsep">set_option_colonsep</a><br>
89
 
 
90
 
 
91
 
        <tr>
92
 
            <th bgcolor="#99ccff"
93
 
                rowspan="2"
94
 
                valign="top"
95
 
                align="left"
96
 
                width="20%"
97
 
                >
98
 
                <font color="#000000">
99
 
                  <a name="__init__"></a>&nbsp;
100
 
                </font>
101
 
            </th>
102
 
            <th bgcolor="#99ccff"
103
 
                valign="top"
104
 
                align="left"
105
 
                width="80%"
106
 
                >
107
 
                <font color="#000000">__init__&nbsp;</font>
108
 
            </th>
109
 
        </tr>
110
 
        <tr>
111
 
        <td>
112
 
        <font color="#000088"><pre>
113
 
__init__ (
114
 
        self,
115
 
        filename,
116
 
        **keyw,
117
 
        )
118
 
 
119
 
</pre></font>
120
 
 
121
 
<h3>Represent a PlotItem that gnuplot treates as a file.</h3>
122
 
<p>        This class holds the information that is needed to construct
123
 
        the plot command line, including options that are specific to
124
 
        file-like gnuplot input.</p>
125
 
<p>        &lt;filename&gt; is a string representing the filename to be passed
126
 
        to gnuplot within quotes.  It may be the name of an existing
127
 
        file, <code>-</code> for inline data, or the name of a named pipe.</p>
128
 
<h4>        Keyword arguments:</h4>
129
 
<dl>
130
 
<dt>            <code>using=&lt;int&gt;</code></dt>
131
 
<dd>plot that column against line number</dd>
132
 
<dt>            <code>using=&lt;tuple&gt;</code></dt>
133
 
<dd>plot using a:b:c:d etc.  Elements in
134
 
                the tuple that are None are output as the empty
135
 
                string.</dd>
136
 
<dt>            <code>using=&lt;string&gt;</code></dt>
137
 
<dd>plot `using &lt;string&gt;' (allows gnuplot's
138
 
                arbitrary column arithmetic)</dd>
139
 
<dt>            <code>every=&lt;value&gt;</code></dt>
140
 
<dd>plot <code>every &lt;value&gt;</code>.  &lt;value&gt; is
141
 
                formatted as for <code>using</code> option.</dd>
142
 
<dt>            <code>index=&lt;value&gt;</code></dt>
143
 
<dd>plot <code>index &lt;value&gt;</code>.  &lt;value&gt; is
144
 
                formatted as for <code>using</code> option.</dd>
145
 
<dt>            <code>binary=&lt;boolean&gt;</code></dt>
146
 
<dd>data in the file is in binary format
147
 
                (this option is only allowed for grid data for splot).</dd>
148
 
<dt>            <code>smooth=&lt;string&gt;</code></dt>
149
 
<dd>smooth the data.  Option should be
150
 
                <code>unique</code>, <code>csplines</code>, <code>acsplines</code>, <code>bezier</code>, or
151
 
                <code>sbezier</code>.</dd>
152
 
</dl>
153
 
<p>        The keyword arguments recognized by <code>PlotItem</code> can also be
154
 
        used here.</p>
155
 
<p>        Note that the <code>using</code> option is interpreted by gnuplot, so
156
 
        columns must be numbered starting with 1.</p>
157
 
<p>        By default, gnuplot uses the name of the file plus any <code>using</code>
158
 
        option as the dataset title.  If you want another title, set
159
 
        it explicitly using the <code>title</code> option.</p>
160
 
 
161
 
        <tr>
162
 
            <th bgcolor="#99ccff"
163
 
                rowspan="2"
164
 
                valign="top"
165
 
                align="left"
166
 
                width="20%"
167
 
                >
168
 
                <font color="#000000">
169
 
                  <a name="get_base_command_string"></a>&nbsp;
170
 
                </font>
171
 
            </th>
172
 
            <th bgcolor="#99ccff"
173
 
                valign="top"
174
 
                align="left"
175
 
                width="80%"
176
 
                >
177
 
                <font color="#000000">get_base_command_string&nbsp;</font>
178
 
            </th>
179
 
        </tr>
180
 
        <tr>
181
 
        <td>
182
 
        <font color="#000088"><pre>
183
 
get_base_command_string ( self )
184
 
 
185
 
</pre></font>
186
 
 
187
 
 
188
 
        <tr>
189
 
            <th bgcolor="#99ccff"
190
 
                rowspan="2"
191
 
                valign="top"
192
 
                align="left"
193
 
                width="20%"
194
 
                >
195
 
                <font color="#000000">
196
 
                  <a name="set_option_binary"></a>&nbsp;
197
 
                </font>
198
 
            </th>
199
 
            <th bgcolor="#99ccff"
200
 
                valign="top"
201
 
                align="left"
202
 
                width="80%"
203
 
                >
204
 
                <font color="#000000">set_option_binary&nbsp;</font>
205
 
            </th>
206
 
        </tr>
207
 
        <tr>
208
 
        <td>
209
 
        <font color="#000088"><pre>
210
 
set_option_binary ( self,  binary )
211
 
 
212
 
</pre></font>
213
 
 
214
 
<table border="0" cellpadding="5" cellspacing="0" width="100%">
215
 
 
216
 
        <tr>
217
 
            <th bgcolor="#99ccff"
218
 
                rowspan="2"
219
 
                valign="top"
220
 
                align="left"
221
 
                width="20%"
222
 
                >
223
 
                <font color="#000000">
224
 
                  <a name="Exceptions">Exceptions</a>&nbsp;
225
 
                </font>
226
 
            </th>
227
 
            <th bgcolor="#99ccff"
228
 
                valign="top"
229
 
                align="left"
230
 
                width="80%"
231
 
                >
232
 
                <font color="#000000">&nbsp;</font>
233
 
            </th>
234
 
        </tr>
235
 
        <tr>
236
 
        <td>
237
 
        
238
 
Errors.OptionError( 'Gnuplot.py is currently configured to reject binary data' )<br>
239
 
 
240
 
</td></tr>
241
 
</table>
242
 
 
243
 
        <tr>
244
 
            <th bgcolor="#99ccff"
245
 
                rowspan="2"
246
 
                valign="top"
247
 
                align="left"
248
 
                width="20%"
249
 
                >
250
 
                <font color="#000000">
251
 
                  <a name="set_option_colonsep"></a>&nbsp;
252
 
                </font>
253
 
            </th>
254
 
            <th bgcolor="#99ccff"
255
 
                valign="top"
256
 
                align="left"
257
 
                width="80%"
258
 
                >
259
 
                <font color="#000000">set_option_colonsep&nbsp;</font>
260
 
            </th>
261
 
        </tr>
262
 
        <tr>
263
 
        <td>
264
 
        <font color="#000088"><pre>
265
 
set_option_colonsep (
266
 
        self,
267
 
        name,
268
 
        value,
269
 
        )
270
 
 
271
 
</pre></font>
272
 
 
273
 
<table border="0" cellpadding="5" cellspacing="0" width="100%">
274
 
 
275
 
        <tr>
276
 
            <th bgcolor="#99ccff"
277
 
                rowspan="2"
278
 
                valign="top"
279
 
                align="left"
280
 
                width="20%"
281
 
                >
282
 
                <font color="#000000">
283
 
                  <a name="Exceptions">Exceptions</a>&nbsp;
284
 
                </font>
285
 
            </th>
286
 
            <th bgcolor="#99ccff"
287
 
                valign="top"
288
 
                align="left"
289
 
                width="80%"
290
 
                >
291
 
                <font color="#000000">&nbsp;</font>
292
 
            </th>
293
 
        </tr>
294
 
        <tr>
295
 
        <td>
296
 
        
297
 
Errors.OptionError('%s=%s' %( name, value, ) )<br>
298
 
 
299
 
</td></tr>
300
 
</table>
301
 
</td></tr>
302
 
</td></tr>
303
 
</table>
304
 
 
305
 
        </td>
306
 
        </tr>
307
 
        </table>
308
 
 
309
 
        <hr>
310
 
 
311
 
        <p><i><a href="../../index.html">Table of Contents</a></i></p>
312
 
 
313
 
        <font size="-2"><i>This document was automatically generated
314
 
        on Sun Oct 19 17:10:22 2003 by
315
 
        <a href="http://happydoc.sourceforge.net">HappyDoc</a> version
316
 
        2.1</i></font>
317
 
        
318
 
        </body>
319
 
        </html>
320
 
        
 
 
b'\\ No newline at end of file'