source: trunk/SRC/Documentation/idldoc_html_output/Grid/micromeshmask.html @ 402

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

update documentation

File size: 7.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>micromeshmask.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="micromeshmask.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="../../../Grid//micromeshmask.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="computegrid.html">&lt;&lt;prev file</a> | <a href="n128gaussian.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="micromeshmask.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&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">Grid/</a></h1>
[89]82      <h2 class="pro_file">micromeshmask.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[234]89      <div id="file_comments">
[157]90 Reduce the size of the NetCDF meshmask created by OPA by
[118]91 using bit (and not byte) format for the masks and the float format
92 for the other fields.
[103]93</div>
[89]94
95     
96
97     
98
99     
100
101     
102      <div id="routine_summary">               
103        <h2>Routine summary</h2>
104       
105        <dl>
106         
[118]107          <dt><p><a href="#_ncdf_transfer">ncdf_transfer<span class="result">, inid, outid, inname[, outname]</span></a></p><dt>
[103]108          <dd> </dd>   
[89]109         
[118]110          <dt><p><a href="#_micromeshmask">micromeshmask<span class="result">, ncfilein[, ncfileout]</span>, IODIR=<span class="result">IODIR</span></a></p><dt>
111          <dd> </dd>   
[89]112               
113        </dl>
114      </div>
115     
116
117      <div id="routine_details">
118       
119
120        <div class="routine_details" id="_ncdf_transfer">
121
[234]122          <h2><a class="top" href="#container">top</a>ncdf_transfer <span class="categories">
[157]123 For OPA
[103]124</span></h2>
[89]125       
126          <p class="header">
[118]127            ncdf_transfer<span class="result">, <a href="#_ncdf_transfer_param_inid">inid</a>, <a href="#_ncdf_transfer_param_outid">outid</a>, <a href="#_ncdf_transfer_param_inname">inname</a>[, <a href="#_ncdf_transfer_param_outname">outname</a>]</span></p>
[89]128       
129          <div class="comments">
[103]130</div>
[89]131
132         
133
134         
135            <h3>Parameters</h3>
136       
137           
138            <h4 id="_ncdf_transfer_param_inid">inid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]139              <span class="attr">in</span>
[89]140             
141             
[118]142              <span class="attr">required</span>
[89]143             
144             
145             
146             
147            </h4>
148       
[242]149          <div class="comments">
150</div>
[89]151           
152            <h4 id="_ncdf_transfer_param_outid">outid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]153              <span class="attr">in</span>
[89]154             
155             
[118]156              <span class="attr">required</span>
[89]157             
158             
159             
160             
161            </h4>
162       
[242]163          <div class="comments">
164</div>
[89]165           
166            <h4 id="_ncdf_transfer_param_inname">inname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]167              <span class="attr">in</span>
[89]168             
169             
[118]170              <span class="attr">required</span>
[89]171             
172             
173             
174             
175            </h4>
176       
[242]177          <div class="comments">
178</div>
[89]179           
180            <h4 id="_ncdf_transfer_param_outname">outname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[118]181              <span class="attr">in</span>
[89]182             
[118]183              <span class="attr">optional</span>
[89]184             
185             
186             
187             
188             
189            </h4>
190       
[118]191          <div class="comments">
192</div>
[89]193           
194
195         
196
197         
198
[118]199         
[103]200          <h3>Version history</h3>
[89]201         
[234]202          <h4>Version</h4><div class="preformat">
[402]203 $Id: micromeshmask.pro 394 2009-02-26 13:58:03Z smasson $
[118]204</div>
[138]205          <h4>History</h4><div class="preformat">
[118]206      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)
207</div>
[89]208         
209         
210         
211         
212         
213         
214         
215       
216         
217         
218         
219         
220         
221         
222         
223       
[163]224          <h3>Statistics</h3>
225          <table class="statistics">
226            <tr><td>McCabe cyclic</td><td>           2</td></tr>
227            <tr><td>McCabe essential</td><td>           1</td></tr>
228            <tr><td>McCabe modular design</td><td>           1</td></tr>
229          </table>
[89]230         
231       
232        </div>
233       
234
235        <div class="routine_details" id="_micromeshmask">
236
237          <h2><a class="top" href="#container">top</a>micromeshmask </h2>
238       
239          <p class="header">
[118]240            micromeshmask<span class="result">, <a href="#_micromeshmask_param_ncfilein">ncfilein</a>[, <a href="#_micromeshmask_param_ncfileout">ncfileout</a>]</span>, <a href="#_micromeshmask_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span></p>
[89]241       
[118]242          <div class="comments">
243</div>
[89]244
245         
246
247         
248            <h3>Parameters</h3>
249       
250           
251            <h4 id="_micromeshmask_param_ncfilein">ncfilein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[103]252              <span class="attr">in</span>
[89]253             
254             
[103]255              <span class="attr">required</span>
[89]256             
257             
258             
259             
260            </h4>
261       
[103]262          <div class="comments">
[138]263 1) the name of the meshmask file to be reduced. In that case,
264 there is only one meshmask file
[103]265
[138]266 OR
[103]267
[138]268 2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc
269 xxx.mask.nc. In that case, the meshmask is split into 3 files.
[103]270</div>
[89]271           
272            <h4 id="_micromeshmask_param_ncfileout">ncfileout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[103]273              <span class="attr">in</span>
[89]274             
[118]275              <span class="attr">optional</span>
[89]276             
277             
278             
[242]279              <span class="attr">default:</span> <span class="value">'micromeshmask.nc'</span>
[89]280             
281            </h4>
282       
[242]283          <div class="comments">
284 the name of the uniq reduced meshmask file.
[103]285</div>
[89]286           
287
288         
289
290         
291
292            <h3>Keywords</h3>
293           
294            <h4 id="_micromeshmask_keyword_IODIR">IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
295             
296             
297             
298             
299             
300             
301             
302             
303            </h4>
304       
[242]305            <div class="comments">
306 to define the files path.
[118]307</div>
[89]308           
309         
310
[138]311          <h3>Examples</h3><div class="preformat">
[402]312
313   IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/'
314   IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir
[118]315</div>
[89]316         
317         
318         
319         
320         
321         
322         
323         
324         
325         
326         
327       
328         
329         
330         
331         
332         
333         
334         
335       
[163]336          <h3>Statistics</h3>
337          <table class="statistics">
[321]338            <tr><td>McCabe cyclic</td><td>          36</td></tr>
[163]339            <tr><td>McCabe essential</td><td>           1</td></tr>
340            <tr><td>McCabe modular design</td><td>           1</td></tr>
341          </table>
[89]342         
343       
344        </div>
345       
346      </div>
347
348     
349
350      <div id="tagline">Produced by IDLdoc 2.0.</div>
351
352    </div>
353
354  </body>
[249]355</html>
Note: See TracBrowser for help on using the repository browser.