source: trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/read_grads.html @ 338

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

update documentation
File size: 5.7 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_gettime.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>A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, depth2]</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    <h3>Return value</h3>
83 an array
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_read_grads_keyword_var"></a>
91    <h4>var&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97     
98     
99     
100    </h4>
101
102   
103 the variable name
104
105   
106
107    <a name="#_read_grads_keyword_date1"></a>
108    <h4>date1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109      <font size="-1" color="#006633">in</font>
110     
111     
112      <font size="-1" color="#006633">required</font>
113     
114     
115     
116     
117    </h4>
118
119   
120 date of the beginning (yyyymmdd if TIMESTEP is not activate)
121
122   
123
124    <a name="#_read_grads_keyword_date2"></a>
125    <h4>date2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126      <font size="-1" color="#006633">in</font>
127     
128      <font size="-1" color="#006633">optional</font>
129     
130     
131     
132     
133     
134    </h4>
135
136   
137 last date. Optional, if not specified date2=date1
138
139   
140   
141
142   
143    <h3>Keywords</h3>
144
145   
146    <a name="#_read_grads_keyword_FILENAME"></a>
147    <h4>FILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148     
149     
150     
151     
152     
153     
154     
155     
156    </h4>
157
158   
159 the grads control file name: 'xxxx.ctl'
160
161   
162    <a name="#_read_grads_keyword_BOX"></a>
163    <h4>BOX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
164     
165     
166     
167     
168     
169      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, depth2]</i></font>
170     
171     
172    </h4>
173
174   
175 It specifies the area where data must be read
176
177   
178    <a name="#_read_grads_keyword_TIMESTEP"></a>
179    <h4>TIMESTEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180     
181     
182     
183     
184     
185     
186     
187     
188    </h4>
189
190   
191 to specify that the dates are time steps instead of true calendar.
192
193 NOT yet available
194
195   
196    <a name="#_read_grads_keyword_EVERYTHING"></a>
197    <h4>EVERYTHING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198     
199     
200     
201     
202     
203     
204     
205     
206    </h4>
207
208   
209
210   
211    <a name="#_read_grads_keyword_NOSTRUCT"></a>
212    <h4>NOSTRUCT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
213     
214     
215     
216     
217     
218     
219     
220     
221    </h4>
222
223   
224
225   
226    <a name="#_read_grads_keyword__EXTRA"></a>
227    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
228     
229     
230     
231     
232     
233     
234     
235     
236    </h4>
237
238   
239 Used to pass keywords
240
241   
242   
243
244    <h3>Examples</h3><pre>
245 IDL> a=read_grads('sst',19900101,19900131,filename='outputs.ctl')
246 IDL> plt, a
247
248    </pre><h3>Version history</h3>
249   
250    <h4>Version</h4>
251 $Id: read_grads.pro 327 2007-12-13 16:22:35Z pinsard $
252
253    <h4>History</h4>
254 Sebastien Masson (smasson@lodyc.jussieu.fr)
255
256   
257
258    <h3>Known issues</h3>
259   
260   
261   
262    <h4>Restrictions</h4>
263 define all the grid parameters (defined in common.pro)
264 associated to the data.
265
266 this function call the procedure scanfile that use the
267 unix commands grep and sed
268
269
270    <h3>Other attributes</h3>
271   
272   
273    <h4>Uses routines</h4>
274 common
275
276   
277   
278   
279
280    <font size="-3"><p>&nbsp;</p></font>
281    <hr size="1" color="#CCCCCC"/>
282     
283
284   
285
286    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
287
288  </body>
289</html>
Note: See TracBrowser for help on using the repository browser.