~ubuntu-branches/ubuntu/feisty/python-gnuplot/feisty

« back to all changes in this revision

Viewing changes to doc/PlotItems.py_GridData.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2005-01-23 00:42:37 UTC
  • mfrom: (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20050123004237-0rfjkhe4ii7ky637
Tags: 1.7-5
Fix mouse control in generated plot windows (closes: #291294).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<html>
2
 
 
3
 
        <head>
4
 
        <title>Class: GridData</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: GridData</font>
17
 
            </th>
18
 
            <th align="right"><font color="#000000">./PlotItems.py</font></th>
19
 
        </tr>
20
 
        <tr>
21
 
        <td>
22
 
        <dl><dt><p><strong>Holds data representing a function of two variables, for use in splot.</strong><p>
23
 
</dt><dd><p>    <code>GridData</code> represents a function that has been tabulated on a
24
 
    rectangular grid.  The data are written to a file; no copy is kept
25
 
    in memory.</p>
26
 
 
27
 
 
28
 
</dd></dl>
29
 
        
30
 
        <table border="0" cellpadding="5" cellspacing="0" width="100%%">
31
 
        
32
 
        <tr>
33
 
            <th bgcolor="#99ccff"
34
 
                rowspan="2"
35
 
                valign="top"
36
 
                align="left"
37
 
                width="20%"
38
 
                >
39
 
                <font color="#000000">
40
 
                  <a name="Base Classes">Base Classes</a>&nbsp;
41
 
                </font>
42
 
            </th>
43
 
            <th bgcolor="#99ccff"
44
 
                valign="top"
45
 
                align="left"
46
 
                >
47
 
                <font color="#000000">&nbsp;</font>
48
 
            </th>
49
 
        </tr>
50
 
        <tr>
51
 
        <td>
52
 
        
53
 
<a href="PlotItems.py_PlotItem.html">PlotItem</a><br>
54
 
 
55
 
 
56
 
        </td>
57
 
        </tr>
58
 
        </table>
59
 
                
60
 
        <table border="0" cellpadding="5" cellspacing="0" width="100%%">
61
 
        
62
 
        <tr>
63
 
            <th bgcolor="#99ccff"
64
 
                rowspan="2"
65
 
                valign="top"
66
 
                align="left"
67
 
                width="20%"
68
 
                >
69
 
                <font color="#000000">
70
 
                  <a name="Methods">Methods</a>&nbsp;
71
 
                </font>
72
 
            </th>
73
 
            <th bgcolor="#99ccff"
74
 
                valign="top"
75
 
                align="left"
76
 
                >
77
 
                <font color="#000000">&nbsp;</font>
78
 
            </th>
79
 
        </tr>
80
 
        <tr>
81
 
        <td>
82
 
        
83
 
<a href="#__init__">__init__</a><br>
84
 
<a href="#pipein">pipein</a><br>
85
 
 
86
 
 
87
 
        <tr>
88
 
            <th bgcolor="#99ccff"
89
 
                rowspan="2"
90
 
                valign="top"
91
 
                align="left"
92
 
                width="20%"
93
 
                >
94
 
                <font color="#000000">
95
 
                  <a name="__init__"></a>&nbsp;
96
 
                </font>
97
 
            </th>
98
 
            <th bgcolor="#99ccff"
99
 
                valign="top"
100
 
                align="left"
101
 
                >
102
 
                <font color="#000000">__init__&nbsp;</font>
103
 
            </th>
104
 
        </tr>
105
 
        <tr>
106
 
        <td>
107
 
        <pre>
108
 
__init__ (
109
 
        self,
110
 
        data,
111
 
        xvals=None,
112
 
        yvals=None,
113
 
        binary=1,
114
 
        inline=_unset,
115
 
        **keyw,
116
 
        )
117
 
 
118
 
</pre><dl><dt><p><strong>GridData constructor.</strong><p>
119
 
</dt><dd><p>        Arguments:</p>
120
 
<dl><dt>            <code>data</code></dt><dd><p>the data to plot: a 2-d array with dimensions
121
 
                (numx,numy).</p>
122
 
 
123
 
</dd>
124
 
<dt>            <code>xvals</code></dt><dd><p>a 1-d array with dimension <code>numx</code></p>
125
 
 
126
 
</dd>
127
 
<dt>            <code>yvals</code></dt><dd><p>a 1-d array with dimension <code>numy</code></p>
128
 
 
129
 
</dd>
130
 
<dt>            <code>binary=<bool></code></dt><dd><p>send data to gnuplot in binary format?</p>
131
 
 
132
 
</dd>
133
 
<dt>            <code>inline=<bool></code></dt><dd><p>send data to gnuplot "inline"?</p>
134
 
 
135
 
</dd></dl>
136
 
 
137
 
<p>        Note the unusual argument order!  The data are specified
138
 
        <em>before</em> the x and y values.  (This inconsistency was probably
139
 
        a mistake; after all, the default xvals and yvals are not very
140
 
        useful.)</p>
141
 
 
142
 
<p>        <code>data</code> must be a data array holding the values of a function
143
 
        f(x,y) tabulated on a grid of points, such that <code>data[i,j] ==
144
 
        f(xvals[i], yvals[j])</code>.  If <code>xvals</code> and/or <code>yvals</code> are
145
 
        omitted, integers (starting with 0) are used for that
146
 
        coordinate.  The data are written to a temporary file; no copy
147
 
        of the data is kept in memory.</p>
148
 
 
149
 
<p>        If <code>binary=0</code> then the data are written to a datafile as <code>x y
150
 
        f(x,y)</code> triplets (y changes most rapidly) that can be used by
151
 
        gnuplot's <code>splot</code> command.  Blank lines are included each time
152
 
        the value of x changes so that gnuplot knows to plot a surface
153
 
        through the data.</p>
154
 
 
155
 
<p>        If <code>binary=1</code> then the data are written to a file in a binary
156
 
        format that <code>splot</code> can understand.  Binary format is faster
157
 
        and usually saves disk space but is not human-readable.  If
158
 
        your version of gnuplot doesn't support binary format (it is a
159
 
        recently-added feature), this behavior can be disabled by
160
 
        setting the configuration variable
161
 
        <code>gp.GnuplotOpts.recognizes_binary_splot=0</code> in the appropriate
162
 
        gp*.py file.</p>
163
 
 
164
 
<p>        Thus if you have three arrays in the above format and a
165
 
        Gnuplot instance called g, you can plot your data by typing
166
 
        <code>g.splot(Gnuplot.GridData(data,xvals,yvals))</code>.</p>
167
 
 
168
 
 
169
 
</dd></dl>
170
 
 
171
 
        <tr>
172
 
            <th bgcolor="#99ccff"
173
 
                rowspan="2"
174
 
                valign="top"
175
 
                align="left"
176
 
                width="20%"
177
 
                >
178
 
                <font color="#000000">
179
 
                  <a name="pipein"></a>&nbsp;
180
 
                </font>
181
 
            </th>
182
 
            <th bgcolor="#99ccff"
183
 
                valign="top"
184
 
                align="left"
185
 
                >
186
 
                <font color="#000000">pipein&nbsp;</font>
187
 
            </th>
188
 
        </tr>
189
 
        <tr>
190
 
        <td>
191
 
        <pre>
192
 
pipein ( self,  f )
193
 
 
194
 
</pre><p>
195
 
<TABLE BORDER=1 CELLPADDING=2>
196
 
</TABLE></p>
197
 
 
198
 
</td></tr>
199
 
        </td>
200
 
        </tr>
201
 
        </table>
202
 
        
203
 
        </td>
204
 
        </tr>
205
 
        </table>
206
 
 
207
 
        <hr>
208
 
 
209
 
        <p><i><a href="index.html">Table of Contents</a></i></p>
210
 
 
211
 
        <i>This document was automatically generated on Fri Jan 26 13:13:18 2001
212
 
        by <a href="http://happydoc.sourceforge.net">HappyDoc</a> version r0_9_2</i>
213
 
 
214
 
        </body>
215
 
        </html>
216
 
        
 
 
b'\\ No newline at end of file'