source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/DESSINE/pltv.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation

File size: 8.4 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>pltv.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="pltt.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="pltz.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/PLOTS/DESSINE/</font></h1>
58    <h2>pltv.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Draw 2d plots with TV procedure
65
66
67   
68
69     
70      <a name="#_pltv"></a>
71
72      <h2>pltv  <font size="-1" color="#006633"> 
73 find a file
74 graphic
75</font></h2>
76
77      <p><font face="Courier">pltv<i>, <a href="#_pltv_keyword_data">data</a>[, <a href="#_pltv_keyword_min">min</a>][, <a href="#_pltv_keyword_max">max</a>]</i>, <a href="#_pltv_keyword_BOTTOM">BOTTOM</a>=<i>BOTTOM</i>, <a href="#_pltv_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_pltv_keyword_C_MASK">C_MASK</a>=<i>C_MASK</i>, <a href="#_pltv_keyword_C_NAN">C_NAN</a>=<i>C_NAN</i>, <a href="#_pltv_keyword_INV">INV</a>=<i>INV</i>, <a href="#_pltv_keyword_MININ">MININ</a>=<i>MININ</i>, <a href="#_pltv_keyword_MAXIN">MAXIN</a>=<i>MAXIN</i>, <a href="#_pltv_keyword_MASKVAL">MASKVAL</a>=<i>MASKVAL</i>, <a href="#_pltv_keyword_NCOLORS">NCOLORS</a>=<i>NCOLORS</i>, <a href="#_pltv_keyword_NOINTERP">NOINTERP</a>=<i>NOINTERP</i>, <a href="#_pltv_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
78
79   
80
81
82   
83
84   
85    <h3>Parameters</h3>
86   
87
88    <a name="#_pltv_keyword_data"></a>
89    <h4>data&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
90      <font size="-1" color="#006633">in</font>
91     
92     
93      <font size="-1" color="#006633">required</font>
94     
95     
96     
97     
98    </h4>
99
100   
101 The field we want to display can be:
102    1) an array. If the array is not a 2D array, its mean along
103       the z and t direction will be automatically performed
104       (as it is done in plt).
105    2) a structure respecting all criterions specified by
106       <a href="../../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>
107
108   
109
110    <a name="#_pltv_keyword_min"></a>
111    <h4>min&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112      <font size="-1" color="#006633">in</font>
113     
114      <font size="-1" color="#006633">optional</font>
115     
116     
117     
118      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>min of DATA (on non-masked points)</i></font>
119     
120    </h4>
121
122   
123
124   
125
126    <a name="#_pltv_keyword_max"></a>
127    <h4>max&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128      <font size="-1" color="#006633">in</font>
129     
130      <font size="-1" color="#006633">optional</font>
131     
132     
133     
134      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>max of DATA (on non-masked points)</i></font>
135     
136    </h4>
137
138   
139
140   
141   
142
143   
144    <h3>Keywords</h3>
145
146   
147    <a name="#_pltv_keyword_BOTTOM"></a>
148    <h4>BOTTOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149     
150     
151     
152     
153     
154     
155      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
156     
157    </h4>
158
159   
160 The lowest color index of the colors to be used.
161
162   
163    <a name="#_pltv_keyword_BOXZOOM"></a>
164    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165     
166     
167     
168     
169     
170     
171     
172     
173    </h4>
174
175   
176 Vector indicating the geographic zone on which we want to cut the map.
177  If BOXZOOM has :
178 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
179 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
180 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
181 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
182 6 elements: The extraction is made on Boxzoom
183
184 Where lon1, lon2, lat1, lat2 are global variables defined at the last
185 <a href="../../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> !
186
187   
188    <a name="#_pltv_keyword_C_MASK"></a>
189    <h4>C_MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
190     
191     
192     
193     
194     
195     
196      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
197     
198    </h4>
199
200   
201 The color number that should be used for the mask values.
202
203   
204    <a name="#_pltv_keyword_C_NAN"></a>
205    <h4>C_NAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
206     
207     
208     
209     
210     
211     
212      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>!d.n_colors < 255</i></font>
213     
214    </h4>
215
216   
217 The color number that should be used for the NaN values.
218
219   
220    <a name="#_pltv_keyword_INV"></a>
221    <h4>INV&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
222     
223     
224     
225     
226     
227     
228     
229     
230    </h4>
231
232   
233 Reverse the color order
234
235   
236    <a name="#_pltv_keyword_MININ"></a>
237    <h4>MININ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
238     
239     
240     
241     
242     
243     
244     
245     
246    </h4>
247
248   
249   
250    <a name="#_pltv_keyword_MAXIN"></a>
251    <h4>MAXIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
252     
253     
254     
255     
256     
257     
258     
259     
260    </h4>
261
262   
263   
264    <a name="#_pltv_keyword_MASKVAL"></a>
265    <h4>MASKVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
266     
267     
268     
269     
270     
271     
272      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1.e+20</i></font>
273     
274    </h4>
275
276   
277 The mask value. Note that if abs(mask) < 1.e6, then the
278 exact value of the mask is used to find the maskwd point.
279 if abs(mask) > 1.e6, the test to find the masked value is ge
280 abs(mask)/10. This is necessary to avoid the rounding errors
281
282   
283    <a name="#_pltv_keyword_NCOLORS"></a>
284    <h4>NCOLORS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
285     
286     
287     
288     
289     
290     
291      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>(d.n_colors < 256) - 1 - BOTTOM</i></font>
292     
293    </h4>
294
295   
296 number of colors to be used.
297
298   
299    <a name="#_pltv_keyword_NOINTERP"></a>
300    <h4>NOINTERP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
301     
302     
303     
304     
305     
306     
307     
308     
309    </h4>
310
311   
312 Used this keyword if you don't want that the values
313 are interpolated from BOTTOM using NCOLORS colors.
314 This can be for example useful when working on byte type arrays.
315
316   
317    <a name="#_pltv_keyword__EXTRA"></a>
318    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
319     
320     
321     
322     
323     
324     
325     
326     
327    </h4>
328
329   
330 Used to pass keywords to <a href="../../..//ToBeReviewed/PLOTS/DIVERS/placedessin.html">placedessin</a>, <a href="/Applications/itt/idl64/help/online_help/TV.html">TV</a>,
331 <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>,
332 <a href="../../..//ToBeReviewed/PLOTS/DIVERS/terminedessin.html">terminedessin</a>
333
334   
335   
336
337    <h3>Examples</h3><pre>
338   IDL> tvplus, dist(100)
339
340    </pre><h3>Version history</h3>
341   
342    <h4>Version</h4>
343 $Id: pltv.pro 378 2008-08-12 12:35:46Z pinsard $
344
345    <h4>History</h4>
346 Aug 2006: Sebastien Masson (smasson@lodyc.jussieu.fr)
347
348   
349
350   
351   
352   
353   
354   
355
356   
357   
358   
359   
360   
361   
362   
363
364    <font size="-3"><p>&nbsp;</p></font>
365    <hr size="1" color="#CCCCCC"/>
366     
367
368   
369
370    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
371
372  </body>
373</html>
Note: See TracBrowser for help on using the repository browser.