source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/GRILLE/tracegrille.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 5.4 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>tracegrille.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="t2v.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="u2t.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/GRILLE/</font></h1>
58    <h2>tracegrille.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Draw the grid
65
66
67   
68
69     
70      <a name="#_tracegrille"></a>
71
72      <h2>tracegrille  <font size="-1" color="#006633">
73 </font></h2>
74
75      <p><font face="Courier">tracegrille<i>, <a href="#_tracegrille_keyword_glamin">glamin</a>, <a href="#_tracegrille_keyword_gphiin">gphiin</a></i>, <a href="#_tracegrille_keyword_OCEAN">OCEAN</a>=<i>OCEAN</i>, <a href="#_tracegrille_keyword_EARTH">EARTH</a>=<i>EARTH</i>, <a href="#_tracegrille_keyword_XSTRIDE">XSTRIDE</a>=<i>integer</i>, <a href="#_tracegrille_keyword_YSTRIDE">YSTRIDE</a>=<i>integer</i>, <a href="#_tracegrille_keyword_RMOUT">RMOUT</a>=<i>RMOUT</i>, <a href="#_tracegrille_keyword__extra">_extra</a>=<i>_extra</i></font></p>
76
77   
78
79
80   
81
82   
83    <h3>Parameters</h3>
84   
85
86    <a name="#_tracegrille_keyword_glamin"></a>
87    <h4>glamin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
88      <font size="-1" color="#006633">in</font>
89     
90     
91      <font size="-1" color="#006633">required</font>
92     
93     
94     
95     
96    </h4>
97
98   
99 The 1d or 2d array in longitude of points of the grid.If GLAM/GLAMIN
100 is not specified, it trace the grid specified by vargrid, on the
101 domain defined by domdef.
102
103   
104
105    <a name="#_tracegrille_keyword_gphiin"></a>
106    <h4>gphiin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
107      <font size="-1" color="#006633">in</font>
108     
109     
110      <font size="-1" color="#006633">required</font>
111     
112     
113     
114     
115    </h4>
116
117   
118 The 1d or 2d array in latitude of points of the grid.If GPHI/GPHIIN
119 is not specified, it trace the grid specified by vargrid, on the
120 domain defined by domdef.
121
122   
123   
124
125   
126    <h3>Keywords</h3>
127
128   
129    <a name="#_tracegrille_keyword_OCEAN"></a>
130    <h4>OCEAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131     
132     
133     
134     
135     
136     
137     
138     
139    </h4>
140
141     
142 To trace the grid only on ocean points.
143 
144   
145    <a name="#_tracegrille_keyword_EARTH"></a>
146    <h4>EARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147     
148     
149     
150     
151     
152     
153     
154     
155    </h4>
156
157   
158 To trace the grid only on land points.
159
160   
161    <a name="#_tracegrille_keyword_XSTRIDE"></a>
162    <h4>XSTRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163     
164     
165     
166     
167     
168      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
169     
170     
171    </h4>
172
173     
174 It specify that we want to trace only one line of
175 constant i every xstride points
176
177   
178    <a name="#_tracegrille_keyword_YSTRIDE"></a>
179    <h4>YSTRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180     
181     
182     
183     
184     
185      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
186     
187     
188    </h4>
189
190   
191 It specify that we want to trace only one line of
192 constant j every xstride points
193
194   
195    <a name="#_tracegrille_keyword_RMOUT"></a>
196    <h4>RMOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
197     
198     
199     
200     
201     
202     
203     
204     
205    </h4>
206
207   
208 Select to remove all cell having one corner out of the
209 plot boundaries (!x.range, !y.range)
210
211   
212    <a name="#_tracegrille_keyword__extra"></a>
213    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
214     
215     
216     
217     
218     
219     
220     
221     
222    </h4>
223
224   
225 Used to pass your keywords.
226 
227   
228   
229
230    <h3>Examples</h3>
231
232     IDL> plt,indgen(jpi,jpj),/nocontour,/nofill
233     IDL> vargrid='T'
234     IDL> tracegrille,/ocean,color=20
235     IDL> tracegrille,/earth,color=80
236
237
238    <h3>Version history</h3>
239   
240    <h4>Version</h4>
241 $Id: tracegrille.pro 157 2006-08-21 09:01:50Z navarro $
242                 
243    <h4>History</h4>
244 Sebastien Masson (smasson@lodyc.jussieu.fr)
245
246   
247
248   
249   
250   
251   
252   
253
254    <h3>Other attributes</h3>
255   
256   
257    <h4>Uses routines</h4>
258 common.pro
259 
260   
261   
262   
263
264    <font size="-3"><p>&nbsp;</p></font>
265    <hr size="1" color="#CCCCCC"/>
266     
267
268   
269
270    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:56 2006.</font></p>
271
272  </body>
273</html>
Note: See TracBrowser for help on using the repository browser.