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

Last change on this file since 242 was 242, checked in by pinsard, 17 years ago

improvements/corrections of some *.pro headers + replace some message by some report

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