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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
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    <h3>Return value</h3> a 2d array
81
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_read_oasis_keyword_filename"></a>
88    <h4>filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89      <font size="-1" color="#006633">in</font>
90     
91     
92      <font size="-1" color="#006633">required</font>
93     
94     
95     
96     
97    </h4>
98
99     
100 the filename
101
102   
103
104    <a name="#_read_oasis_keyword_varname"></a>
105    <h4>varname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
106      <font size="-1" color="#006633">in</font>
107     
108     
109      <font size="-1" color="#006633">required</font>
110     
111     
112     
113     
114    </h4>
115
116     
117 the name of the variable to be read
118
119   
120
121    <a name="#_read_oasis_keyword_jpi"></a>
122    <h4>jpi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123      <font size="-1" color="#006633">in</font>
124     
125     
126      <font size="-1" color="#006633">required</font>
127     
128     
129     
130     
131    </h4>
132
133   
134
135   
136
137    <a name="#_read_oasis_keyword_jpj"></a>
138    <h4>jpj&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
139      <font size="-1" color="#006633">in</font>
140     
141     
142      <font size="-1" color="#006633">required</font>
143     
144     
145     
146     
147    </h4>
148
149   
150 the size of the 2d array to be read
151
152   
153   
154
155   
156    <h3>Keywords</h3>
157
158   
159    <a name="#_read_oasis_keyword_I2"></a>
160    <h4>I2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161     
162     
163     
164     
165     
166     
167     
168     
169    </h4>
170
171   
172   
173    <a name="#_read_oasis_keyword_I4"></a>
174    <h4>I4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175     
176     
177     
178     
179     
180     
181     
182     
183    </h4>
184
185   
186   
187    <a name="#_read_oasis_keyword_I8"></a>
188    <h4>I8&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
189     
190     
191     
192     
193     
194     
195     
196     
197    </h4>
198
199   
200   
201    <a name="#_read_oasis_keyword_R4"></a>
202    <h4>R4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
203     
204     
205     
206     
207     
208     
209     
210     
211    </h4>
212
213   
214 to change the default format (R8) of the data to be read.
215
216   
217   
218
219    <h3>Examples</h3>
220 IDL> a=read_oasis('grids_orca_t106','a106.lon',320,160)
221 IDL> m=read_oasis('masks_orca_t106','or1t.msk',182,149,/i4)
222
223 see also IDL> scanoasis,'grids_orca_t106'
224
225    <h3>Version history</h3>
226   
227    <h4>Version</h4> $Id: read_oasis.pro 157 2006-08-21 09:01:50Z navarro $
228    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
229                      July 01, 2002
230   
231
232   
233   
234   
235   
236   
237
238   
239   
240   
241   
242   
243   
244   
245
246    <font size="-3"><p>&nbsp;</p></font>
247    <hr size="1" color="#CCCCCC"/>
248     
249
250   
251
252    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:36 2006.</font></p>
253
254  </body>
255</html>
Note: See TracBrowser for help on using the repository browser.