source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/readbat.html

Last change on this file was 402, checked in by smasson, 15 years ago

update documentation
File size: 4.2 KB
RevLine 
[89]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>
[104]9    <title>readbat.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="readbat.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../ReadWrite//readbat.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]74<a href="read_oasis.html">&lt;&lt;prev file</a> | <a href="readoldopadistcoast.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="readbat.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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ReadWrite/</a></h1>
[89]82      <h2 class="pro_file">readbat.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[138]89      <div id="file_comments">
90 reading the bathymetry ASCII file of OPA
[106]91</div>
[89]92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_readbat">
105
[157]106          <h2><a class="top" href="#container">top</a>readbat <span class="categories">
107 For OPA
[106]108</span></h2>
[89]109       
110          <p class="header">
111            <span class="result">result = </span>readbat(<span class="result"><a href="#_readbat_param_filename">filename</a></span>, <a href="#_readbat_keyword_ZERO">ZERO</a>=<span class="result">ZERO</span>)</p>
112       
[234]113          <div class="comments">
114</div>
[89]115
[242]116          <h3>Return value</h3><div class="preformat">
117 a 2d array
[89]118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_readbat_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[106]125              <span class="attr">in</span>
[89]126             
127             
[106]128              <span class="attr">required</span>
[89]129             
[163]130              <span class="attr">type:</span> <span class="value">string</span>
[89]131             
132             
133            </h4>
134       
[163]135          <div class="comments">
136 It contains the filename,
[106]137</div>
[89]138           
139
140         
141
142         
143
144            <h3>Keywords</h3>
145           
146            <h4 id="_readbat_keyword_ZERO">ZERO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147             
148             
149             
150             
151             
152             
153             
154             
155            </h4>
156       
[402]157            <div class="comments">
158 to put 0 on land instead of negatives values for the islands.
[106]159</div>
[89]160           
161         
162
163         
[106]164          <h3>Version history</h3>
[89]165         
[242]166          <h4>Version</h4><div class="preformat">
[402]167  $Id: readbat.pro 372 2008-08-08 12:31:53Z pinsard $
[138]168</div>
[242]169          <h4>History</h4><div class="preformat">
170 Sebastien Masson (smasson@lodyc.jussieu.fr)
[106]171                      May 31, 2002
[402]172 based on batlec2.pro, written by Maurice Imbard, March 17, 1998
[138]173</div>
[89]174         
175         
176         
177         
178         
179         
180         
181       
182         
183         
184         
185         
186         
187         
188         
189       
[163]190          <h3>Statistics</h3>
191          <table class="statistics">
192            <tr><td>McCabe cyclic</td><td>           6</td></tr>
193            <tr><td>McCabe essential</td><td>           1</td></tr>
194            <tr><td>McCabe modular design</td><td>           1</td></tr>
195          </table>
[89]196         
197       
198        </div>
199       
200      </div>
201
202     
203
204      <div id="tagline">Produced by IDLdoc 2.0.</div>
205
206    </div>
207
208  </body>
[249]209</html>
Note: See TracBrowser for help on using the repository browser.