1 | |
---|
2 | |
---|
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
4 | <head> |
---|
5 | <title>ncdf_getmask.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="ncdf_getaxis.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="ncdf_gettime.html"><img src="./../next.gif" border="0" alt="Next"></a></td> |
---|
53 | </tr> |
---|
54 | </table> |
---|
55 | |
---|
56 | |
---|
57 | <h1><font size="-2">ReadWrite/</font></h1> |
---|
58 | <h2>ncdf_getmask.pro</h2> |
---|
59 | |
---|
60 | <dl> |
---|
61 | </dl> |
---|
62 | |
---|
63 | |
---|
64 | get the land/sea mask array from a NetCDF file |
---|
65 | |
---|
66 | |
---|
67 | |
---|
68 | |
---|
69 | |
---|
70 | <a name="#_ncdf_getmask"></a> |
---|
71 | |
---|
72 | <h2>ncdf_getmask <font size="-1" color="#006633"> |
---|
73 | Read NetCDF file |
---|
74 | </font></h2> |
---|
75 | |
---|
76 | <p><font face="Courier"><i>result = </i>ncdf_getmask(<i><a href="#_ncdf_getmask_keyword_fileid">fileid</a></i>, <a href="#_ncdf_getmask_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getmask_keyword_MASKNAME">MASKNAME</a>=<i>string</i>, <a href="#_ncdf_getmask_keyword_USEASMASK">USEASMASK</a>=<i>scalar string</i>, <a href="#_ncdf_getmask_keyword_MISSING_VALUE">MISSING_VALUE</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_INVMASK">INVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getmask_keyword_XMINMESH">XMINMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_XMAXMESH">XMAXMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_YMINMESH">YMINMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_YMAXMESH">YMAXMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_ZMINMESH">ZMINMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_ZMAXMESH">ZMAXMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_TESTOP">TESTOP</a>=<i>scalar string, for example 'GT 0.5'</i>, <a href="#_ncdf_getmask_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> |
---|
77 | |
---|
78 | |
---|
79 | |
---|
80 | |
---|
81 | <h3>Return value</h3> |
---|
82 | the land/sea mask 2D or 3D array or -1 in case of error or mask absence |
---|
83 | |
---|
84 | |
---|
85 | |
---|
86 | <h3>Parameters</h3> |
---|
87 | |
---|
88 | |
---|
89 | <a name="#_ncdf_getmask_keyword_fileid"></a> |
---|
90 | <h4>fileid |
---|
91 | <font size="-1" color="#006633">in</font> |
---|
92 | |
---|
93 | |
---|
94 | <font size="-1" color="#006633">required</font> |
---|
95 | |
---|
96 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>salar string or long</i></font> |
---|
97 | |
---|
98 | |
---|
99 | </h4> |
---|
100 | |
---|
101 | |
---|
102 | if fileid is a scalar string then it is the name of the file (with |
---|
103 | the full path) to be opened (in that case, the file will be opened |
---|
104 | and closed within ncdf_getmask). |
---|
105 | |
---|
106 | if fileid is a scalar then it is the id of the file return by a call |
---|
107 | to ncdf_open outside of ncdf_getmask (in that case, the file will |
---|
108 | NOT be opened and closed within ncdf_getmask) |
---|
109 | |
---|
110 | |
---|
111 | |
---|
112 | |
---|
113 | |
---|
114 | <h3>Keywords</h3> |
---|
115 | |
---|
116 | |
---|
117 | <a name="#_ncdf_getmask_keyword_ADDSCL_BEFORE"></a> |
---|
118 | <h4>ADDSCL_BEFORE |
---|
119 | |
---|
120 | |
---|
121 | |
---|
122 | |
---|
123 | |
---|
124 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> |
---|
125 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> |
---|
126 | |
---|
127 | </h4> |
---|
128 | |
---|
129 | |
---|
130 | put 1 to apply add_offset and scale factor on data before looking for |
---|
131 | missing values when using USEASMASK keyword |
---|
132 | |
---|
133 | |
---|
134 | <a name="#_ncdf_getmask_keyword_MASKNAME"></a> |
---|
135 | <h4>MASKNAME |
---|
136 | |
---|
137 | |
---|
138 | |
---|
139 | |
---|
140 | |
---|
141 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> |
---|
142 | |
---|
143 | |
---|
144 | </h4> |
---|
145 | |
---|
146 | |
---|
147 | A string giving the name of the variable in the file |
---|
148 | that contains the land/sea mask |
---|
149 | |
---|
150 | |
---|
151 | <a name="#_ncdf_getmask_keyword_USEASMASK"></a> |
---|
152 | <h4>USEASMASK |
---|
153 | |
---|
154 | |
---|
155 | |
---|
156 | |
---|
157 | |
---|
158 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> |
---|
159 | |
---|
160 | |
---|
161 | </h4> |
---|
162 | |
---|
163 | |
---|
164 | A string giving the name of the variable in the file |
---|
165 | that will be used to build the land/sea mask. In this case the |
---|
166 | mask is based on the first record (if record dimension |
---|
167 | exists). The mask is build according to operator defined by TESTOP |
---|
168 | keyword (default NE) and the testing values defined as |
---|
169 | 1) the second word of TESTOP if existing |
---|
170 | 2) MISSING_VALUE keyword |
---|
171 | 3) attribute missing_value or _fillvalue of the variable USEASMASK |
---|
172 | 4) !Values.f_nan (can be used only with NE and EQ operators) |
---|
173 | |
---|
174 | |
---|
175 | <a name="#_ncdf_getmask_keyword_MISSING_VALUE"></a> |
---|
176 | <h4>MISSING_VALUE |
---|
177 | |
---|
178 | |
---|
179 | |
---|
180 | |
---|
181 | |
---|
182 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> |
---|
183 | |
---|
184 | |
---|
185 | </h4> |
---|
186 | |
---|
187 | |
---|
188 | To define (or redefine if the attribute is already existing) the |
---|
189 | missing values used with USEASMASK keyword. Note that this value is |
---|
190 | not used if TESTOP keyword is given and contains 2 words. |
---|
191 | |
---|
192 | |
---|
193 | <a name="#_ncdf_getmask_keyword_INVMASK"></a> |
---|
194 | <h4>INVMASK |
---|
195 | |
---|
196 | |
---|
197 | |
---|
198 | |
---|
199 | |
---|
200 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> |
---|
201 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> |
---|
202 | |
---|
203 | </h4> |
---|
204 | |
---|
205 | |
---|
206 | Inverse the land/sea mask (that should have 0/1 values for land/sea): mask = 1-mask |
---|
207 | |
---|
208 | |
---|
209 | <a name="#_ncdf_getmask_keyword_XMINMESH"></a> |
---|
210 | <h4>XMINMESH |
---|
211 | |
---|
212 | |
---|
213 | |
---|
214 | |
---|
215 | |
---|
216 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> |
---|
217 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> |
---|
218 | |
---|
219 | </h4> |
---|
220 | |
---|
221 | |
---|
222 | Define common (cm_4mesh) variables ixminmesh used to define the localization |
---|
223 | of the first point of the grid along the x direction in a zoom of the original grid |
---|
224 | |
---|
225 | |
---|
226 | <a name="#_ncdf_getmask_keyword_XMAXMESH"></a> |
---|
227 | <h4>XMAXMESH |
---|
228 | |
---|
229 | |
---|
230 | |
---|
231 | |
---|
232 | |
---|
233 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> |
---|
234 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpiglo-1</i></font> |
---|
235 | |
---|
236 | </h4> |
---|
237 | |
---|
238 | |
---|
239 | Define common (cm_4mesh) variables ixmaxmesh used to define the localization |
---|
240 | of the last point of the grid along the x direction in a zoom of the original grid |
---|
241 | Note that if XMAXMESH < 0 then ixmaxmesh is defined as ixmaxmesh = jpiglo -1 + xmaxmesh |
---|
242 | |
---|
243 | |
---|
244 | <a name="#_ncdf_getmask_keyword_YMINMESH"></a> |
---|
245 | <h4>YMINMESH |
---|
246 | |
---|
247 | |
---|
248 | |
---|
249 | |
---|
250 | |
---|
251 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> |
---|
252 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> |
---|
253 | |
---|
254 | </h4> |
---|
255 | |
---|
256 | |
---|
257 | Define common (cm_4mesh) variables iyminmesh used to define the localization |
---|
258 | of the first point of the grid along the y direction in a zoom of the original grid |
---|
259 | |
---|
260 | |
---|
261 | <a name="#_ncdf_getmask_keyword_YMAXMESH"></a> |
---|
262 | <h4>YMAXMESH |
---|
263 | |
---|
264 | |
---|
265 | |
---|
266 | |
---|
267 | |
---|
268 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> |
---|
269 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpjglo-1</i></font> |
---|
270 | |
---|
271 | </h4> |
---|
272 | |
---|
273 | |
---|
274 | Define common (cm_4mesh) variables iymaxmesh used to define the localization |
---|
275 | of the last point of the grid along the y direction in a zoom of the original grid |
---|
276 | Note that if YMAXMESH < 0 then iymaxmesh is defined as iymaxmesh = jpjglo -1 + ymaxmesh |
---|
277 | |
---|
278 | |
---|
279 | <a name="#_ncdf_getmask_keyword_ZMINMESH"></a> |
---|
280 | <h4>ZMINMESH |
---|
281 | |
---|
282 | |
---|
283 | |
---|
284 | |
---|
285 | |
---|
286 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> |
---|
287 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> |
---|
288 | |
---|
289 | </h4> |
---|
290 | |
---|
291 | |
---|
292 | Define common (cm_4mesh) variables izminmesh used to define the localization |
---|
293 | of the first point of the grid along the z direction in a zoom of the original grid |
---|
294 | |
---|
295 | |
---|
296 | <a name="#_ncdf_getmask_keyword_ZMAXMESH"></a> |
---|
297 | <h4>ZMAXMESH |
---|
298 | |
---|
299 | |
---|
300 | |
---|
301 | |
---|
302 | |
---|
303 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> |
---|
304 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpkglo-1</i></font> |
---|
305 | |
---|
306 | </h4> |
---|
307 | |
---|
308 | |
---|
309 | Define common (cm_4mesh) variables izmaxmesh used to define the localization |
---|
310 | of the last point of the grid along the z direction in a zoom of the original grid |
---|
311 | Note that if ZMAXMESH < 0 then izmaxmesh is defined as izmaxmesh = jpkglo -1 + maxmesh |
---|
312 | |
---|
313 | |
---|
314 | <a name="#_ncdf_getmask_keyword_TESTOP"></a> |
---|
315 | <h4>TESTOP |
---|
316 | |
---|
317 | |
---|
318 | |
---|
319 | |
---|
320 | |
---|
321 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string, for example 'GT 0.5'</i></font> |
---|
322 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'NE'</i></font> |
---|
323 | |
---|
324 | </h4> |
---|
325 | |
---|
326 | |
---|
327 | a string describing the type of test that will be done to define the |
---|
328 | mask. The test is performed on the variable specified by USEASMASK |
---|
329 | keyword. |
---|
330 | |
---|
331 | TESTOP can contain 1 or 2 words. The first word is the operator |
---|
332 | definition: "EQ" "NE" "GE" "GT" "LE" "LT" (default is NE). The |
---|
333 | second word define the testing value. If TESTOP contains only 1 |
---|
334 | word, then the test value is denifed by |
---|
335 | 1) MISSING_VALUE keyword |
---|
336 | 2) attribute missing_value or _fillvalue of the variable USEASMASK |
---|
337 | 3) !Values.f_nan (can be used only with NE and EQ operators) |
---|
338 | |
---|
339 | |
---|
340 | <a name="#_ncdf_getmask_keyword__EXTRA"></a> |
---|
341 | <h4>_EXTRA |
---|
342 | |
---|
343 | |
---|
344 | |
---|
345 | |
---|
346 | |
---|
347 | |
---|
348 | |
---|
349 | |
---|
350 | </h4> |
---|
351 | |
---|
352 | to be able to call ncdf_getmask with _extra keyword |
---|
353 | |
---|
354 | |
---|
355 | |
---|
356 | |
---|
357 | <h3>Examples</h3><pre> |
---|
358 | |
---|
359 | IDL> mask = ncdf_getmask('HadISST1_1m_187001_200702_sst_reg1m.nc',useasmask = 'sst', missing_value = -1.00000e+30) |
---|
360 | |
---|
361 | IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask') |
---|
362 | |
---|
363 | IDL> mask = ncdf_getmask('t106.nc', useasmask = 'SLM', testop = 'le 0.5') |
---|
364 | |
---|
365 | </pre><h3>Version history</h3> |
---|
366 | |
---|
367 | <h4>Version</h4> |
---|
368 | $Id: ncdf_getmask.pro 399 2009-07-02 08:38:54Z smasson $ |
---|
369 | |
---|
370 | <h4>History</h4> |
---|
371 | August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
372 | |
---|
373 | |
---|
374 | |
---|
375 | |
---|
376 | |
---|
377 | |
---|
378 | |
---|
379 | |
---|
380 | |
---|
381 | |
---|
382 | |
---|
383 | |
---|
384 | |
---|
385 | |
---|
386 | |
---|
387 | |
---|
388 | |
---|
389 | <font size="-3"><p> </p></font> |
---|
390 | <hr size="1" color="#CCCCCC"/> |
---|
391 | |
---|
392 | |
---|
393 | |
---|
394 | |
---|
395 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
---|
396 | |
---|
397 | </body> |
---|
398 | </html> |
---|