source: trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/readbat.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation

File size: 3.1 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>readbat.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_oasis.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="readoldopadistcoast.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>readbat.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 reading the bathymetry ASCII file of OPA
65
66
67   
68
69     
70      <a name="#_readbat"></a>
71
72      <h2>readbat  <font size="-1" color="#006633">
73 For OPA
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>readbat(<i><a href="#_readbat_keyword_filename">filename</a></i>, <a href="#_readbat_keyword_ZERO">ZERO</a>=<i>ZERO</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="#_readbat_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      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
97     
98     
99    </h4>
100
101   
102 It contains the filename,
103
104   
105   
106
107   
108    <h3>Keywords</h3>
109
110   
111    <a name="#_readbat_keyword_ZERO"></a>
112    <h4>ZERO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
113     
114     
115     
116     
117     
118     
119     
120     
121    </h4>
122
123     to put 0 on land instead of negatives values for the islands.
124
125   
126   
127
128   
129    </pre><h3>Version history</h3>
130   
131    <h4>Version</h4>
132  $Id: readbat.pro 327 2007-12-13 16:22:35Z pinsard $
133
134    <h4>History</h4>
135 Sebastien Masson (smasson@lodyc.jussieu.fr)
136                      May 31, 2002
137    based on batlec2.pro, written by Maurice Imbard, March 17, 1998
138
139   
140
141   
142   
143   
144   
145   
146
147   
148   
149   
150   
151   
152   
153   
154
155    <font size="-3"><p>&nbsp;</p></font>
156    <hr size="1" color="#CCCCCC"/>
157     
158
159   
160
161    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
162
163  </body>
164</html>
Note: See TracBrowser for help on using the repository browser.