source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/VECTEUR/velovect.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 7.8 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>velovect.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="vecteur.html"><img src="./../../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href=""><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/PLOTS/VECTEUR/</font></h1>
58    <h2>velovect.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Produce a two-dimensional velocity field plot.
65
66 A directed arrow is drawn at each point showing the direction and
67 magnitude of the field.
68
69
70   
71
72     
73      <a name="#_velovect"></a>
74
75      <h2>velovect  <font size="-1" color="#006633">
76 Plotting, two-dimensional
77</font></h2>
78
79      <p><font face="Courier">velovect<i>, <a href="#_velovect_keyword_u">u</a>, <a href="#_velovect_keyword_v">v</a>[, <a href="#_velovect_keyword_x">x</a>][, <a href="#_velovect_keyword_y">y</a>]</i>, <a href="#_velovect_keyword_MISSING">MISSING</a>=<i>MISSING</i>, <a href="#_velovect_keyword_LENGTH">LENGTH</a>=<i>LENGTH</i>, <a href="#_velovect_keyword_DOTS">DOTS</a>=<i>DOTS</i>, <a href="#_velovect_keyword_COLOR">COLOR</a>=<i>COLOR</i>, <a href="#_velovect_keyword_CLIP">CLIP</a>=<i>CLIP</i>, <a href="#_velovect_keyword_NOCLIP">NOCLIP</a>=<i>NOCLIP</i>, <a href="#_velovect_keyword_OVERPLOT">OVERPLOT</a>=<i>OVERPLOT</i>, <a href="#_velovect_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
80
81   
82
83
84   
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_velovect_keyword_u"></a>
91    <h4>u&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97     
98     
99     
100    </h4>
101
102   
103 The X component of the two-dimensional field.
104 U must be a two-dimensional array.
105
106   
107
108    <a name="#_velovect_keyword_v"></a>
109    <h4>v&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110      <font size="-1" color="#006633">in</font>
111     
112     
113      <font size="-1" color="#006633">required</font>
114     
115     
116     
117     
118    </h4>
119
120   
121 The Y component of the two dimensional field. Y must have
122 the same dimensions as X. The vector at point [i,j] has a
123 magnitude of:
124
125        (U[i,j]^2 + V[i,j]^2)^0.5
126
127 and a direction of:
128
129        ATAN2(V[i,j],U[i,j]).
130
131   
132
133    <a name="#_velovect_keyword_x"></a>
134    <h4>x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
135      <font size="-1" color="#006633">in</font>
136     
137      <font size="-1" color="#006633">optional</font>
138     
139     
140      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
141     
142     
143    </h4>
144
145   
146 Optional abscissa values. X must be a vector with a length
147 equal to the first dimension of U and V.
148
149   
150
151    <a name="#_velovect_keyword_y"></a>
152    <h4>y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153      <font size="-1" color="#006633">in</font>
154     
155      <font size="-1" color="#006633">optional</font>
156     
157     
158      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
159     
160     
161    </h4>
162
163   
164 Optional ordinate values. Y must be a vector with a length
165 equal to the first dimension of U and V.
166
167   
168   
169
170   
171    <h3>Keywords</h3>
172
173   
174    <a name="#_velovect_keyword_MISSING"></a>
175    <h4>MISSING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
176     
177     
178     
179     
180     
181     
182     
183     
184    </h4>
185
186   
187  Missing data value. Vectors with a LENGTH greater
188 than MISSING are ignored.
189
190   
191    <a name="#_velovect_keyword_LENGTH"></a>
192    <h4>LENGTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
193     
194     
195     
196     
197     
198     
199      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1.0</i></font>
200     
201    </h4>
202
203   
204 Length factor. The default of 1.0 makes the longest (U,V)
205 vector the length of a cell.
206
207   
208    <a name="#_velovect_keyword_DOTS"></a>
209    <h4>DOTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
210     
211     
212     
213     
214     
215     
216     
217     
218    </h4>
219
220   
221 Set this keyword to 1 to place a dot at each missing point.
222 Set this keyword to 0 or omit it to draw nothing for missing
223 points. Has effect only if MISSING is specified.
224
225   
226    <a name="#_velovect_keyword_COLOR"></a>
227    <h4>COLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
228     
229     
230     
231     
232     
233     
234     
235     
236    </h4>
237
238   
239 The color index used for the plot.
240
241   
242    <a name="#_velovect_keyword_CLIP"></a>
243    <h4>CLIP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
244     
245     
246     
247     
248     
249     
250     
251     
252    </h4>
253
254   
255
256   
257    <a name="#_velovect_keyword_NOCLIP"></a>
258    <h4>NOCLIP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
259     
260     
261     
262     
263     
264     
265     
266     
267    </h4>
268
269   
270
271   
272    <a name="#_velovect_keyword_OVERPLOT"></a>
273    <h4>OVERPLOT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
274     
275     
276     
277     
278     
279     
280     
281     
282    </h4>
283
284   
285 Set this keyword to make VELOVECT "overplot". That is, the
286 current graphics screen is not erased, no axes are drawn, and
287 the previously established scaling remains in effect.
288
289   
290    <a name="#_velovect_keyword__EXTRA"></a>
291    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
292     
293     
294     
295     
296     
297     
298     
299     
300    </h4>
301
302   
303 Used to pass keywords
304
305   
306   
307
308   
309    </pre><h3>Version history</h3>
310   
311    <h4>Version</h4>
312 $Id: velovect.pro 327 2007-12-13 16:22:35Z pinsard $
313
314    <h4>History</h4>
315        DMS, RSI, Oct., 1983.
316        For Sun, DMS, RSI, April, 1989.
317        Added TITLE, Oct, 1990.
318        Added POSITION, NOERASE, COLOR, Feb 91, RES.
319        August, 1993. Vince Patrick, Adv. Visualization Lab, U. of Maryland,
320                fixed errors in math.
321        August, 1993. DMS, Added _EXTRA keyword inheritance.
322        January, 1994, KDB. Fixed integer math which produced 0 and caused
323                            divide by zero errors.
324        December, 1994, MWR. Added _EXTRA inheritance for PLOTS and OPLOT.
325        June, 1995, MWR. Removed _EXTRA inheritance for PLOTS and changed
326                         OPLOT to PLOTS.
327       September, 1996, GGS. Changed denominator of x_step and y_step vars.
328       February, 1998, DLD. Add support for CLIP and NO_CLIP keywords.
329       June, 1998, DLD. Add support for OVERPLOT keyword.
330
331 Copyright (c) 1983-1998, Research Systems, Inc. All rights reserved.
332        Unauthorized reproduction prohibited.
333
334   
335
336    <h3>Known issues</h3>
337   
338   
339   
340    <h4>Restrictions</h4>
341 Plotting on the selected device is performed. System
342 variables concerning plotting are changed.
343 Note:   All other keywords are passed directly to the PLOT procedure
344        and may be used to set option such as TITLE, POSITION,
345        NOERASE, etc.
346
347
348   
349   
350   
351   
352   
353   
354   
355
356    <font size="-3"><p>&nbsp;</p></font>
357    <hr size="1" color="#CCCCCC"/>
358     
359
360   
361
362    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
363
364  </body>
365</html>
Note: See TracBrowser for help on using the repository browser.