source: trunk/SRC/Documentation/idldoc_html_output/Grid/smallmeshmask.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.4 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
131</div>
132
133         
134
135         
136            <h3>Parameters</h3>
137       
138           
139            <h4 id="_ncdf_transfer_param_inid">inid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140              <span class="attr">in</span>
141             
142             
143              <span class="attr">required</span>
144             
145             
146             
147             
148            </h4>
149       
150          <div class="comments"></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"></div>
164           
165            <h4 id="_ncdf_transfer_param_inname">inname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166              <span class="attr">in</span>
167             
168             
169              <span class="attr">required</span>
170             
171             
172             
173             
174            </h4>
175       
176          <div class="comments"></div>
177           
178            <h4 id="_ncdf_transfer_param_outname">outname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179              <span class="attr">in</span>
180             
181              <span class="attr">optional</span>
182             
183             
184             
185             
186             
187            </h4>
188       
189          <div class="comments">
190</div>
191           
192
193         
194
195         
196
197         
198          <h3>Version history</h3>
199         
200          <h4>Version</h4><div class="preformat"> 
201 $Id: smallmeshmask.pro 157 2006-08-21 09:01:50Z navarro $
202</div>
203          <h4>History</h4><div class="preformat">
204      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)
205</div>
206         
207         
208         
209         
210         
211         
212         
213       
214         
215         
216         
217         
218         
219         
220         
221       
222          <h3>Statistics</h3>
223          <table class="statistics">
224            <tr><td>McCabe cyclic</td><td>           2</td></tr>
225            <tr><td>McCabe essential</td><td>           1</td></tr>
226            <tr><td>McCabe modular design</td><td>           1</td></tr>
227          </table>
228         
229       
230        </div>
231       
232
233        <div class="routine_details" id="_smallmeshmask">
234
235          <h2><a class="top" href="#container">top</a>smallmeshmask <span class="categories"> 
236 For OPA
237</span></h2>
238       
239          <p class="header">
240            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>
241       
242          <div class="comments"></div>
243
244         
245
246         
247            <h3>Parameters</h3>
248       
249           
250            <h4 id="_smallmeshmask_param_ncfilein">ncfilein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251              <span class="attr">in</span>
252             
253             
254              <span class="attr">required</span>
255             
256             
257             
258             
259            </h4>
260       
261          <div class="comments">
262 1) the name of the meshmask file to be reduced. In that case,
263 there is only one meshmask file
264
265 OR
266
267 2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc
268 xxx.mask.nc. In that case, the meshmask is split into 3 files.
269</div>
270           
271            <h4 id="_smallmeshmask_param_ncfileout">ncfileout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
272              <span class="attr">in</span>
273             
274              <span class="attr">optional</span>
275             
276             
277             
278              <span class="attr">default:</span> <span class="value">smallmeshmask.nc</span>
279             
280            </h4>
281       
282          <div class="comments"> 
283 the name of the reduced meshmask file.
284</div>
285           
286
287         
288
289         
290
291            <h3>Keywords</h3>
292           
293            <h4 id="_smallmeshmask_keyword_IODIR">IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
294             
295             
296             
297             
298             
299             
300             
301             
302            </h4>
303       
304            <div class="comments"> to define the files path.</div>
305           
306         
307
308          <h3>Examples</h3><div class="preformat">
309 IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/'
310 IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir
311</div>
312          <h3>Version history</h3>
313         
314          <h4>Version</h4><div class="preformat"> 
315 $Id: smallmeshmask.pro 157 2006-08-21 09:01:50Z navarro $
316</div>
317          <h4>History</h4><div class="preformat">
318      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)
319</div>
320         
321         
322         
323         
324         
325         
326         
327       
328         
329         
330         
331         
332         
333         
334         
335       
336          <h3>Statistics</h3>
337          <table class="statistics">
338            <tr><td>McCabe cyclic</td><td>          32</td></tr>
339            <tr><td>McCabe essential</td><td>           1</td></tr>
340            <tr><td>McCabe modular design</td><td>           1</td></tr>
341          </table>
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>
355</html>
Note: See TracBrowser for help on using the repository browser.