source: trunk/SRC/Documentation/idldoc_assistant_output/Grid/smallmeshmask.html @ 234

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

new idldoc html and assistant outputs
File size: 6.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>smallmeshmask.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="saveboxparam.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href=""><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Grid/</font></h1>
58    <h2>smallmeshmask.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Reduce the size of the NetCDF meshmask created by OPA by
65 using byte format for the masks and the float format for the other
66 fields.
67
68
69   
70    <h2>Routine summary</h2>
71
72    <dl>
73     
74      <dt><a href="#_ncdf_transfer">ncdf_transfer<i>, inid, outid, inname[, outname]</i></a><dt>
75      <dd><font size="-1"> </font></dd>
76     
77      <dt><a href="#_smallmeshmask">smallmeshmask<i>, ncfilein[, ncfileout]</i>, IODIR=<i>IODIR</i></a><dt>
78      <dd><font size="-1"></font></dd>
79     
80    </dl>
81
82    <p>&nbsp;</p>
83   
84
85     
86      <a name="#_ncdf_transfer"></a>
87
88      <h2>ncdf_transfer  <font size="-1" color="#006633">
89 For OPA
90</font></h2>
91
92      <p><font face="Courier">ncdf_transfer<i>, <a href="#_ncdf_transfer_keyword_inid">inid</a>, <a href="#_ncdf_transfer_keyword_outid">outid</a>, <a href="#_ncdf_transfer_keyword_inname">inname</a>[, <a href="#_ncdf_transfer_keyword_outname">outname</a>]</i></font></p>
93
94   
95
96
97   
98
99   
100    <h3>Parameters</h3>
101   
102
103    <a name="#_ncdf_transfer_keyword_inid"></a>
104    <h4>inid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
105      <font size="-1" color="#006633">in</font>
106     
107     
108      <font size="-1" color="#006633">required</font>
109     
110     
111     
112     
113    </h4>
114
115   
116   
117
118    <a name="#_ncdf_transfer_keyword_outid"></a>
119    <h4>outid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
120      <font size="-1" color="#006633">in</font>
121     
122     
123      <font size="-1" color="#006633">required</font>
124     
125     
126     
127     
128    </h4>
129
130   
131   
132
133    <a name="#_ncdf_transfer_keyword_inname"></a>
134    <h4>inname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
135      <font size="-1" color="#006633">in</font>
136     
137     
138      <font size="-1" color="#006633">required</font>
139     
140     
141     
142     
143    </h4>
144
145   
146   
147
148    <a name="#_ncdf_transfer_keyword_outname"></a>
149    <h4>outname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150      <font size="-1" color="#006633">in</font>
151     
152      <font size="-1" color="#006633">optional</font>
153     
154     
155     
156     
157     
158    </h4>
159
160   
161
162   
163   
164
165   
166
167   
168    </pre><h3>Version history</h3>
169   
170    <h4>Version</h4>
171 $Id: smallmeshmask.pro 231 2007-03-19 17:15:51Z pinsard $
172
173    <h4>History</h4>
174      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)
175
176   
177
178   
179   
180   
181   
182   
183
184   
185   
186   
187   
188   
189   
190   
191
192    <font size="-3"><p>&nbsp;</p></font>
193    <hr size="1" color="#CCCCCC"/>
194     
195      <a name="#_smallmeshmask"></a>
196
197      <h2>smallmeshmask  <font size="-1" color="#006633">
198 For OPA
199</font></h2>
200
201      <p><font face="Courier">smallmeshmask<i>, <a href="#_smallmeshmask_keyword_ncfilein">ncfilein</a>[, <a href="#_smallmeshmask_keyword_ncfileout">ncfileout</a>]</i>, <a href="#_smallmeshmask_keyword_IODIR">IODIR</a>=<i>IODIR</i></font></p>
202
203   
204
205   
206
207   
208    <h3>Parameters</h3>
209   
210
211    <a name="#_smallmeshmask_keyword_ncfilein"></a>
212    <h4>ncfilein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
213      <font size="-1" color="#006633">in</font>
214     
215     
216      <font size="-1" color="#006633">required</font>
217     
218     
219     
220     
221    </h4>
222
223   
224 1) the name of the meshmask file to be reduced. In that case,
225 there is only one meshmask file
226
227 OR
228
229 2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc
230 xxx.mask.nc. In that case, the meshmask is split into 3 files.
231
232   
233
234    <a name="#_smallmeshmask_keyword_ncfileout"></a>
235    <h4>ncfileout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236      <font size="-1" color="#006633">in</font>
237     
238      <font size="-1" color="#006633">optional</font>
239     
240     
241     
242      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>smallmeshmask.nc</i></font>
243     
244    </h4>
245
246   
247 the name of the reduced meshmask file.
248
249   
250   
251
252   
253    <h3>Keywords</h3>
254
255   
256    <a name="#_smallmeshmask_keyword_IODIR"></a>
257    <h4>IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
258     
259     
260     
261     
262     
263     
264     
265     
266    </h4>
267
268     to define the files path.
269   
270   
271
272    <h3>Examples</h3><pre>
273 IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/'
274 IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir
275
276    </pre><h3>Version history</h3>
277   
278    <h4>Version</h4>
279 $Id: smallmeshmask.pro 231 2007-03-19 17:15:51Z pinsard $
280
281    <h4>History</h4>
282      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)
283
284   
285
286   
287   
288   
289   
290   
291
292   
293   
294   
295   
296   
297   
298   
299
300    <font size="-3"><p>&nbsp;</p></font>
301    <hr size="1" color="#CCCCCC"/>
302     
303
304   
305
306    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
307
308  </body>
309</html>
Note: See TracBrowser for help on using the repository browser.