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

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 5.9 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 Grid
74</font></h2>
75
76      <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>
77
78   
79
80
81   
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_tracegrille_keyword_glamin"></a>
88    <h4>glamin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89      <font size="-1" color="#006633">in</font>
90     
91      <font size="-1" color="#006633">optional</font>
92     
93     
94      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1d or 2d array</i></font>
95      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>glam specified by vargrid, on the domain defined by <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a></i></font>
96     
97    </h4>
98
99   
100 Longitude of points of the grid.
101
102   
103
104    <a name="#_tracegrille_keyword_gphiin"></a>
105    <h4>gphiin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
106      <font size="-1" color="#006633">in</font>
107     
108      <font size="-1" color="#006633">optional</font>
109     
110     
111      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1d or 2d array</i></font>
112      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>gphi specified by vargrid, on the domain defined by <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a></i></font>
113     
114    </h4>
115
116   
117 Latitude of points of the grid.
118
119   
120   
121
122   
123    <h3>Keywords</h3>
124
125   
126    <a name="#_tracegrille_keyword_OCEAN"></a>
127    <h4>OCEAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128     
129     
130     
131     
132     
133     
134     
135     
136    </h4>
137
138   
139 To trace the grid only on ocean points.
140
141   
142    <a name="#_tracegrille_keyword_EARTH"></a>
143    <h4>EARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144     
145     
146     
147     
148     
149     
150     
151     
152    </h4>
153
154   
155 To trace the grid only on land points.
156
157   
158    <a name="#_tracegrille_keyword_XSTRIDE"></a>
159    <h4>XSTRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160     
161     
162     
163     
164     
165      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
166      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
167     
168    </h4>
169
170   
171 It specify that we want to trace only one line of
172 constant i every xstride points
173
174   
175    <a name="#_tracegrille_keyword_YSTRIDE"></a>
176    <h4>YSTRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177     
178     
179     
180     
181     
182      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>integer</i></font>
183      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
184     
185    </h4>
186
187   
188 It specify that we want to trace only one line of
189 constant j every xstride points
190
191   
192    <a name="#_tracegrille_keyword_RMOUT"></a>
193    <h4>RMOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
194     
195     
196     
197     
198     
199     
200     
201     
202    </h4>
203
204   
205 Select to remove all cell having one corner out of the
206 plot boundaries (!x.range, !y.range)
207
208   
209    <a name="#_tracegrille_keyword__EXTRA"></a>
210    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
211     
212     
213     
214     
215     
216     
217     
218     
219    </h4>
220
221   
222 Used to pass keywords
223
224   
225   
226
227    <h3>Examples</h3><pre>
228
229     IDL> plt,indgen(jpi,jpj),/nocontour,/nofill
230     IDL> vargrid='T'
231     IDL> tracegrille,/ocean,color=20
232     IDL> tracegrille,/earth,color=80
233
234
235    </pre><h3>Version history</h3>
236   
237    <h4>Version</h4>
238 $Id: tracegrille.pro 327 2007-12-13 16:22:35Z pinsard $
239
240    <h4>History</h4>
241 Sebastien Masson (smasson@lodyc.jussieu.fr)
242
243   
244
245   
246   
247   
248   
249   
250
251    <h3>Other attributes</h3>
252   
253   
254    <h4>Uses routines</h4>
255 common.pro
256
257   
258   
259   
260
261    <font size="-3"><p>&nbsp;</p></font>
262    <hr size="1" color="#CCCCCC"/>
263     
264
265   
266
267    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
268
269  </body>
270</html>
Note: See TracBrowser for help on using the repository browser.