source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/read_oasis.html @ 107

Last change on this file since 107 was 107, checked in by smasson, 18 years ago

bugfix in ead/write_oasis
File size: 5.7 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_oasis.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_oasis.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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" 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="read_grads.html">&lt;&lt;prev file</a> | <a href="readbat.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="read_oasis.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" 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?format=raw">ReadWrite/</a></h1>
82      <h2 class="pro_file">read_oasis.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> read the f77 unformated files used in Oasis (version < 2.5) 
90</div>
91
92     
93
94     
95
96     
97
98     
99
100      <div id="routine_details">
101       
102
103        <div class="routine_details" id="_read_oasis">
104
105          <h2><a class="top" href="#container">top</a>read_oasis <span class="categories"> reading
106</span></h2>
107       
108          <p class="header">
109            <span class="result">result = </span>read_oasis(<span class="result"><a href="#_read_oasis_param_filename">filename</a>, <a href="#_read_oasis_param_varname">varname</a>, <a href="#_read_oasis_param_jpi">jpi</a>, <a href="#_read_oasis_param_jpj">jpj</a>, <a href="#_read_oasis_param_I2">I2</a></span>, <a href="#_read_oasis_keyword_I4">I4</a>=<span class="result">I4</span>, <a href="#_read_oasis_keyword_I8">I8</a>=<span class="result">I8</span>, <a href="#_read_oasis_keyword_R4">R4</a>=<span class="result">R4</span>)</p>
110       
111          <div class="comments"></div>
112
113          <h3>Return value</h3><div class="value"> a 2d array
114</div>
115
116         
117            <h3>Parameters</h3>
118       
119           
120            <h4 id="_read_oasis_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
121              <span class="attr">in</span>
122             
123             
124              <span class="attr">required</span>
125             
126             
127             
128             
129            </h4>
130       
131          <div class="comments"> the filename</div>
132           
133            <h4 id="_read_oasis_param_varname">varname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134              <span class="attr">in</span>
135             
136             
137              <span class="attr">required</span>
138             
139             
140             
141             
142            </h4>
143       
144          <div class="comments"> the name of the variable to be read</div>
145           
146            <h4 id="_read_oasis_param_jpi">jpi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147              <span class="attr">in</span>
148             
149             
150              <span class="attr">required</span>
151             
152             
153             
154             
155            </h4>
156       
157          <div class="comments"></div>
158           
159            <h4 id="_read_oasis_param_jpj">jpj&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160              <span class="attr">in</span>
161             
162             
163              <span class="attr">required</span>
164             
165             
166             
167             
168            </h4>
169       
170          <div class="comments"> 
171        the size of the 2d array to be read
172</div>
173           
174            <h4 id="_read_oasis_param_I2">I2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175             
176             
177             
178             
179             
180             
181             
182             
183            </h4>
184       
185          <div class="comments"></div>
186           
187
188         
189
190         
191
192            <h3>Keywords</h3>
193           
194            <h4 id="_read_oasis_keyword_I4">I4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195             
196             
197             
198             
199             
200             
201             
202             
203            </h4>
204       
205            <div class="comments"></div>
206           
207            <h4 id="_read_oasis_keyword_I8">I8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208             
209             
210             
211             
212             
213             
214             
215             
216            </h4>
217       
218            <div class="comments"></div>
219           
220            <h4 id="_read_oasis_keyword_R4">R4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
221             
222             
223             
224             
225             
226             
227             
228             
229            </h4>
230       
231            <div class="comments">
232 to change the defaut format (R8) of the data to be read.
233</div>
234           
235         
236
237          <h3>Examples</h3><div class="value">
238 IDL> a=read_oasis('grids_orca_t106','a106.lon',320,160)
239 IDL> m=read_oasis('masks_orca_t106','or1t.msk',182,149,/i4)
240
241 see also IDL> scanoasis,'grids_orca_t106'
242</div>
243          <h3>Version history</h3>
244         
245         
246          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
247                      July 01, 2002</div>
248         
249         
250         
251         
252         
253         
254         
255       
256         
257         
258         
259         
260         
261         
262         
263       
264         
265       
266        </div>
267       
268      </div>
269
270     
271
272      <div id="tagline">Produced by IDLdoc 2.0.</div>
273
274    </div>
275
276  </body>
277</html>
Note: See TracBrowser for help on using the repository browser.