source: trunk/SRC/Documentation/idldoc_assistant_output/Grid/micromeshmask.html @ 189

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

introducing hyperlinks in idldoc outputs (2/2)

File size: 5.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>micromeshmask.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="computegrid.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="n128gaussian.html"><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>micromeshmask.pro</h2>
59
60    <dl>
61    </dl>
62
63     
64 Reduce the size of the NetCDF meshmask created by OPA by
65 using bit (and not byte) format for the masks and the float format
66 for the other 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="#_micromeshmask">micromeshmask<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    <h3>Version history</h3>
169   
170    <h4>Version</h4> 
171 $Id: micromeshmask.pro 157 2006-08-21 09:01:50Z navarro $
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="#_micromeshmask"></a>
196
197      <h2>micromeshmask  </h2>
198
199      <p><font face="Courier">micromeshmask<i>, <a href="#_micromeshmask_keyword_ncfilein">ncfilein</a>[, <a href="#_micromeshmask_keyword_ncfileout">ncfileout</a>]</i>, <a href="#_micromeshmask_keyword_IODIR">IODIR</a>=<i>IODIR</i></font></p>
200
201   
202
203
204   
205
206   
207    <h3>Parameters</h3>
208   
209
210    <a name="#_micromeshmask_keyword_ncfilein"></a>
211    <h4>ncfilein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
212      <font size="-1" color="#006633">in</font>
213     
214     
215      <font size="-1" color="#006633">required</font>
216     
217     
218     
219     
220    </h4>
221
222   
223 1) the name of the meshmask file to be reduced. In that case,
224 there is only one meshmask file
225
226 OR
227
228 2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc
229 xxx.mask.nc. In that case, the meshmask is split into 3 files.
230
231   
232
233    <a name="#_micromeshmask_keyword_ncfileout"></a>
234    <h4>ncfileout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235      <font size="-1" color="#006633">in</font>
236     
237      <font size="-1" color="#006633">optional</font>
238     
239     
240     
241     
242     
243    </h4>
244
245     the name of the uniq reduced meshmask file.
246 default definition is micromeshmask.nc
247
248   
249   
250
251   
252    <h3>Keywords</h3>
253
254   
255    <a name="#_micromeshmask_keyword_IODIR"></a>
256    <h4>IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
257     
258     
259     
260     
261     
262     
263     
264     
265    </h4>
266
267     to define the files path.
268
269   
270   
271
272    <h3>Examples</h3>
273 IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/'
274 IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir
275
276   
277   
278   
279   
280   
281
282   
283   
284   
285   
286   
287
288   
289   
290   
291   
292   
293   
294   
295
296    <font size="-3"><p>&nbsp;</p></font>
297    <hr size="1" color="#CCCCCC"/>
298     
299
300   
301
302    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
303
304  </body>
305</html>
Note: See TracBrowser for help on using the repository browser.