source: trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/read_grads.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: 4.8 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>read_grads.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="ncdf_timeget.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="read_oasis.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ReadWrite/</font></h1>
58    <h2>read_grads.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 reading grads file (except "data type station" or "grib")
65 from the grads control file even if there is multiple data files.
66
67
68   
69
70     
71      <a name="#_read_grads"></a>
72
73      <h2>read_grads  <font size="-1" color="#006633"> 
74 Reading
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>read_grads(<i><a href="#_read_grads_keyword_var">var</a>, <a href="#_read_grads_keyword_date1">date1</a>[, <a href="#_read_grads_keyword_date2">date2</a>]</i>, <a href="#_read_grads_keyword_FILENAME">FILENAME</a>=<i>FILENAME</i>, <a href="#_read_grads_keyword_BOX">BOX</a>=<i>BOX</i>, <a href="#_read_grads_keyword_TIMESTEP">TIMESTEP</a>=<i>TIMESTEP</i>, <a href="#_read_grads_keyword_EVERYTHING">EVERYTHING</a>=<i>EVERYTHING</i>, <a href="#_read_grads_keyword_NOSTRUCT">NOSTRUCT</a>=<i>NOSTRUCT</i>, <a href="#_read_grads_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
78
79   
80
81   
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_read_grads_keyword_var"></a>
88    <h4>var&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89      <font size="-1" color="#006633">in</font>
90     
91     
92      <font size="-1" color="#006633">required</font>
93     
94     
95     
96     
97    </h4>
98
99   
100 the variable name
101
102   
103
104    <a name="#_read_grads_keyword_date1"></a>
105    <h4>date1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
106      <font size="-1" color="#006633">in</font>
107     
108     
109      <font size="-1" color="#006633">required</font>
110     
111     
112     
113     
114    </h4>
115
116   
117 date of the beginning (yyyymmdd if TIMESTEP is not activate)
118
119   
120
121    <a name="#_read_grads_keyword_date2"></a>
122    <h4>date2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123      <font size="-1" color="#006633">in</font>
124     
125      <font size="-1" color="#006633">optional</font>
126     
127     
128     
129     
130     
131    </h4>
132
133   
134 last date. Optional, if not specified date2=date1
135
136   
137   
138
139   
140    <h3>Keywords</h3>
141
142   
143    <a name="#_read_grads_keyword_FILENAME"></a>
144    <h4>FILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145     
146     
147     
148     
149     
150     
151     
152     
153    </h4>
154
155   
156 the grads control file name: 'xxxx.ctl'
157
158   
159    <a name="#_read_grads_keyword_BOX"></a>
160    <h4>BOX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161     
162     
163     
164     
165     
166     
167     
168     
169    </h4>
170
171   
172   
173    <a name="#_read_grads_keyword_TIMESTEP"></a>
174    <h4>TIMESTEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175     
176     
177     
178     
179     
180     
181     
182     
183    </h4>
184
185   
186 to specify that the dates are time steps instead of true calendar.
187
188   
189    <a name="#_read_grads_keyword_EVERYTHING"></a>
190    <h4>EVERYTHING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
191     
192     
193     
194     
195     
196     
197     
198     
199    </h4>
200
201   
202   
203    <a name="#_read_grads_keyword_NOSTRUCT"></a>
204    <h4>NOSTRUCT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205     
206     
207     
208     
209     
210     
211     
212     
213    </h4>
214
215   
216   
217    <a name="#_read_grads_keyword__EXTRA"></a>
218    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219     
220     
221     
222     
223     
224     
225     
226     
227    </h4>
228
229   
230   
231   
232
233   
234   
235   
236   
237   
238   
239
240   
241   
242   
243   
244   
245
246   
247   
248   
249   
250   
251   
252   
253
254    <font size="-3"><p>&nbsp;</p></font>
255    <hr size="1" color="#CCCCCC"/>
256     
257
258   
259
260    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:36 2006.</font></p>
261
262  </body>
263</html>
Note: See TracBrowser for help on using the repository browser.