source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/GRILLE/tracegrille.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: 6.8 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>tracegrille.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="tracegrille.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/GRILLE//tracegrille.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="t2v.html">&lt;&lt;prev file</a> | <a href="u2t.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="tracegrille.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/GRILLE/</a></h1>
82      <h2 class="pro_file">tracegrille.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Draw the grid
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_tracegrille">
105
106          <h2><a class="top" href="#container">top</a>tracegrille <span class="categories">
107 </span></h2>
108       
109          <p class="header">
110            tracegrille<span class="result">, <a href="#_tracegrille_param_glamin">glamin</a>, <a href="#_tracegrille_param_gphiin">gphiin</a></span>, <a href="#_tracegrille_keyword_OCEAN">OCEAN</a>=<span class="result">OCEAN</span>, <a href="#_tracegrille_keyword_EARTH">EARTH</a>=<span class="result">EARTH</span>, <a href="#_tracegrille_keyword_XSTRIDE">XSTRIDE</a>=<span class="result">integer</span>, <a href="#_tracegrille_keyword_YSTRIDE">YSTRIDE</a>=<span class="result">integer</span>, <a href="#_tracegrille_keyword_RMOUT">RMOUT</a>=<span class="result">RMOUT</span>, <a href="#_tracegrille_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
111       
112          <div class="comments">
113</div>
114
115         
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_tracegrille_param_glamin">glamin&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 1d or 2d array in longitude of points of the grid.If GLAM/GLAMIN
134 is not specified, it trace the grid specified by vargrid, on the
135 domain defined by domdef.
136</div>
137           
138            <h4 id="_tracegrille_param_gphiin">gphiin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
139              <span class="attr">in</span>
140             
141             
142              <span class="attr">required</span>
143             
144             
145             
146             
147            </h4>
148       
149          <div class="comments">
150 The 1d or 2d array in latitude of points of the grid.If GPHI/GPHIIN
151 is not specified, it trace the grid specified by vargrid, on the
152 domain defined by domdef.
153</div>
154           
155
156         
157
158         
159
160            <h3>Keywords</h3>
161           
162            <h4 id="_tracegrille_keyword_OCEAN">OCEAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168             
169             
170             
171            </h4>
172       
173            <div class="comments"> 
174 To trace the grid only on ocean points.
175 </div>
176           
177            <h4 id="_tracegrille_keyword_EARTH">EARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178             
179             
180             
181             
182             
183             
184             
185             
186            </h4>
187       
188            <div class="comments">
189 To trace the grid only on land points.
190</div>
191           
192            <h4 id="_tracegrille_keyword_XSTRIDE">XSTRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
193             
194             
195             
196             
197             
198              <span class="attr">type:</span> <span class="value">integer</span>
199             
200             
201            </h4>
202       
203            <div class="comments"> 
204 It specify that we want to trace only one line of
205 constant i every xstride points
206</div>
207           
208            <h4 id="_tracegrille_keyword_YSTRIDE">YSTRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
209             
210             
211             
212             
213             
214              <span class="attr">type:</span> <span class="value">integer</span>
215             
216             
217            </h4>
218       
219            <div class="comments">
220 It specify that we want to trace only one line of
221 constant j every xstride points
222</div>
223           
224            <h4 id="_tracegrille_keyword_RMOUT">RMOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
225             
226             
227             
228             
229             
230             
231             
232             
233            </h4>
234       
235            <div class="comments">
236 Select to remove all cell having one corner out of the
237 plot boundaries (!x.range, !y.range)
238</div>
239           
240            <h4 id="_tracegrille_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
241             
242             
243             
244             
245             
246             
247             
248             
249            </h4>
250       
251            <div class="comments">
252 Used to pass your keywords.
253 </div>
254           
255         
256
257          <h3>Examples</h3><div class="preformat">
258
259     IDL> plt,indgen(jpi,jpj),/nocontour,/nofill
260     IDL> vargrid='T'
261     IDL> tracegrille,/ocean,color=20
262     IDL> tracegrille,/earth,color=80
263
264</div>
265          <h3>Version history</h3>
266         
267          <h4>Version</h4><div class="preformat">
268 $Id: tracegrille.pro 163 2006-08-29 12:59:46Z navarro $
269                  </div>
270          <h4>History</h4><div class="preformat">
271 Sebastien Masson (smasson@lodyc.jussieu.fr)
272</div>
273         
274         
275         
276         
277         
278         
279         
280       
281          <h3>Other attributes</h3>
282         
283         
284          <h4>Uses routines</h4><div class="preformat">
285 common.pro
286 </div>
287         
288         
289         
290       
291          <h3>Statistics</h3>
292          <table class="statistics">
293            <tr><td>McCabe cyclic</td><td>          34</td></tr>
294            <tr><td>McCabe essential</td><td>           1</td></tr>
295            <tr><td>McCabe modular design</td><td>           1</td></tr>
296          </table>
297         
298       
299        </div>
300       
301      </div>
302
303     
304
305      <div id="tagline">Produced by IDLdoc 2.0.</div>
306
307    </div>
308
309  </body>
310</html>
Note: See TracBrowser for help on using the repository browser.