source: trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/read_oasis.html @ 242

Last change on this file since 242 was 242, checked in by pinsard, 17 years ago

improvements/corrections of some *.pro headers + replace some message by some report
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_oasis.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="read_grads.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="readbat.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_oasis.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 read the f77 unformatted files used in Oasis (version < 2.5)
65
66
67   
68
69     
70      <a name="#_read_oasis"></a>
71
72      <h2>read_oasis  <font size="-1" color="#006633">
73 Reading
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>read_oasis(<i><a href="#_read_oasis_keyword_filename">filename</a>, <a href="#_read_oasis_keyword_varname">varname</a>, <a href="#_read_oasis_keyword_jpi">jpi</a>, <a href="#_read_oasis_keyword_jpj">jpj</a></i>, <a href="#_read_oasis_keyword_I2">I2</a>=<i>I2</i>, <a href="#_read_oasis_keyword_I4">I4</a>=<i>I4</i>, <a href="#_read_oasis_keyword_I8">I8</a>=<i>I8</i>, <a href="#_read_oasis_keyword_R4">R4</a>=<i>R4</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 a 2d array
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_read_oasis_keyword_filename"></a>
90    <h4>filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91      <font size="-1" color="#006633">in</font>
92     
93     
94      <font size="-1" color="#006633">required</font>
95     
96     
97     
98     
99    </h4>
100
101   
102 the filename
103
104   
105
106    <a name="#_read_oasis_keyword_varname"></a>
107    <h4>varname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
108      <font size="-1" color="#006633">in</font>
109     
110     
111      <font size="-1" color="#006633">required</font>
112     
113     
114     
115     
116    </h4>
117
118   
119 the name of the variable to be read
120
121   
122
123    <a name="#_read_oasis_keyword_jpi"></a>
124    <h4>jpi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125      <font size="-1" color="#006633">in</font>
126     
127     
128      <font size="-1" color="#006633">required</font>
129     
130     
131     
132     
133    </h4>
134
135   
136
137   
138
139    <a name="#_read_oasis_keyword_jpj"></a>
140    <h4>jpj&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141      <font size="-1" color="#006633">in</font>
142     
143     
144      <font size="-1" color="#006633">required</font>
145     
146     
147     
148     
149    </h4>
150
151   
152 the size of the 2d array to be read
153
154   
155   
156
157   
158    <h3>Keywords</h3>
159
160   
161    <a name="#_read_oasis_keyword_I2"></a>
162    <h4>I2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163     
164     
165     
166     
167     
168     
169     
170     
171    </h4>
172
173   
174   
175    <a name="#_read_oasis_keyword_I4"></a>
176    <h4>I4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177     
178     
179     
180     
181     
182     
183     
184     
185    </h4>
186
187   
188   
189    <a name="#_read_oasis_keyword_I8"></a>
190    <h4>I8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
191     
192     
193     
194     
195     
196     
197     
198     
199    </h4>
200
201   
202   
203    <a name="#_read_oasis_keyword_R4"></a>
204    <h4>R4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205     
206     
207     
208     
209     
210     
211     
212     
213    </h4>
214
215   
216 to change the default format (R8) of the data to be read.
217
218   
219   
220
221    <h3>Examples</h3><pre>
222 IDL> a=read_oasis('grids_orca_t106','a106.lon',320,160)
223 IDL> m=read_oasis('masks_orca_t106','or1t.msk',182,149,/i4)
224
225 see also IDL> scanoasis,'grids_orca_t106'
226
227    </pre><h3>Version history</h3>
228   
229    <h4>Version</h4>
230 $Id: read_oasis.pro 238 2007-03-27 13:43:18Z pinsard $
231
232    <h4>History</h4>
233 Sebastien Masson (smasson@lodyc.jussieu.fr)
234                      July 01, 2002
235   
236
237   
238   
239   
240   
241   
242
243   
244   
245   
246   
247   
248   
249   
250
251    <font size="-3"><p>&nbsp;</p></font>
252    <hr size="1" color="#CCCCCC"/>
253     
254
255   
256
257    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
258
259  </body>
260</html>
Note: See TracBrowser for help on using the repository browser.