← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/fr/graphics/plot3d1.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/fr/graphics/plot3d1.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
 
 
6
  <TITLE>plot3d1</TITLE>
 
7
 
 
8
  <TYPE>Scilab Function</TYPE>
 
9
 
 
10
  <DATE>April 1993</DATE>
 
11
 
 
12
  <SHORT_DESCRIPTION name="plot3d1">3D gray or color level plot of a
 
13
  surface</SHORT_DESCRIPTION>
 
14
 
 
15
  <CALLING_SEQUENCE>
 
16
    <CALLING_SEQUENCE_ITEM>plot3d1(x,y,z,[theta,alpha,leg,flag,ebox])</CALLING_SEQUENCE_ITEM>
 
17
 
 
18
    <CALLING_SEQUENCE_ITEM>plot3d1(xf,yf,zf,[theta,alpha,leg,flag,ebox])</CALLING_SEQUENCE_ITEM>
 
19
 
 
20
    <CALLING_SEQUENCE_ITEM></CALLING_SEQUENCE_ITEM>
 
21
 
 
22
    <CALLING_SEQUENCE_ITEM>plot3d1(x,y,z,&lt;opts_args&gt;)</CALLING_SEQUENCE_ITEM>
 
23
 
 
24
    <CALLING_SEQUENCE_ITEM>plot3d1(xf,yf,zf,&lt;opts_args&gt;)</CALLING_SEQUENCE_ITEM>
 
25
  </CALLING_SEQUENCE>
 
26
 
 
27
  <PARAM>
 
28
    <PARAM_INDENT>
 
29
      <PARAM_ITEM>
 
30
        <PARAM_NAME>x,y</PARAM_NAME>
 
31
 
 
32
        <PARAM_DESCRIPTION>
 
33
          <SP>: row vectors of sizes n1 and n2 (x-axis and y-axis
 
34
          coordinates). These coordinates must be monotone.</SP>
 
35
        </PARAM_DESCRIPTION>
 
36
      </PARAM_ITEM>
 
37
 
 
38
      <PARAM_ITEM>
 
39
        <PARAM_NAME>z</PARAM_NAME>
 
40
 
 
41
        <PARAM_DESCRIPTION>
 
42
          <SP>: matrix of size (n1,n2). <VERB>z(i,j)</VERB> is the value of
 
43
          the surface at the point (x(i),y(j)).</SP>
 
44
        </PARAM_DESCRIPTION>
 
45
      </PARAM_ITEM>
 
46
 
 
47
      <PARAM_ITEM>
 
48
        <PARAM_NAME>xf,yf,zf</PARAM_NAME>
 
49
 
 
50
        <PARAM_DESCRIPTION>
 
51
          <SP>: matrices of size (nf,n). They define the facets used to draw
 
52
          the surface. There are <VERB>n</VERB> facets. Each facet
 
53
          <VERB>i</VERB> is defined by a polygon with <VERB>nf</VERB> points.
 
54
          The x-axis, y-axis and z-axis coordinates of the points of the ith
 
55
          facet are given respectively by <VERB>xf(:,i)</VERB>,
 
56
          <VERB>yf(:,i)</VERB> and <VERB>zf(:,i)</VERB>.</SP>
 
57
        </PARAM_DESCRIPTION>
 
58
      </PARAM_ITEM>
 
59
 
 
60
      <PARAM_ITEM>
 
61
        <PARAM_NAME>&lt;opt_args&gt;</PARAM_NAME>
 
62
 
 
63
        <PARAM_DESCRIPTION>
 
64
          <SP>: This represents a sequence of statements <VERB>key1=value1,
 
65
          key2=value2</VERB>,... where <VERB>key1</VERB>,
 
66
          <VERB>key2,...</VERB> can be one of the following: theta, alpha
 
67
          ,leg,flag,ebox (see definition below).</SP>
 
68
        </PARAM_DESCRIPTION>
 
69
      </PARAM_ITEM>
 
70
 
 
71
      <PARAM_ITEM>
 
72
        <PARAM_NAME>theta, alpha</PARAM_NAME>
 
73
 
 
74
        <PARAM_DESCRIPTION>
 
75
          <SP>: real values giving in degree the spherical coordinates of the
 
76
          observation point.</SP>
 
77
        </PARAM_DESCRIPTION>
 
78
      </PARAM_ITEM>
 
79
 
 
80
      <PARAM_ITEM>
 
81
        <PARAM_NAME>leg</PARAM_NAME>
 
82
 
 
83
        <PARAM_DESCRIPTION>
 
84
          <SP>: string defining the labels for each axis with @ as a field
 
85
          separator, for example "X@Y@Z".</SP>
 
86
        </PARAM_DESCRIPTION>
 
87
      </PARAM_ITEM>
 
88
 
 
89
      <PARAM_ITEM>
 
90
        <PARAM_NAME>flag</PARAM_NAME>
 
91
 
 
92
        <PARAM_DESCRIPTION>
 
93
          <SP>: a real vector of size three.
 
94
          <VERB>flag=[mode,type,box]</VERB>.</SP>
 
95
 
 
96
          <PARAM_INDENT>
 
97
            <PARAM_ITEM>
 
98
              <PARAM_NAME>mode</PARAM_NAME>
 
99
 
 
100
              <PARAM_DESCRIPTION>
 
101
                <SP>: an integer (surface color).</SP>
 
102
 
 
103
                <PARAM_INDENT>
 
104
                  <PARAM_ITEM>
 
105
                    <PARAM_NAME>mode&gt;0</PARAM_NAME>
 
106
 
 
107
                    <PARAM_DESCRIPTION>
 
108
                      <SP>: the surface is painted with color
 
109
                      <VERB>"mode"</VERB> ; the boundary of the facet is drawn
 
110
                      with current line style and color.</SP>
 
111
                    </PARAM_DESCRIPTION>
 
112
                  </PARAM_ITEM>
 
113
 
 
114
                  <PARAM_ITEM>
 
115
                    <PARAM_NAME>mode=0:</PARAM_NAME>
 
116
 
 
117
                    <PARAM_DESCRIPTION>
 
118
                      <SP>a mesh of the surface is drawn.</SP>
 
119
                    </PARAM_DESCRIPTION>
 
120
                  </PARAM_ITEM>
 
121
 
 
122
                  <PARAM_ITEM>
 
123
                    <PARAM_NAME>mode&lt;0:</PARAM_NAME>
 
124
 
 
125
                    <PARAM_DESCRIPTION>
 
126
                      <SP>the surface is painted with color
 
127
                      <VERB>"-mode"</VERB> ; the boundary of the facet is not
 
128
                      drawn.</SP>
 
129
 
 
130
                      <P>Note that the surface color treatement can be done
 
131
                      using <VERB>color_mode</VERB> and
 
132
                      <VERB>color_flag</VERB> options through the surface
 
133
                      entity properties (see
 
134
                      <LINK>surface_properties</LINK>).</P>
 
135
                    </PARAM_DESCRIPTION>
 
136
                  </PARAM_ITEM>
 
137
                </PARAM_INDENT>
 
138
              </PARAM_DESCRIPTION>
 
139
            </PARAM_ITEM>
 
140
 
 
141
            <PARAM_ITEM>
 
142
              <PARAM_NAME>type</PARAM_NAME>
 
143
 
 
144
              <PARAM_DESCRIPTION>
 
145
                <SP>: an integer (scaling).</SP>
 
146
 
 
147
                <PARAM_INDENT>
 
148
                  <PARAM_ITEM>
 
149
                    <PARAM_NAME>type=0:</PARAM_NAME>
 
150
 
 
151
                    <PARAM_DESCRIPTION>
 
152
                      <SP>the plot is made using the current 3D scaling (set
 
153
                      by a previous call to <VERB>param3d</VERB>,
 
154
                      <VERB>plot3d</VERB>, <VERB>contour</VERB> or
 
155
                      <VERB>plot3d1</VERB>).</SP>
 
156
                    </PARAM_DESCRIPTION>
 
157
                  </PARAM_ITEM>
 
158
 
 
159
                  <PARAM_ITEM>
 
160
                    <PARAM_NAME>type=1:</PARAM_NAME>
 
161
 
 
162
                    <PARAM_DESCRIPTION>
 
163
                      <SP>rescales automatically 3d boxes with extreme aspect
 
164
                      ratios, the boundaries are specified by the value of the
 
165
                      optional argument <VERB>ebox</VERB>.</SP>
 
166
                    </PARAM_DESCRIPTION>
 
167
                  </PARAM_ITEM>
 
168
 
 
169
                  <PARAM_ITEM>
 
170
                    <PARAM_NAME>type=2:</PARAM_NAME>
 
171
 
 
172
                    <PARAM_DESCRIPTION>
 
173
                      <SP>rescales automatically 3d boxes with extreme aspect
 
174
                      ratios, the boundaries are computed using the given
 
175
                      data.</SP>
 
176
                    </PARAM_DESCRIPTION>
 
177
                  </PARAM_ITEM>
 
178
 
 
179
                  <PARAM_ITEM>
 
180
                    <PARAM_NAME>type=3:</PARAM_NAME>
 
181
 
 
182
                    <PARAM_DESCRIPTION>
 
183
                      <SP>3d isometric with box bounds given by optional
 
184
                      <VERB>ebox</VERB>, similarily to
 
185
                      <VERB>type=1</VERB>.</SP>
 
186
                    </PARAM_DESCRIPTION>
 
187
                  </PARAM_ITEM>
 
188
 
 
189
                  <PARAM_ITEM>
 
190
                    <PARAM_NAME>type=4:</PARAM_NAME>
 
191
 
 
192
                    <PARAM_DESCRIPTION>
 
193
                      <SP>3d isometric bounds derived from the data, to
 
194
                      similarily<VERB>type=2</VERB>.</SP>
 
195
                    </PARAM_DESCRIPTION>
 
196
                  </PARAM_ITEM>
 
197
 
 
198
                  <PARAM_ITEM>
 
199
                    <PARAM_NAME>type=5:</PARAM_NAME>
 
200
 
 
201
                    <PARAM_DESCRIPTION>
 
202
                      <SP>3d expanded isometric bounds with box bounds given
 
203
                      by optional <VERB>ebox</VERB>, similarily to
 
204
                      <VERB>type=1</VERB>.</SP>
 
205
                    </PARAM_DESCRIPTION>
 
206
                  </PARAM_ITEM>
 
207
 
 
208
                  <PARAM_ITEM>
 
209
                    <PARAM_NAME>type=6:</PARAM_NAME>
 
210
 
 
211
                    <PARAM_DESCRIPTION>
 
212
                      <SP>3d expanded isometric bounds derived from the data,
 
213
                      similarily to <VERB>type=2</VERB>.</SP>
 
214
 
 
215
                      <P>Note that axes boundaries can be customized through
 
216
                      the axes entity properties (see
 
217
                      <LINK>axes_properties</LINK>).</P>
 
218
                    </PARAM_DESCRIPTION>
 
219
                  </PARAM_ITEM>
 
220
                </PARAM_INDENT>
 
221
              </PARAM_DESCRIPTION>
 
222
            </PARAM_ITEM>
 
223
 
 
224
            <PARAM_ITEM>
 
225
              <PARAM_NAME>box</PARAM_NAME>
 
226
 
 
227
              <PARAM_DESCRIPTION>
 
228
                <SP>: an integer (frame around the plot).</SP>
 
229
 
 
230
                <PARAM_INDENT>
 
231
                  <PARAM_ITEM>
 
232
                    <PARAM_NAME>box=0:</PARAM_NAME>
 
233
 
 
234
                    <PARAM_DESCRIPTION>
 
235
                      <SP>nothing is drawn around the plot.</SP>
 
236
                    </PARAM_DESCRIPTION>
 
237
                  </PARAM_ITEM>
 
238
 
 
239
                  <PARAM_ITEM>
 
240
                    <PARAM_NAME>box=1:</PARAM_NAME>
 
241
 
 
242
                    <PARAM_DESCRIPTION>
 
243
                      <SP>unimplemented (like box=0).</SP>
 
244
                    </PARAM_DESCRIPTION>
 
245
                  </PARAM_ITEM>
 
246
 
 
247
                  <PARAM_ITEM>
 
248
                    <PARAM_NAME>box=2:</PARAM_NAME>
 
249
 
 
250
                    <PARAM_DESCRIPTION>
 
251
                      <SP>only the axes behind the surface are drawn.</SP>
 
252
                    </PARAM_DESCRIPTION>
 
253
                  </PARAM_ITEM>
 
254
 
 
255
                  <PARAM_ITEM>
 
256
                    <PARAM_NAME>box=3:</PARAM_NAME>
 
257
 
 
258
                    <PARAM_DESCRIPTION>
 
259
                      <SP>a box surrounding the surface is drawn and captions
 
260
                      are added.</SP>
 
261
                    </PARAM_DESCRIPTION>
 
262
                  </PARAM_ITEM>
 
263
 
 
264
                  <PARAM_ITEM>
 
265
                    <PARAM_NAME>box=4:</PARAM_NAME>
 
266
 
 
267
                    <PARAM_DESCRIPTION>
 
268
                      <SP>a box surrounding the surface is drawn, captions and
 
269
                      axes are added.</SP>
 
270
 
 
271
                      <P>Note that axes aspect can also be customized through
 
272
                      the axes entity properties (see
 
273
                      <LINK>axes_properties</LINK>).</P>
 
274
                    </PARAM_DESCRIPTION>
 
275
                  </PARAM_ITEM>
 
276
                </PARAM_INDENT>
 
277
              </PARAM_DESCRIPTION>
 
278
            </PARAM_ITEM>
 
279
          </PARAM_INDENT>
 
280
        </PARAM_DESCRIPTION>
 
281
      </PARAM_ITEM>
 
282
 
 
283
      <PARAM_ITEM>
 
284
        <PARAM_NAME>ebox</PARAM_NAME>
 
285
 
 
286
        <PARAM_DESCRIPTION>
 
287
          <SP>: It specifies the boundaries of the plot as the vector
 
288
          <VERB>[xmin,xmax,ymin,ymax,zmin,zmax]</VERB>. This argument is used
 
289
          together with <VERB>type</VERB> in <VERB>flag</VERB> : if it is set
 
290
          to <VERB>1</VERB>, <VERB>3</VERB> or <VERB>5</VERB> (see above to
 
291
          see the corresponding behaviour). If <VERB>flag</VERB> is missing,
 
292
          <VERB>ebox</VERB> is not taken into acoount.</SP>
 
293
 
 
294
          <P>Note that, when specified, the <VERB>ebox</VERB> argument acts on
 
295
          the <VERB>data_bounds</VERB> field that can also be reset through
 
296
          the axes entity properties (see <LINK>axes_properties</LINK>).</P>
 
297
        </PARAM_DESCRIPTION>
 
298
      </PARAM_ITEM>
 
299
    </PARAM_INDENT>
 
300
  </PARAM>
 
301
 
 
302
  <DESCRIPTION>
 
303
    <P><VERB>plot3d1</VERB> plots a surface with colors depending on the
 
304
    z-level of the surface. This special plot function can also be enabled
 
305
    setting <VERB>color_flag=1</VERB> after a <VERB>plot3d</VERB> (see
 
306
    <LINK>surface_properties</LINK>)</P>
 
307
 
 
308
    <P>Enter the command <VERB>plot3d1()</VERB> to see a demo.</P>
 
309
  </DESCRIPTION>
 
310
 
 
311
  <EXAMPLE><![CDATA[// simple plot using z=f(x,y) 
 
312
t=[0:0.3:2*%pi]'; z=sin(t)*cos(t'); 
 
313
plot3d1(t,t,z) 
 
314
// same plot using facets computed by genfac3d 
 
315
[xx,yy,zz]=genfac3d(t,t,z); 
 
316
clf(); 
 
317
plot3d1(xx,yy,zz) 
 
318
// multiple plots 
 
319
clf(); 
 
320
plot3d1([xx xx],[yy yy],[zz 4+zz]) 
 
321
// simple plot with viewpoint and captions 
 
322
clf() ;
 
323
plot3d1(1:10,1:20,10*rand(10,20),35,45,"X@Y@Z",[2,2,3]) 
 
324
// same plot without grid 
 
325
clf() 
 
326
plot3d1(1:10,1:20,10*rand(10,20),35,45,"X@Y@Z",[-2,2,3]) 
 
327
// plot of a sphere using facets computed by eval3dp 
 
328
deff("[x,y,z]=sph(alp,tet)",["x=r*cos(alp).*cos(tet)+orig(1)*ones(tet)";.. 
 
329
"y=r*cos(alp).*sin(tet)+orig(2)*ones(tet)";.. 
 
330
"z=r*sin(alp)+orig(3)*ones(tet)"]); 
 
331
r=1; orig=[0 0 0]; 
 
332
[xx,yy,zz]=eval3dp(sph,linspace(-%pi/2,%pi/2,40),linspace(0,%pi*2,20)); 
 
333
clf() 
 
334
 
 
335
plot3d(xx,yy,zz)
 
336
e=gce();
 
337
e.color_flag=1;
 
338
scf(2);
 
339
plot3d1(xx,yy,zz) // the 2 graphics are similar
 
340
 
 
341
]]></EXAMPLE>
 
342
 
 
343
  <SEE_ALSO>
 
344
    <SEE_ALSO_ITEM>
 
345
      <LINK>plot3d</LINK>
 
346
    </SEE_ALSO_ITEM>
 
347
 
 
348
    <SEE_ALSO_ITEM>
 
349
      <LINK>gca</LINK>
 
350
    </SEE_ALSO_ITEM>
 
351
 
 
352
    <SEE_ALSO_ITEM>
 
353
      <LINK>gce</LINK>
 
354
    </SEE_ALSO_ITEM>
 
355
 
 
356
    <SEE_ALSO_ITEM>
 
357
      <LINK>scf</LINK>
 
358
    </SEE_ALSO_ITEM>
 
359
 
 
360
    <SEE_ALSO_ITEM>
 
361
      <LINK>clf</LINK>
 
362
    </SEE_ALSO_ITEM>
 
363
  </SEE_ALSO>
 
364
 
 
365
  <AUTHOR>J.Ph.C.</AUTHOR>
 
366
</MAN>
 
 
b'\\ No newline at end of file'