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

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 6.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_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" 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_oasis.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="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" 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_oasis.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 read the f77 unformatted files used in Oasis (version < 2.5)
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_read_oasis">
105
106          <h2><a class="top" href="#container">top</a>read_oasis <span class="categories">
107 Reading
108</span></h2>
109       
110          <p class="header">
111            <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></span>, <a href="#_read_oasis_keyword_I2">I2</a>=<span class="result">I2</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>
112       
113          <div class="comments"></div>
114
115          <h3>Return value</h3><div class="preformat"> a 2d array
116</div>
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_read_oasis_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125             
126              <span class="attr">required</span>
127             
128             
129             
130             
131            </h4>
132       
133          <div class="comments"> 
134 the filename
135</div>
136           
137            <h4 id="_read_oasis_param_varname">varname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138              <span class="attr">in</span>
139             
140             
141              <span class="attr">required</span>
142             
143             
144             
145             
146            </h4>
147       
148          <div class="comments"> 
149 the name of the variable to be read
150</div>
151           
152            <h4 id="_read_oasis_param_jpi">jpi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153              <span class="attr">in</span>
154             
155             
156              <span class="attr">required</span>
157             
158             
159             
160             
161            </h4>
162       
163          <div class="comments">
164</div>
165           
166            <h4 id="_read_oasis_param_jpj">jpj&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
167              <span class="attr">in</span>
168             
169             
170              <span class="attr">required</span>
171             
172             
173             
174             
175            </h4>
176       
177          <div class="comments">
178 the size of the 2d array to be read
179</div>
180           
181
182         
183
184         
185
186            <h3>Keywords</h3>
187           
188            <h4 id="_read_oasis_keyword_I2">I2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
189             
190             
191             
192             
193             
194             
195             
196             
197            </h4>
198       
199            <div class="comments"></div>
200           
201            <h4 id="_read_oasis_keyword_I4">I4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
202             
203             
204             
205             
206             
207             
208             
209             
210            </h4>
211       
212            <div class="comments"></div>
213           
214            <h4 id="_read_oasis_keyword_I8">I8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215             
216             
217             
218             
219             
220             
221             
222             
223            </h4>
224       
225            <div class="comments"></div>
226           
227            <h4 id="_read_oasis_keyword_R4">R4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
228             
229             
230             
231             
232             
233             
234             
235             
236            </h4>
237       
238            <div class="comments">
239 to change the default format (R8) of the data to be read.
240</div>
241           
242         
243
244          <h3>Examples</h3><div class="preformat">
245 IDL> a=read_oasis('grids_orca_t106','a106.lon',320,160)
246 IDL> m=read_oasis('masks_orca_t106','or1t.msk',182,149,/i4)
247
248 see also IDL> scanoasis,'grids_orca_t106'
249</div>
250          <h3>Version history</h3>
251         
252          <h4>Version</h4><div class="preformat"> $Id: read_oasis.pro 163 2006-08-29 12:59:46Z navarro $</div>
253          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr)
254                      July 01, 2002</div>
255         
256         
257         
258         
259         
260         
261         
262       
263         
264         
265         
266         
267         
268         
269         
270       
271          <h3>Statistics</h3>
272          <table class="statistics">
273            <tr><td>McCabe cyclic</td><td>           9</td></tr>
274            <tr><td>McCabe essential</td><td>           1</td></tr>
275            <tr><td>McCabe modular design</td><td>           1</td></tr>
276          </table>
277         
278       
279        </div>
280       
281      </div>
282
283     
284
285      <div id="tagline">Produced by IDLdoc 2.0.</div>
286
287    </div>
288
289  </body>
290</html>
Note: See TracBrowser for help on using the repository browser.