source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/GRILLE/tracegrille.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 7.2 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 Grid
108</span></h2>
109       
110          <p class="header">
111            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>
112       
113          <div class="comments">
114</div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_tracegrille_param_glamin">glamin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125              <span class="attr">optional</span>
126             
127             
128              <span class="attr">type:</span> <span class="value">1d or 2d array</span>
129              <span class="attr">default:</span> <span class="value">glam specified by vargrid, on the domain defined by <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a></span>
130             
131            </h4>
132       
133          <div class="comments">
134 Longitude of points of the grid.
135</div>
136           
137            <h4 id="_tracegrille_param_gphiin">gphiin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138              <span class="attr">in</span>
139             
140              <span class="attr">optional</span>
141             
142             
143              <span class="attr">type:</span> <span class="value">1d or 2d array</span>
144              <span class="attr">default:</span> <span class="value">gphi specified by vargrid, on the domain defined by <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a></span>
145             
146            </h4>
147       
148          <div class="comments">
149 Latitude of points of the grid.
150</div>
151           
152
153         
154
155         
156
157            <h3>Keywords</h3>
158           
159            <h4 id="_tracegrille_keyword_OCEAN">OCEAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160             
161             
162             
163             
164             
165             
166             
167             
168            </h4>
169       
170            <div class="comments">
171 To trace the grid only on ocean points.
172</div>
173           
174            <h4 id="_tracegrille_keyword_EARTH">EARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175             
176             
177             
178             
179             
180             
181             
182             
183            </h4>
184       
185            <div class="comments">
186 To trace the grid only on land points.
187</div>
188           
189            <h4 id="_tracegrille_keyword_XSTRIDE">XSTRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
190             
191             
192             
193             
194             
195              <span class="attr">type:</span> <span class="value">integer</span>
196              <span class="attr">default:</span> <span class="value">1</span>
197             
198            </h4>
199       
200            <div class="comments">
201 It specify that we want to trace only one line of
202 constant i every xstride points
203</div>
204           
205            <h4 id="_tracegrille_keyword_YSTRIDE">YSTRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
206             
207             
208             
209             
210             
211              <span class="attr">type:</span> <span class="value">integer</span>
212              <span class="attr">default:</span> <span class="value">1</span>
213             
214            </h4>
215       
216            <div class="comments">
217 It specify that we want to trace only one line of
218 constant j every ystride points
219</div>
220           
221            <h4 id="_tracegrille_keyword_RMOUT">RMOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
222             
223             
224             
225             
226             
227             
228             
229             
230            </h4>
231       
232            <div class="comments">
233 Select to remove all cell having one corner out of the
234 plot boundaries (!x.range, !y.range)
235</div>
236           
237            <h4 id="_tracegrille_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
238             
239             
240             
241             
242             
243             
244             
245             
246            </h4>
247       
248            <div class="comments">
249 Used to pass keywords
250</div>
251           
252         
253
254          <h3>Examples</h3><div class="preformat">
255
256   IDL> plt,indgen(jpi,jpj),/nocontour,/nofill
257   IDL> vargrid='T'
258   IDL> tracegrille,/ocean,color=20
259   IDL> tracegrille,/earth,color=80
260</div>
261          <h3>Version history</h3>
262         
263          <h4>Version</h4><div class="preformat">
264 $Id: tracegrille.pro 378 2008-08-12 12:35:46Z pinsard $
265</div>
266          <h4>History</h4><div class="preformat">
267 Sebastien Masson (smasson@lodyc.jussieu.fr)
268</div>
269         
270         
271         
272         
273         
274         
275         
276       
277          <h3>Other attributes</h3>
278         
279         
280          <h4>Uses routines</h4><div class="preformat">
281 <a href="../..//Obsolete/common.html">common</a>
282</div>
283         
284         
285         
286       
287          <h3>Statistics</h3>
288          <table class="statistics">
289            <tr><td>McCabe cyclic</td><td>          34</td></tr>
290            <tr><td>McCabe essential</td><td>           1</td></tr>
291            <tr><td>McCabe modular design</td><td>           1</td></tr>
292          </table>
293         
294       
295        </div>
296       
297      </div>
298
299     
300
301      <div id="tagline">Produced by IDLdoc 2.0.</div>
302
303    </div>
304
305  </body>
306</html>
Note: See TracBrowser for help on using the repository browser.