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

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

add idldoc html output. see Documentation/idldoc_html_output/index.html

File size: 6.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 (IDLdoc API 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 (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_tracegrille">
103
104          <h2><a class="top" href="#container">top</a>tracegrille </h2>
105       
106          <p class="header">
107            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">XSTRIDE</span>, <a href="#_tracegrille_keyword_YSTRIDE">YSTRIDE</a>=<span class="result">YSTRIDE</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>
108       
109          <div class="comments">
110 NAME:tracegrille
111
112 PURPOSE:dessine la grille
113
114 CATEGORY:
115
116 CALLING SEQUENCE:tracegrille
117 
118 INPUTS:glam et gphi, les tableaux 1d ou 2d des position en
119 longitude/latitude des points de la grille. Si glam et gphi ne sont
120 pas specifies, trace la grille specifiee par vargrid, sur le domaine
121 definit par le dernier domdef.
122
123 KEYWORD PARAMETERS:
124
125        XSTRIDE un entier pour specifier qu''on ne veut tracer
126        qu''une ligne de i constant tout les xstride points
127
128        YSTRIDE un entier pour specifier qu''on ne veut tracer
129        qu''une ligne de j constant tout les ystride points
130
131        /OCEAN: pour ne tracer la grille que sur les points oceans
132 
133        /EARTH: pour ne tracer la grille que sur les points terre
134
135        /RMOUT:select to remove all cell having one corner out of the
136        plot boundaries (!x.range, !y.range)
137
138        + tous les mots clefs de la procedure PLOTS
139
140 OUTPUTS:none
141
142 COMMON BLOCKS:common.pro
143
144 SIDE EFFECTS:
145
146 RESTRICTIONS:
147
148 EXAMPLE:
149
150     IDL> plt,indgen(jpi,jpj),/nocontour,/nofill
151     IDL> vargrid='T'
152     IDL> tracegrille,/ocean,color=20
153     IDL> tracegrille,/earth,color=80
154
155</div>
156
157         
158
159         
160            <h3>Parameters</h3>
161       
162           
163            <h4 id="_tracegrille_param_glamin">glamin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164             
165             
166             
167             
168             
169             
170             
171             
172            </h4>
173       
174          <div class="comments"></div>
175           
176            <h4 id="_tracegrille_param_gphiin">gphiin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177             
178             
179             
180             
181             
182             
183             
184             
185            </h4>
186       
187          <div class="comments"></div>
188           
189
190         
191
192         
193
194            <h3>Keywords</h3>
195           
196            <h4 id="_tracegrille_keyword_OCEAN">OCEAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
197             
198             
199             
200             
201             
202             
203             
204             
205            </h4>
206       
207            <div class="comments"></div>
208           
209            <h4 id="_tracegrille_keyword_EARTH">EARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
210             
211             
212             
213             
214             
215             
216             
217             
218            </h4>
219       
220            <div class="comments"></div>
221           
222            <h4 id="_tracegrille_keyword_XSTRIDE">XSTRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223             
224             
225             
226             
227             
228             
229             
230             
231            </h4>
232       
233            <div class="comments"></div>
234           
235            <h4 id="_tracegrille_keyword_YSTRIDE">YSTRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236             
237             
238             
239             
240             
241             
242             
243             
244            </h4>
245       
246            <div class="comments"></div>
247           
248            <h4 id="_tracegrille_keyword_RMOUT">RMOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
249             
250             
251             
252             
253             
254             
255             
256             
257            </h4>
258       
259            <div class="comments"></div>
260           
261            <h4 id="_tracegrille_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
262             
263             
264             
265             
266             
267             
268             
269             
270            </h4>
271       
272            <div class="comments"></div>
273           
274         
275
276         
277         
278         
279         
280         
281         
282         
283         
284         
285         
286         
287         
288       
289         
290         
291         
292         
293         
294         
295         
296       
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.