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

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 9.1 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&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="pltt.html">&lt;&lt;prev file</a> | <a href="pltz.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="pltv.html" target="_TOP">view single page</a> | <a href="./../../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;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_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"></div>
114
115         
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_pltv_param_data">data&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122              <span class="attr">in</span>
123             
124             
125              <span class="attr">required</span>
126             
127             
128             
129             
130            </h4>
131       
132          <div class="comments"> 
133 The field we want to display can be:
134    1) an array. If the array is not a 2D array, its mean along
135       the z and t direction will be automatically performed
136       (as it is done in plt).
137    2) a structure respecting all criterions specified by
138       litchamp.pro. cf. IDL> xhelp,'litchamp'
139</div>
140           
141            <h4 id="_pltv_param_min">min&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142              <span class="attr">in</span>
143             
144              <span class="attr">optional</span>
145             
146             
147             
148              <span class="attr">default:</span> <span class="value">min of DATA (on non-masked points)</span>
149             
150            </h4>
151       
152          <div class="comments"> 
153</div>
154           
155            <h4 id="_pltv_param_max">max&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156              <span class="attr">in</span>
157             
158              <span class="attr">optional</span>
159             
160             
161             
162              <span class="attr">default:</span> <span class="value">max of DATA (on non-masked points)</span>
163             
164            </h4>
165       
166          <div class="comments"> 
167</div>
168           
169
170         
171
172         
173
174            <h3>Keywords</h3>
175           
176            <h4 id="_pltv_keyword_BOTTOM">BOTTOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177             
178             
179             
180             
181             
182             
183              <span class="attr">default:</span> <span class="value">0</span>
184             
185            </h4>
186       
187            <div class="comments">
188 The lowest color index of the colors to be used
189</div>
190           
191            <h4 id="_pltv_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192             
193             
194             
195             
196             
197             
198             
199             
200            </h4>
201       
202            <div class="comments"> 
203 Vector indicating the geographic zone on which we want to cut the map.
204  If BOXZOOM has :
205 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
206 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
207 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
208 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
209 6 elements: The extraction is made on Boxzoom
210
211 Where lon1, lon2, lat1, lat2 are global variables defined at the last domdef!
212</div>
213           
214            <h4 id="_pltv_keyword_C_MASK">C_MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215             
216             
217             
218             
219             
220             
221              <span class="attr">default:</span> <span class="value">0</span>
222             
223            </h4>
224       
225            <div class="comments">
226 The color number that should be used for the mask values.
227</div>
228           
229            <h4 id="_pltv_keyword_C_NAN">C_NAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
230             
231             
232             
233             
234             
235             
236              <span class="attr">default:</span> <span class="value">!d.n_colors < 255</span>
237             
238            </h4>
239       
240            <div class="comments">
241 The color number that should be used for the NaN values.
242</div>
243           
244            <h4 id="_pltv_keyword_MININ">MININ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
245             
246             
247             
248             
249             
250             
251             
252             
253            </h4>
254       
255            <div class="comments"></div>
256           
257            <h4 id="_pltv_keyword_MAXIN">MAXIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
258             
259             
260             
261             
262             
263             
264             
265             
266            </h4>
267       
268            <div class="comments"></div>
269           
270            <h4 id="_pltv_keyword_MASKVAL">MASKVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
271             
272             
273             
274             
275             
276             
277              <span class="attr">default:</span> <span class="value">1.e+20</span>
278             
279            </h4>
280       
281            <div class="comments">
282 The mask value. Note that if abs(mask) < 1.e6, then the
283 exact value of the mask is used to find the maskwd point.
284 if abs(mask) > 1.e6, the test to find the masked value is ge
285 abs(mask)/10. This is necessary to avoid the rounding errors
286</div>
287           
288            <h4 id="_pltv_keyword_NCOLORS">NCOLORS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
289             
290             
291             
292             
293             
294             
295              <span class="attr">default:</span> <span class="value">(d.n_colors < 256) - 1 - BOTTOM</span>
296             
297            </h4>
298       
299            <div class="comments">
300 number of colors to be used.
301</div>
302           
303            <h4 id="_pltv_keyword_NOINTERP">NOINTERP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
304             
305             
306             
307             
308             
309             
310             
311             
312            </h4>
313       
314            <div class="comments">
315 Used this keyword if you don't want that the values
316 are interpolated from BOTTOM using NCOLORS colors.
317 This can be for example useful when working on byte type arrays.
318</div>
319           
320            <h4 id="_pltv_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
321             
322             
323             
324             
325             
326             
327             
328             
329            </h4>
330       
331            <div class="comments">
332 used to pass keywords to PLACEDESSIN, TV, AXE, LEGENDE, BARRECOULEUR, TERMINEDESSIN
333 </div>
334           
335         
336
337          <h3>Examples</h3><div class="preformat">
338 IDL> tvplus, dist(100)
339</div>
340          <h3>Version history</h3>
341         
342          <h4>Version</h4><div class="preformat">
343 $Id: pltv.pro 181 2006-09-15 08:24:36Z smasson $
344</div>
345          <h4>History</h4><div class="preformat">
346 Aug 2006: Sebastien Masson (smasson@lodyc.jussieu.fr)
347</div>
348         
349         
350         
351         
352         
353         
354         
355       
356         
357         
358         
359         
360         
361         
362         
363       
364          <h3>Statistics</h3>
365          <table class="statistics">
366            <tr><td>McCabe cyclic</td><td>          26</td></tr>
367            <tr><td>McCabe essential</td><td>           1</td></tr>
368            <tr><td>McCabe modular design</td><td>           1</td></tr>
369          </table>
370         
371       
372        </div>
373       
374      </div>
375
376     
377
378      <div id="tagline">Produced by IDLdoc 2.0.</div>
379
380    </div>
381
382  </body>
383</html>
Note: See TracBrowser for help on using the repository browser.