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

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 7.2 KB
Line 
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>
9    <title>micromeshmask.pro (SAXO Documentation)</title>
10
11   
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" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="micromeshmask.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Grid//micromeshmask.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
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
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>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Grid/</a></h1>
82      <h2 class="pro_file">micromeshmask.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> 
90 Reduce the size of the NetCDF meshmask created by OPA by
91 using bit (and not byte) format for the masks and the float format
92 for the other fields.
93</div>
94
95     
96
97     
98
99     
100
101     
102      <div id="routine_summary">               
103        <h2>Routine summary</h2>
104       
105        <dl>
106         
107          <dt><p><a href="#_ncdf_transfer">ncdf_transfer<span class="result">, inid, outid, inname[, outname]</span></a></p><dt>
108          <dd> </dd>   
109         
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>   
112               
113        </dl>
114      </div>
115     
116
117      <div id="routine_details">
118       
119
120        <div class="routine_details" id="_ncdf_transfer">
121
122          <h2><a class="top" href="#container">top</a>ncdf_transfer <span class="categories"> 
123 For OPA
124</span></h2>
125       
126          <p class="header">
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>
128       
129          <div class="comments">
130</div>
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;
139              <span class="attr">in</span>
140             
141             
142              <span class="attr">required</span>
143             
144             
145             
146             
147            </h4>
148       
149          <div class="comments"></div>
150           
151            <h4 id="_ncdf_transfer_param_outid">outid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152              <span class="attr">in</span>
153             
154             
155              <span class="attr">required</span>
156             
157             
158             
159             
160            </h4>
161       
162          <div class="comments"></div>
163           
164            <h4 id="_ncdf_transfer_param_inname">inname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165              <span class="attr">in</span>
166             
167             
168              <span class="attr">required</span>
169             
170             
171             
172             
173            </h4>
174       
175          <div class="comments"></div>
176           
177            <h4 id="_ncdf_transfer_param_outname">outname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178              <span class="attr">in</span>
179             
180              <span class="attr">optional</span>
181             
182             
183             
184             
185             
186            </h4>
187       
188          <div class="comments">
189</div>
190           
191
192         
193
194         
195
196         
197          <h3>Version history</h3>
198         
199          <h4>Version</h4><div class="preformat"> 
200 $Id: micromeshmask.pro 157 2006-08-21 09:01:50Z navarro $
201</div>
202          <h4>History</h4><div class="preformat">
203      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)
204</div>
205         
206         
207         
208         
209         
210         
211         
212       
213         
214         
215         
216         
217         
218         
219         
220       
221          <h3>Statistics</h3>
222          <table class="statistics">
223            <tr><td>McCabe cyclic</td><td>           2</td></tr>
224            <tr><td>McCabe essential</td><td>           1</td></tr>
225            <tr><td>McCabe modular design</td><td>           1</td></tr>
226          </table>
227         
228       
229        </div>
230       
231
232        <div class="routine_details" id="_micromeshmask">
233
234          <h2><a class="top" href="#container">top</a>micromeshmask </h2>
235       
236          <p class="header">
237            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>
238       
239          <div class="comments">
240</div>
241
242         
243
244         
245            <h3>Parameters</h3>
246       
247           
248            <h4 id="_micromeshmask_param_ncfilein">ncfilein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
249              <span class="attr">in</span>
250             
251             
252              <span class="attr">required</span>
253             
254             
255             
256             
257            </h4>
258       
259          <div class="comments">
260 1) the name of the meshmask file to be reduced. In that case,
261 there is only one meshmask file
262
263 OR
264
265 2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc
266 xxx.mask.nc. In that case, the meshmask is split into 3 files.
267</div>
268           
269            <h4 id="_micromeshmask_param_ncfileout">ncfileout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
270              <span class="attr">in</span>
271             
272              <span class="attr">optional</span>
273             
274             
275             
276             
277             
278            </h4>
279       
280          <div class="comments"> the name of the uniq reduced meshmask file.
281 default definition is micromeshmask.nc
282</div>
283           
284
285         
286
287         
288
289            <h3>Keywords</h3>
290           
291            <h4 id="_micromeshmask_keyword_IODIR">IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
292             
293             
294             
295             
296             
297             
298             
299             
300            </h4>
301       
302            <div class="comments"> to define the files path.
303</div>
304           
305         
306
307          <h3>Examples</h3><div class="preformat">
308 IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/'
309 IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir
310</div>
311         
312         
313         
314         
315         
316         
317         
318         
319         
320         
321         
322       
323         
324         
325         
326         
327         
328         
329         
330       
331          <h3>Statistics</h3>
332          <table class="statistics">
333            <tr><td>McCabe cyclic</td><td>          33</td></tr>
334            <tr><td>McCabe essential</td><td>           1</td></tr>
335            <tr><td>McCabe modular design</td><td>           1</td></tr>
336          </table>
337         
338       
339        </div>
340       
341      </div>
342
343     
344
345      <div id="tagline">Produced by IDLdoc 2.0.</div>
346
347    </div>
348
349  </body>
350</html>
Note: See TracBrowser for help on using the repository browser.