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

Last change on this file since 290 was 290, checked in by smasson, 17 years ago

update documentation

File size: 7.0 KB
RevLine 
[89]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>
[104]9    <title>pltsc.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="pltsc.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../../../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../../../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../../../ToBeReviewed/PLOTS/DESSINE//pltsc.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]74<a href="pltbase.html">&lt;&lt;prev file</a> | <a href="pltt.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="pltsc.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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/PLOTS/DESSINE/</a></h1>
[89]82      <h2 class="pro_file">pltsc.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[163]89      <div id="file_comments">
90</div>
91
[89]92     
93
94     
95
96     
97
98     
99
100      <div id="routine_details">
101       
102
103        <div class="routine_details" id="_pltsc">
104
[163]105          <h2><a class="top" href="#container">top</a>pltsc <span class="categories">
106</span></h2>
[89]107       
108          <p class="header">
[234]109            pltsc<span class="result">, <a href="#_pltsc_param_tab1">tab1</a>, <a href="#_pltsc_param_tab2">tab2</a>, <a href="#_pltsc_param_min1">min1</a>, <a href="#_pltsc_param_max1">max1</a>, <a href="#_pltsc_param_min2">min2</a>, <a href="#_pltsc_param_max2">max2</a>, <a href="#_pltsc_param_varname2">varname2</a></span>, <a href="#_pltsc_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_pltsc_keyword_COL1D">COL1D</a>=<span class="result">COL1D</span>, <a href="#_pltsc_keyword_STY1D">STY1D</a>=<span class="result">STY1D</span>, <a href="#_pltsc_keyword_OV1D">OV1D</a>=<span class="result">OV1D</span>, <a href="#_pltsc_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
[89]110       
[163]111          <div class="comments"></div>
112
113          <h3>Return value</h3><div class="preformat">
[142]114</div>
[89]115
116         
117            <h3>Parameters</h3>
118       
119           
120            <h4 id="_pltsc_param_tab1">tab1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
121             
122             
123             
124             
125             
126             
127             
128             
129            </h4>
130       
[163]131          <div class="comments">
132</div>
[89]133           
134            <h4 id="_pltsc_param_tab2">tab2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
135             
136             
137             
138             
139             
140             
141             
142             
143            </h4>
144       
[163]145          <div class="comments">
146</div>
[89]147           
148            <h4 id="_pltsc_param_min1">min1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149             
150             
151             
152             
153             
154             
155             
156             
157            </h4>
158       
[163]159          <div class="comments">
160</div>
[89]161           
162            <h4 id="_pltsc_param_max1">max1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168             
169             
170             
171            </h4>
172       
[163]173          <div class="comments">
174</div>
[89]175           
176            <h4 id="_pltsc_param_min2">min2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177             
178             
179             
180             
181             
182             
183             
184             
185            </h4>
186       
[163]187          <div class="comments">
188</div>
[89]189           
190            <h4 id="_pltsc_param_max2">max2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
191             
192             
193             
194             
195             
196             
197             
198             
199            </h4>
200       
[163]201          <div class="comments">
202</div>
[89]203           
204            <h4 id="_pltsc_param_varname2">varname2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205             
206             
207             
208             
209             
210             
211             
212             
213            </h4>
214       
[163]215          <div class="comments">
216</div>
[89]217           
218
219         
220
221         
222
223            <h3>Keywords</h3>
224           
225            <h4 id="_pltsc_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
226             
227             
228             
229             
230             
231             
232             
233             
234            </h4>
235       
[163]236            <div class="comments">
[234]237 Vector indicating the geographic zone on which we want to cut the map.
[163]238  If BOXZOOM has :
239 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
240 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
241 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
242 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
243 6 elements: The extraction is made on Boxzoom
244</div>
[89]245           
246            <h4 id="_pltsc_keyword_COL1D">COL1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
247             
248             
249             
250             
251             
252             
253             
254             
255            </h4>
256       
[163]257            <div class="comments">
258</div>
[89]259           
260            <h4 id="_pltsc_keyword_STY1D">STY1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
261             
262             
263             
264             
265             
266             
267             
268             
269            </h4>
270       
[163]271            <div class="comments">
272</div>
[89]273           
274            <h4 id="_pltsc_keyword_OV1D">OV1D&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
275             
276             
277             
278             
279             
280             
281             
282             
283            </h4>
284       
[163]285            <div class="comments">
286</div>
[89]287           
[234]288            <h4 id="_pltsc_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]289             
290             
291             
292             
293             
294             
295             
296             
297            </h4>
298       
[163]299            <div class="comments">
[234]300 Used to pass keywords
[163]301</div>
[89]302           
303         
304
[163]305          <h3>Examples</h3><div class="preformat">
306</div>
307          <h3>Version history</h3>
[89]308         
[163]309          <h4>Version</h4><div class="preformat">
[290]310 $Id: pltsc.pro 262 2007-08-21 14:19:32Z pinsard $
[163]311</div>
312          <h4>History</h4><div class="preformat">
313</div>
[89]314         
315         
[142]316          <h3>Known issues</h3>
[89]317         
318         
[142]319          <h4>Todo items</h4><div class="preformat"> seb
320</div>
[163]321          <h4>Restrictions</h4><div class="preformat">
322</div>
[89]323       
[163]324          <h3>Other attributes</h3>
[89]325         
326         
[163]327          <h4>Uses routines</h4><div class="preformat">
328</div>
[89]329         
330         
331         
332       
[163]333          <h3>Statistics</h3>
334          <table class="statistics">
335            <tr><td>McCabe cyclic</td><td>          24</td></tr>
336            <tr><td>McCabe essential</td><td>           3</td></tr>
337            <tr><td>McCabe modular design</td><td>           3</td></tr>
338          </table>
[89]339         
340       
341        </div>
342       
343      </div>
344
345     
346
347      <div id="tagline">Produced by IDLdoc 2.0.</div>
348
349    </div>
350
351  </body>
[249]352</html>
Note: See TracBrowser for help on using the repository browser.