Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/pltv.html @ 290

Last change on this file since 290 was 290, checked in by smasson, 17 years ago
update documentation
File size: 9.9 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>pltv.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="pltv.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/DESSINE//pltv.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="pltt.html"><<prev file</a> \| <a href="pltz.html">next file >></a>    <a href="pltv.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/DESSINE/</a></h1>
82	<h2 class="pro_file">pltv.pro</h2>
83
84	<div id="file_attr">
85	<dl>
86	</dl>
87	</div>
88
89	<div id="file_comments">
90	Draw 2d plots with TV procedure
91	</div>
92
93
94
95
96
97
98
99
100
101	<div id="routine_details">
102
103
104	<div class="routine_details" id="_pltv">
105
106	<h2><a class="top" href="#container">top</a>pltv <span class="categories"> find a file
107	graphic
108	</span></h2>
109
110	<p class="header">
111	pltv<span class="result">, <a href="#_pltv_param_data">data</a>[, <a href="#_pltv_param_min">min</a>][, <a href="#_pltv_param_max">max</a>]</span>, <a href="#_pltv_keyword_BOTTOM">BOTTOM</a>=<span class="result">BOTTOM</span>, <a href="#_pltv_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltv_keyword_C_MASK">C_MASK</a>=<span class="result">C_MASK</span>, <a href="#_pltv_keyword_C_NAN">C_NAN</a>=<span class="result">C_NAN</span>, <a href="#_pltv_keyword_INV">INV</a>=<span class="result">INV</span>, <a href="#_pltv_keyword_MININ">MININ</a>=<span class="result">MININ</span>, <a href="#_pltv_keyword_MAXIN">MAXIN</a>=<span class="result">MAXIN</span>, <a href="#_pltv_keyword_MASKVAL">MASKVAL</a>=<span class="result">MASKVAL</span>, <a href="#_pltv_keyword_NCOLORS">NCOLORS</a>=<span class="result">NCOLORS</span>, <a href="#_pltv_keyword_NOINTERP">NOINTERP</a>=<span class="result">NOINTERP</span>, <a href="#_pltv_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
112
113	<div class="comments">
114	</div>
115
116
117
118
119	<h3>Parameters</h3>
120
121
122	<h4 id="_pltv_param_data">data
123	<span class="attr">in</span>
124
125
126	<span class="attr">required</span>
127
128
129
130
131	</h4>
132
133	<div class="comments">
134	The field we want to display can be:
135	1) an array. If the array is not a 2D array, its mean along
136	the z and t direction will be automatically performed
137	(as it is done in plt).
138	2) a structure respecting all criterions specified by
139	<a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> cf. IDL> xhelp,'litchamp'
140	</div>
141
142	<h4 id="_pltv_param_min">min
143	<span class="attr">in</span>
144
145	<span class="attr">optional</span>
146
147
148
149	<span class="attr">default:</span> <span class="value">min of DATA (on non-masked points)</span>
150
151	</h4>
152
153	<div class="comments">
154	</div>
155
156	<h4 id="_pltv_param_max">max
157	<span class="attr">in</span>
158
159	<span class="attr">optional</span>
160
161
162
163	<span class="attr">default:</span> <span class="value">max of DATA (on non-masked points)</span>
164
165	</h4>
166
167	<div class="comments">
168	</div>
169
170
171
172
173
174
175	<h3>Keywords</h3>
176
177	<h4 id="_pltv_keyword_BOTTOM">BOTTOM
178
179
180
181
182
183
184	<span class="attr">default:</span> <span class="value">1</span>
185
186	</h4>
187
188	<div class="comments">
189	The lowest color index of the colors to be used.
190	</div>
191
192	<h4 id="_pltv_keyword_BOXZOOM">BOXZOOM
193
194
195
196
197
198
199
200
201	</h4>
202
203	<div class="comments">
204	Vector indicating the geographic zone on which we want to cut the map.
205	If BOXZOOM has :
206	1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
207	2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
208	4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
209	5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
210	6 elements: The extraction is made on Boxzoom
211
212	Where lon1, lon2, lat1, lat2 are global variables defined at the last
213	<a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
214	</div>
215
216	<h4 id="_pltv_keyword_C_MASK">C_MASK
217
218
219
220
221
222
223	<span class="attr">default:</span> <span class="value">0</span>
224
225	</h4>
226
227	<div class="comments">
228	The color number that should be used for the mask values.
229	</div>
230
231	<h4 id="_pltv_keyword_C_NAN">C_NAN
232
233
234
235
236
237
238	<span class="attr">default:</span> <span class="value">!d.n_colors < 255</span>
239
240	</h4>
241
242	<div class="comments">
243	The color number that should be used for the NaN values.
244	</div>
245
246	<h4 id="_pltv_keyword_INV">INV
247
248
249
250
251
252
253
254
255	</h4>
256
257	<div class="comments">
258	Reverse the color order
259	</div>
260
261	<h4 id="_pltv_keyword_MININ">MININ
262
263
264
265
266
267
268
269
270	</h4>
271
272	<div class="comments"></div>
273
274	<h4 id="_pltv_keyword_MAXIN">MAXIN
275
276
277
278
279
280
281
282
283	</h4>
284
285	<div class="comments"></div>
286
287	<h4 id="_pltv_keyword_MASKVAL">MASKVAL
288
289
290
291
292
293
294	<span class="attr">default:</span> <span class="value">1.e+20</span>
295
296	</h4>
297
298	<div class="comments">
299	The mask value. Note that if abs(mask) < 1.e6, then the
300	exact value of the mask is used to find the maskwd point.
301	if abs(mask) > 1.e6, the test to find the masked value is ge
302	abs(mask)/10. This is necessary to avoid the rounding errors
303	</div>
304
305	<h4 id="_pltv_keyword_NCOLORS">NCOLORS
306
307
308
309
310
311
312	<span class="attr">default:</span> <span class="value">(d.n_colors < 256) - 1 - BOTTOM</span>
313
314	</h4>
315
316	<div class="comments">
317	number of colors to be used.
318	</div>
319
320	<h4 id="_pltv_keyword_NOINTERP">NOINTERP
321
322
323
324
325
326
327
328
329	</h4>
330
331	<div class="comments">
332	Used this keyword if you don't want that the values
333	are interpolated from BOTTOM using NCOLORS colors.
334	This can be for example useful when working on byte type arrays.
335	</div>
336
337	<h4 id="_pltv_keyword__EXTRA">_EXTRA
338
339
340
341
342
343
344
345
346	</h4>
347
348	<div class="comments">
349	Used to pass keywords to <a href="../../..//ToBeReviewed/PLOTS/DIVERS/placedessin.html">placedessin</a>, <a href="/Applications/rsi/idl_6.3/help/online_help/TV.html">TV</a>,
350	<a href="../../..//ToBeReviewed/PLOTS/axe.html">axe</a>, <a href="../../..//ToBeReviewed/PLOTS/legende.html">legende</a>, <a href="../../..//ToBeReviewed/PLOTS/DIVERS/barrecouleur.html">barrecouleur</a>,
351	<a href="../../..//ToBeReviewed/PLOTS/DIVERS/terminedessin.html">terminedessin</a>
352	</div>
353
354
355
356	<h3>Examples</h3><div class="preformat">
357	IDL> tvplus, dist(100)
358	</div>
359	<h3>Version history</h3>
360
361	<h4>Version</h4><div class="preformat">
362	$Id: pltv.pro 286 2007-09-14 13:19:43Z smasson $
363	</div>
364	<h4>History</h4><div class="preformat">
365	Aug 2006: Sebastien Masson (smasson@lodyc.jussieu.fr)
366	</div>
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383	<h3>Statistics</h3>
384	<table class="statistics">
385	<tr><td>McCabe cyclic</td><td> 30</td></tr>
386	<tr><td>McCabe essential</td><td> 1</td></tr>
387	<tr><td>McCabe modular design</td><td> 1</td></tr>
388	</table>
389
390
391	</div>
392
393	</div>
394
395
396
397	<div id="tagline">Produced by IDLdoc 2.0.</div>
398
399	</div>
400
401	</body>
402	</html>

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

Download in other formats: