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