source: trunk/SRC/Documentation/idldoc_html_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: 9.2 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>velovect.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="velovect.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../../ToBeReviewed/PLOTS/VECTEUR//velovect.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="vecteur.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="velovect.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/PLOTS/VECTEUR/</a></h1>
82      <h2 class="pro_file">velovect.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Produce a two-dimensional velocity field plot.
91
92 A directed arrow is drawn at each point showing the direction and
93 magnitude of the field.
94</div>
95
96     
97
98     
99
100     
101
102     
103
104      <div id="routine_details">
105       
106
107        <div class="routine_details" id="_velovect">
108
109          <h2><a class="top" href="#container">top</a>velovect <span class="categories">
110 Plotting, two-dimensional
111</span></h2>
112       
113          <p class="header">
114            velovect<span class="result">, <a href="#_velovect_param_u">u</a>, <a href="#_velovect_param_v">v</a>[, <a href="#_velovect_param_x">x</a>][, <a href="#_velovect_param_y">y</a>]</span>, <a href="#_velovect_keyword_MISSING">MISSING</a>=<span class="result">MISSING</span>, <a href="#_velovect_keyword_LENGTH">LENGTH</a>=<span class="result">LENGTH</span>, <a href="#_velovect_keyword_DOTS">DOTS</a>=<span class="result">DOTS</span>, <a href="#_velovect_keyword_COLOR">COLOR</a>=<span class="result">COLOR</span>, <a href="#_velovect_keyword_CLIP">CLIP</a>=<span class="result">CLIP</span>, <a href="#_velovect_keyword_NOCLIP">NOCLIP</a>=<span class="result">NOCLIP</span>, <a href="#_velovect_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_velovect_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
115       
116          <div class="comments">
117</div>
118
119         
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_velovect_param_u">u&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 The X component of the two-dimensional field.
138 U must be a two-dimensional array.
139</div>
140           
141            <h4 id="_velovect_param_v">v&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142              <span class="attr">in</span>
143             
144             
145              <span class="attr">required</span>
146             
147             
148             
149             
150            </h4>
151       
152          <div class="comments">
153 The Y component of the two dimensional field. Y must have
154 the same dimensions as X. The vector at point [i,j] has a
155 magnitude of:
156
157        (U[i,j]^2 + V[i,j]^2)^0.5
158
159 and a direction of:
160
161        ATAN2(V[i,j],U[i,j]).
162</div>
163           
164            <h4 id="_velovect_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165              <span class="attr">in</span>
166             
167              <span class="attr">optional</span>
168             
169             
170              <span class="attr">type:</span> <span class="value">vector</span>
171             
172             
173            </h4>
174       
175          <div class="comments">
176 Optional abscissa values. X must be a vector with a length
177 equal to the first dimension of U and V.
178</div>
179           
180            <h4 id="_velovect_param_y">y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181              <span class="attr">in</span>
182             
183              <span class="attr">optional</span>
184             
185             
186              <span class="attr">type:</span> <span class="value">vector</span>
187             
188             
189            </h4>
190       
191          <div class="comments">
192 Optional ordinate values. Y must be a vector with a length
193 equal to the first dimension of U and V.
194</div>
195           
196
197         
198
199         
200
201            <h3>Keywords</h3>
202           
203            <h4 id="_velovect_keyword_MISSING">MISSING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204             
205             
206             
207             
208             
209             
210             
211             
212            </h4>
213       
214            <div class="comments">
215  Missing data value. Vectors with a LENGTH greater
216 than MISSING are ignored.
217</div>
218           
219            <h4 id="_velovect_keyword_LENGTH">LENGTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
220             
221             
222             
223             
224             
225             
226              <span class="attr">default:</span> <span class="value">1.0</span>
227             
228            </h4>
229       
230            <div class="comments">
231 Length factor. The default of 1.0 makes the longest (U,V)
232 vector the length of a cell.
233</div>
234           
235            <h4 id="_velovect_keyword_DOTS">DOTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236             
237             
238             
239             
240             
241             
242             
243             
244            </h4>
245       
246            <div class="comments">
247 Set this keyword to 1 to place a dot at each missing point.
248 Set this keyword to 0 or omit it to draw nothing for missing
249 points. Has effect only if MISSING is specified.
250</div>
251           
252            <h4 id="_velovect_keyword_COLOR">COLOR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
253             
254             
255             
256             
257             
258             
259             
260             
261            </h4>
262       
263            <div class="comments">
264 The color index used for the plot.
265</div>
266           
267            <h4 id="_velovect_keyword_CLIP">CLIP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
268             
269             
270             
271             
272             
273             
274             
275             
276            </h4>
277       
278            <div class="comments">
279</div>
280           
281            <h4 id="_velovect_keyword_NOCLIP">NOCLIP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
282             
283             
284             
285             
286             
287             
288             
289             
290            </h4>
291       
292            <div class="comments">
293</div>
294           
295            <h4 id="_velovect_keyword_OVERPLOT">OVERPLOT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
296             
297             
298             
299             
300             
301             
302             
303             
304            </h4>
305       
306            <div class="comments">
307 Set this keyword to make VELOVECT "overplot". That is, the
308 current graphics screen is not erased, no axes are drawn, and
309 the previously established scaling remains in effect.
310</div>
311           
312            <h4 id="_velovect_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
313             
314             
315             
316             
317             
318             
319             
320             
321            </h4>
322       
323            <div class="comments">
324 Used to pass keywords
325</div>
326           
327         
328
329         
330          <h3>Version history</h3>
331         
332          <h4>Version</h4><div class="preformat">
333 $Id: velovect.pro 327 2007-12-13 16:22:35Z pinsard $
334</div>
335          <h4>History</h4><div class="preformat">
336        DMS, RSI, Oct., 1983.
337        For Sun, DMS, RSI, April, 1989.
338        Added TITLE, Oct, 1990.
339        Added POSITION, NOERASE, COLOR, Feb 91, RES.
340        August, 1993. Vince Patrick, Adv. Visualization Lab, U. of Maryland,
341                fixed errors in math.
342        August, 1993. DMS, Added _EXTRA keyword inheritance.
343        January, 1994, KDB. Fixed integer math which produced 0 and caused
344                            divide by zero errors.
345        December, 1994, MWR. Added _EXTRA inheritance for PLOTS and OPLOT.
346        June, 1995, MWR. Removed _EXTRA inheritance for PLOTS and changed
347                         OPLOT to PLOTS.
348       September, 1996, GGS. Changed denominator of x_step and y_step vars.
349       February, 1998, DLD. Add support for CLIP and NO_CLIP keywords.
350       June, 1998, DLD. Add support for OVERPLOT keyword.
351
352 Copyright (c) 1983-1998, Research Systems, Inc. All rights reserved.
353        Unauthorized reproduction prohibited.
354</div>
355         
356         
357          <h3>Known issues</h3>
358         
359         
360         
361          <h4>Restrictions</h4><div class="preformat">
362 Plotting on the selected device is performed. System
363 variables concerning plotting are changed.
364 Note:   All other keywords are passed directly to the PLOT procedure
365        and may be used to set option such as TITLE, POSITION,
366        NOERASE, etc.
367</div>
368       
369         
370         
371         
372         
373         
374         
375         
376       
377          <h3>Statistics</h3>
378          <table class="statistics">
379            <tr><td>McCabe cyclic</td><td>          19</td></tr>
380            <tr><td>McCabe essential</td><td>           3</td></tr>
381            <tr><td>McCabe modular design</td><td>           1</td></tr>
382          </table>
383         
384       
385        </div>
386       
387      </div>
388
389     
390
391      <div id="tagline">Produced by IDLdoc 2.0.</div>
392
393    </div>
394
395  </body>
396</html>
Note: See TracBrowser for help on using the repository browser.