Context Navigation

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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago
header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 7.9 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
78	</font></h2>
79
80	<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>
81
82
83
84
85
86
87
88	<h3>Parameters</h3>
89
90
91	<a name="#_velovect_keyword_U"></a>
92	<h4>U
93	<font size="-1" color="#006633">in</font>
94
95
96	<font size="-1" color="#006633">required</font>
97
98
99
100
101	</h4>
102
103
104	The X component of the two-dimensional field.
105	U must be a two-dimensional array.
106
107
108
109	<a name="#_velovect_keyword_V"></a>
110	<h4>V
111	<font size="-1" color="#006633">in</font>
112
113
114	<font size="-1" color="#006633">required</font>
115
116
117
118
119	</h4>
120
121
122	The Y component of the two dimensional field. Y must have
123	the same dimensions as X. The vector at point [i,j] has a
124	magnitude of:
125
126	(U[i,j]^2 + V[i,j]^2)^0.5
127
128	and a direction of:
129
130	ATAN2(V[i,j],U[i,j]).
131
132
133
134	<a name="#_velovect_keyword_X"></a>
135	<h4>X
136	<font size="-1" color="#006633">in</font>
137
138	<font size="-1" color="#006633">optional</font>
139
140
141	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
142
143
144	</h4>
145
146
147	Optional abscissa values. X must be a vector with a length
148	equal to the first dimension of U and V.
149
150
151
152	<a name="#_velovect_keyword_Y"></a>
153	<h4>Y
154	<font size="-1" color="#006633">in</font>
155
156	<font size="-1" color="#006633">optional</font>
157
158
159	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font>
160
161
162	</h4>
163
164
165	Optional ordinate values. Y must be a vector with a length
166	equal to the first dimension of U and V.
167
168
169
170
171
172	<h3>Keywords</h3>
173
174
175	<a name="#_velovect_keyword_Missing"></a>
176	<h4>Missing
177
178
179
180
181
182
183
184
185	</h4>
186
187
188	Missing data value. Vectors with a LENGTH greater
189	than MISSING are ignored.
190
191
192	<a name="#_velovect_keyword_Length"></a>
193	<h4>Length
194
195
196
197
198
199
200	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1.0</i></font>
201
202	</h4>
203
204
205	Length factor. The default of 1.0 makes the longest (U,V)
206	vector the length of a cell.
207
208
209	<a name="#_velovect_keyword_Dots"></a>
210	<h4>Dots
211
212
213
214
215
216
217
218
219	</h4>
220
221
222	Set this keyword to 1 to place a dot at each missing point.
223	Set this keyword to 0 or omit it to draw nothing for missing
224	points. Has effect only if MISSING is specified.
225
226
227	<a name="#_velovect_keyword_Color"></a>
228	<h4>Color
229
230
231
232
233
234
235
236
237	</h4>
238
239
240	The color index used for the plot.
241
242
243	<a name="#_velovect_keyword_CLIP"></a>
244	<h4>CLIP
245
246
247
248
249
250
251
252
253	</h4>
254
255
256
257
258	<a name="#_velovect_keyword_NOCLIP"></a>
259	<h4>NOCLIP
260
261
262
263
264
265
266
267
268	</h4>
269
270
271
272
273	<a name="#_velovect_keyword_OVERPLOT"></a>
274	<h4>OVERPLOT
275
276
277
278
279
280
281
282
283	</h4>
284
285
286	Set this keyword to make VELOVECT "overplot". That is, the
287	current graphics screen is not erased, no axes are drawn, and
288	the previously established scaling remains in effect.
289
290
291	<a name="#_velovect_keyword__EXTRA"></a>
292	<h4>_EXTRA
293
294
295
296
297
298
299
300
301	</h4>
302
303
304	Used to pass your keywords.
305
306
307
308
309
310	<h3>Version history</h3>
311
312	<h4>Version</h4>
313	$Id: velovect.pro 142 2006-07-21 12:47:49Z navarro $
314
315	<h4>History</h4>
316	DMS, RSI, Oct., 1983.
317	For Sun, DMS, RSI, April, 1989.
318	Added TITLE, Oct, 1990.
319	Added POSITION, NOERASE, COLOR, Feb 91, RES.
320	August, 1993. Vince Patrick, Adv. Visualization Lab, U. of Maryland,
321	fixed errors in math.
322	August, 1993. DMS, Added _EXTRA keyword inheritance.
323	January, 1994, KDB. Fixed integer math which produced 0 and caused
324	divide by zero errors.
325	December, 1994, MWR. Added _EXTRA inheritance for PLOTS and OPLOT.
326	June, 1995, MWR. Removed _EXTRA inheritance for PLOTS and changed
327	OPLOT to PLOTS.
328	September, 1996, GGS. Changed denominator of x_step and y_step vars.
329	February, 1998, DLD. Add support for CLIP and NO_CLIP keywords.
330	June, 1998, DLD. Add support for OVERPLOT keyword.
331
332	Copyright (c) 1983-1998, Research Systems, Inc. All rights reserved.
333	Unauthorized reproduction prohibited.
334
335
336
337	<h3>Known issues</h3>
338
339
340
341	<h4>Restrictions</h4>
342	Plotting on the selected device is performed. System
343	variables concerning plotting are changed.
344	Note: All other keywords are passed directly to the PLOT procedure
345	and may be used to set option such as TITLE, POSITION,
346	NOERASE, etc.
347
348
349
350
351
352
353
354
355
356
357	<font size="-3"><p> </p></font>
358	<hr size="1" color="#CCCCCC"/>
359
360
361
362
363	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0 on Tue Aug 29 14:50:24 2006.</font></p>
364
365	</body>
366	</html>

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

Download in other formats: