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

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

update documentation
File size: 7.5 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>smallmeshmask.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="smallmeshmask.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//smallmeshmask.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="saveboxparam.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="smallmeshmask.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">smallmeshmask.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 byte format for the masks and the float format for the other
92 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="#_smallmeshmask">smallmeshmask<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">
150</div>
151           
152            <h4 id="_ncdf_transfer_param_outid">outid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153              <span class="attr">in</span>
154             
155             
156              <span class="attr">required</span>
157             
158             
159             
160             
161            </h4>
162       
163          <div class="comments">
164</div>
165           
166            <h4 id="_ncdf_transfer_param_inname">inname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
167              <span class="attr">in</span>
168             
169             
170              <span class="attr">required</span>
171             
172             
173             
174             
175            </h4>
176       
177          <div class="comments">
178</div>
179           
180            <h4 id="_ncdf_transfer_param_outname">outname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181              <span class="attr">in</span>
182             
183              <span class="attr">optional</span>
184             
185             
186             
187             
188             
189            </h4>
190       
191          <div class="comments">
192</div>
193           
194
195         
196
197         
198
199         
200          <h3>Version history</h3>
201         
202          <h4>Version</h4><div class="preformat">
203 $Id: smallmeshmask.pro 371 2008-08-07 09:32:02Z pinsard $
204</div>
205          <h4>History</h4><div class="preformat">
206      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)
207</div>
208         
209         
210         
211         
212         
213         
214         
215       
216         
217         
218         
219         
220         
221         
222         
223       
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>
230         
231       
232        </div>
233       
234
235        <div class="routine_details" id="_smallmeshmask">
236
237          <h2><a class="top" href="#container">top</a>smallmeshmask <span class="categories">
238 For OPA
239</span></h2>
240       
241          <p class="header">
242            smallmeshmask<span class="result">, <a href="#_smallmeshmask_param_ncfilein">ncfilein</a>[, <a href="#_smallmeshmask_param_ncfileout">ncfileout</a>]</span>, <a href="#_smallmeshmask_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span></p>
243       
244          <div class="comments">
245</div>
246
247         
248
249         
250            <h3>Parameters</h3>
251       
252           
253            <h4 id="_smallmeshmask_param_ncfilein">ncfilein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
254              <span class="attr">in</span>
255             
256             
257              <span class="attr">required</span>
258             
259             
260             
261             
262            </h4>
263       
264          <div class="comments">
265 1) the name of the meshmask file to be reduced. In that case,
266 there is only one meshmask file
267
268 OR
269
270 2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc
271 xxx.mask.nc. In that case, the meshmask is split into 3 files.
272</div>
273           
274            <h4 id="_smallmeshmask_param_ncfileout">ncfileout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
275              <span class="attr">in</span>
276             
277              <span class="attr">optional</span>
278             
279             
280             
281              <span class="attr">default:</span> <span class="value">smallmeshmask.nc</span>
282             
283            </h4>
284       
285          <div class="comments">
286 the name of the reduced meshmask file.
287</div>
288           
289
290         
291
292         
293
294            <h3>Keywords</h3>
295           
296            <h4 id="_smallmeshmask_keyword_IODIR">IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
297             
298             
299             
300             
301             
302             
303             
304             
305            </h4>
306       
307            <div class="comments">
308 to define the files path.
309</div>
310           
311         
312
313          <h3>Examples</h3><div class="preformat">
314
315   IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/'
316   IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir
317</div>
318          <h3>Version history</h3>
319         
320          <h4>Version</h4><div class="preformat">
321 $Id: smallmeshmask.pro 371 2008-08-07 09:32:02Z pinsard $
322</div>
323          <h4>History</h4><div class="preformat">
324      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)
325</div>
326         
327         
328         
329         
330         
331         
332         
333       
334         
335         
336         
337         
338         
339         
340         
341       
342          <h3>Statistics</h3>
343          <table class="statistics">
344            <tr><td>McCabe cyclic</td><td>          35</td></tr>
345            <tr><td>McCabe essential</td><td>           1</td></tr>
346            <tr><td>McCabe modular design</td><td>           1</td></tr>
347          </table>
348         
349       
350        </div>
351       
352      </div>
353
354     
355
356      <div id="tagline">Produced by IDLdoc 2.0.</div>
357
358    </div>
359
360  </body>
361</html>
Note: See TracBrowser for help on using the repository browser.