source: trunk/SRC/Documentation/idldoc_assistant_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: 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
119    <a name="#_ncdf_transfer_keyword_outid"></a>
120    <h4>outid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
121      <font size="-1" color="#006633">in</font>
122     
123     
124      <font size="-1" color="#006633">required</font>
125     
126     
127     
128     
129    </h4>
130
131   
132
133   
134
135    <a name="#_ncdf_transfer_keyword_inname"></a>
136    <h4>inname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
137      <font size="-1" color="#006633">in</font>
138     
139     
140      <font size="-1" color="#006633">required</font>
141     
142     
143     
144     
145    </h4>
146
147   
148
149   
150
151    <a name="#_ncdf_transfer_keyword_outname"></a>
152    <h4>outname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153      <font size="-1" color="#006633">in</font>
154     
155      <font size="-1" color="#006633">optional</font>
156     
157     
158     
159     
160     
161    </h4>
162
163   
164
165   
166   
167
168   
169
170   
171    </pre><h3>Version history</h3>
172   
173    <h4>Version</h4>
174 $Id: smallmeshmask.pro 371 2008-08-07 09:32:02Z pinsard $
175
176    <h4>History</h4>
177      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)
178
179   
180
181   
182   
183   
184   
185   
186
187   
188   
189   
190   
191   
192   
193   
194
195    <font size="-3"><p>&nbsp;</p></font>
196    <hr size="1" color="#CCCCCC"/>
197     
198      <a name="#_smallmeshmask"></a>
199
200      <h2>smallmeshmask  <font size="-1" color="#006633">
201 For OPA
202</font></h2>
203
204      <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>
205
206   
207
208
209   
210
211   
212    <h3>Parameters</h3>
213   
214
215    <a name="#_smallmeshmask_keyword_ncfilein"></a>
216    <h4>ncfilein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
217      <font size="-1" color="#006633">in</font>
218     
219     
220      <font size="-1" color="#006633">required</font>
221     
222     
223     
224     
225    </h4>
226
227   
228 1) the name of the meshmask file to be reduced. In that case,
229 there is only one meshmask file
230
231 OR
232
233 2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc
234 xxx.mask.nc. In that case, the meshmask is split into 3 files.
235
236   
237
238    <a name="#_smallmeshmask_keyword_ncfileout"></a>
239    <h4>ncfileout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
240      <font size="-1" color="#006633">in</font>
241     
242      <font size="-1" color="#006633">optional</font>
243     
244     
245     
246      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>smallmeshmask.nc</i></font>
247     
248    </h4>
249
250   
251 the name of the reduced meshmask file.
252
253   
254   
255
256   
257    <h3>Keywords</h3>
258
259   
260    <a name="#_smallmeshmask_keyword_IODIR"></a>
261    <h4>IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
262     
263     
264     
265     
266     
267     
268     
269     
270    </h4>
271
272   
273 to define the files path.
274
275   
276   
277
278    <h3>Examples</h3><pre>
279
280   IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/'
281   IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir
282
283    </pre><h3>Version history</h3>
284   
285    <h4>Version</h4>
286 $Id: smallmeshmask.pro 371 2008-08-07 09:32:02Z pinsard $
287
288    <h4>History</h4>
289      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)
290
291   
292
293   
294   
295   
296   
297   
298
299   
300   
301   
302   
303   
304   
305   
306
307    <font size="-3"><p>&nbsp;</p></font>
308    <hr size="1" color="#CCCCCC"/>
309     
310
311   
312
313    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
314
315  </body>
316</html>
Note: See TracBrowser for help on using the repository browser.