source: trunk/SRC/Documentation/idldoc_html_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: 7.1 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>read_grads.pro (SAXO 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="read_grads.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO 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" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../ReadWrite//read_grads.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" 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="ncdf_gettime.html">&lt;&lt;prev file</a> | <a href="read_oasis.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="read_grads.html" target="_TOP">view single page</a> | <a href="./../index.html" 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">ReadWrite/</a></h1>
82      <h2 class="pro_file">read_grads.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 reading grads file (except "data type station" or "grib")
91 from the grads control file even if there is multiple data files.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_read_grads">
106
107          <h2><a class="top" href="#container">top</a>read_grads <span class="categories">
108 Reading
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>read_grads(<span class="result"><a href="#_read_grads_param_var">var</a>, <a href="#_read_grads_param_date1">date1</a>[, <a href="#_read_grads_param_date2">date2</a>]</span>, <a href="#_read_grads_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_grads_keyword_BOX">BOX</a>=<span class="result">A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, depth2]</span>, <a href="#_read_grads_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">TIMESTEP</span>, <a href="#_read_grads_keyword_EVERYTHING">EVERYTHING</a>=<span class="result">EVERYTHING</span>, <a href="#_read_grads_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">NOSTRUCT</span>, <a href="#_read_grads_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 an array
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_read_grads_param_var">var&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 the variable name
138</div>
139           
140            <h4 id="_read_grads_param_date1">date1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142             
143             
144              <span class="attr">required</span>
145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments">
152 date of the beginning (yyyymmdd if TIMESTEP is not activate)
153</div>
154           
155            <h4 id="_read_grads_param_date2">date2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156              <span class="attr">in</span>
157             
158              <span class="attr">optional</span>
159             
160             
161             
162             
163             
164            </h4>
165       
166          <div class="comments">
167 last date. Optional, if not specified date2=date1
168</div>
169           
170
171         
172
173         
174
175            <h3>Keywords</h3>
176           
177            <h4 id="_read_grads_keyword_FILENAME">FILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178             
179             
180             
181             
182             
183             
184             
185             
186            </h4>
187       
188            <div class="comments">
189 the grads control file name: 'xxxx.ctl'
190</div>
191           
192            <h4 id="_read_grads_keyword_BOX">BOX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
193             
194             
195             
196             
197             
198              <span class="attr">type:</span> <span class="value">A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, depth2]</span>
199             
200             
201            </h4>
202       
203            <div class="comments">
204 It specifies the area where data must be read
205</div>
206           
207            <h4 id="_read_grads_keyword_TIMESTEP">TIMESTEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208             
209             
210             
211             
212             
213             
214             
215             
216            </h4>
217       
218            <div class="comments">
219 to specify that the dates are time steps instead of true calendar.
220
221 NOT yet available
222</div>
223           
224            <h4 id="_read_grads_keyword_EVERYTHING">EVERYTHING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
225             
226             
227             
228             
229             
230             
231             
232             
233            </h4>
234       
235            <div class="comments">
236</div>
237           
238            <h4 id="_read_grads_keyword_NOSTRUCT">NOSTRUCT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
239             
240             
241             
242             
243             
244             
245             
246             
247            </h4>
248       
249            <div class="comments">
250</div>
251           
252            <h4 id="_read_grads_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
253             
254             
255             
256             
257             
258             
259             
260             
261            </h4>
262       
263            <div class="comments">
264 Used to pass keywords
265</div>
266           
267         
268
269          <h3>Examples</h3><div class="preformat">
270 IDL> a=read_grads('sst',19900101,19900131,filename='outputs.ctl')
271 IDL> plt, a
272</div>
273          <h3>Version history</h3>
274         
275          <h4>Version</h4><div class="preformat">
276 $Id: read_grads.pro 327 2007-12-13 16:22:35Z pinsard $
277</div>
278          <h4>History</h4><div class="preformat">
279 Sebastien Masson (smasson@lodyc.jussieu.fr)
280</div>
281         
282         
283          <h3>Known issues</h3>
284         
285         
286         
287          <h4>Restrictions</h4><div class="preformat">
288 define all the grid parameters (defined in common.pro)
289 associated to the data.
290
291 this function call the procedure scanfile that use the
292 unix commands grep and sed
293</div>
294       
295          <h3>Other attributes</h3>
296         
297         
298          <h4>Uses routines</h4><div class="preformat">
299 common
300</div>
301         
302         
303         
304       
305          <h3>Statistics</h3>
306          <table class="statistics">
307            <tr><td>McCabe cyclic</td><td>          55</td></tr>
308            <tr><td>McCabe essential</td><td>           2</td></tr>
309            <tr><td>McCabe modular design</td><td>           1</td></tr>
310          </table>
311         
312       
313        </div>
314       
315      </div>
316
317     
318
319      <div id="tagline">Produced by IDLdoc 2.0.</div>
320
321    </div>
322
323  </body>
324</html>
Note: See TracBrowser for help on using the repository browser.