Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/VECTEUR/velovect.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago
remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 9.3 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 documentation</td>
67	</tr>
68	</table>
69
70	</div>
71
72	<div id="secondary_navbar">
73
74	<a href="vecteur.html"><<prev file</a> \| next file >>    <a href="velovect.html" target="_TOP">view single page</a> \| <a href="./../../../index.html" target="_TOP">view frames</a>    summary: fields \| routine    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
112	</span></h2>
113
114	<p class="header">
115	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>
116
117	<div class="comments">
118	</div>
119
120
121
122
123	<h3>Parameters</h3>
124
125
126	<h4 id="_velovect_param_U">U
127	<span class="attr">in</span>
128
129
130	<span class="attr">required</span>
131
132
133
134
135	</h4>
136
137	<div class="comments">
138	The X component of the two-dimensional field.
139	U must be a two-dimensional array.
140	</div>
141
142	<h4 id="_velovect_param_V">V
143	<span class="attr">in</span>
144
145
146	<span class="attr">required</span>
147
148
149
150
151	</h4>
152
153	<div class="comments">
154	The Y component of the two dimensional field. Y must have
155	the same dimensions as X. The vector at point [i,j] has a
156	magnitude of:
157
158	(U[i,j]^2 + V[i,j]^2)^0.5
159
160	and a direction of:
161
162	ATAN2(V[i,j],U[i,j]).
163	</div>
164
165	<h4 id="_velovect_param_X">X
166	<span class="attr">in</span>
167
168	<span class="attr">optional</span>
169
170
171	<span class="attr">type:</span> <span class="value">vector</span>
172
173
174	</h4>
175
176	<div class="comments">
177	Optional abscissa values. X must be a vector with a length
178	equal to the first dimension of U and V.
179	</div>
180
181	<h4 id="_velovect_param_Y">Y
182	<span class="attr">in</span>
183
184	<span class="attr">optional</span>
185
186
187	<span class="attr">type:</span> <span class="value">vector</span>
188
189
190	</h4>
191
192	<div class="comments">
193	Optional ordinate values. Y must be a vector with a length
194	equal to the first dimension of U and V.
195	</div>
196
197
198
199
200
201
202	<h3>Keywords</h3>
203
204	<h4 id="_velovect_keyword_Missing">Missing
205
206
207
208
209
210
211
212
213	</h4>
214
215	<div class="comments">
216	Missing data value. Vectors with a LENGTH greater
217	than MISSING are ignored.
218	</div>
219
220	<h4 id="_velovect_keyword_Length">Length
221
222
223
224
225
226
227	<span class="attr">default:</span> <span class="value">1.0</span>
228
229	</h4>
230
231	<div class="comments">
232	Length factor. The default of 1.0 makes the longest (U,V)
233	vector the length of a cell.
234	</div>
235
236	<h4 id="_velovect_keyword_Dots">Dots
237
238
239
240
241
242
243
244
245	</h4>
246
247	<div class="comments">
248	Set this keyword to 1 to place a dot at each missing point.
249	Set this keyword to 0 or omit it to draw nothing for missing
250	points. Has effect only if MISSING is specified.
251	</div>
252
253	<h4 id="_velovect_keyword_Color">Color
254
255
256
257
258
259
260
261
262	</h4>
263
264	<div class="comments">
265	The color index used for the plot.
266	</div>
267
268	<h4 id="_velovect_keyword_CLIP">CLIP
269
270
271
272
273
274
275
276
277	</h4>
278
279	<div class="comments">
280	</div>
281
282	<h4 id="_velovect_keyword_NOCLIP">NOCLIP
283
284
285
286
287
288
289
290
291	</h4>
292
293	<div class="comments">
294	</div>
295
296	<h4 id="_velovect_keyword_OVERPLOT">OVERPLOT
297
298
299
300
301
302
303
304
305	</h4>
306
307	<div class="comments">
308	Set this keyword to make VELOVECT "overplot". That is, the
309	current graphics screen is not erased, no axes are drawn, and
310	the previously established scaling remains in effect.
311	</div>
312
313	<h4 id="_velovect_keyword__EXTRA">_EXTRA
314
315
316
317
318
319
320
321
322	</h4>
323
324	<div class="comments">
325	Used to pass your keywords.
326	</div>
327
328
329
330
331	<h3>Version history</h3>
332
333	<h4>Version</h4><div class="preformat">
334	$Id: velovect.pro 163 2006-08-29 12:59:46Z navarro $
335	</div>
336	<h4>History</h4><div class="preformat">
337	DMS, RSI, Oct., 1983.
338	For Sun, DMS, RSI, April, 1989.
339	Added TITLE, Oct, 1990.
340	Added POSITION, NOERASE, COLOR, Feb 91, RES.
341	August, 1993. Vince Patrick, Adv. Visualization Lab, U. of Maryland,
342	fixed errors in math.
343	August, 1993. DMS, Added _EXTRA keyword inheritance.
344	January, 1994, KDB. Fixed integer math which produced 0 and caused
345	divide by zero errors.
346	December, 1994, MWR. Added _EXTRA inheritance for PLOTS and OPLOT.
347	June, 1995, MWR. Removed _EXTRA inheritance for PLOTS and changed
348	OPLOT to PLOTS.
349	September, 1996, GGS. Changed denominator of x_step and y_step vars.
350	February, 1998, DLD. Add support for CLIP and NO_CLIP keywords.
351	June, 1998, DLD. Add support for OVERPLOT keyword.
352
353	Copyright (c) 1983-1998, Research Systems, Inc. All rights reserved.
354	Unauthorized reproduction prohibited.
355	</div>
356
357
358	<h3>Known issues</h3>
359
360
361
362	<h4>Restrictions</h4><div class="preformat">
363	Plotting on the selected device is performed. System
364	variables concerning plotting are changed.
365	Note: All other keywords are passed directly to the PLOT procedure
366	and may be used to set option such as TITLE, POSITION,
367	NOERASE, etc.
368	</div>
369
370
371
372
373
374
375
376
377
378	<h3>Statistics</h3>
379	<table class="statistics">
380	<tr><td>McCabe cyclic</td><td> 19</td></tr>
381	<tr><td>McCabe essential</td><td> 3</td></tr>
382	<tr><td>McCabe modular design</td><td> 1</td></tr>
383	</table>
384
385
386	</div>
387
388	</div>
389
390
391
392	<div id="tagline">Produced by IDLdoc 2.0.</div>
393
394	</div>
395
396	</body>
397	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: