source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/ncdf_getmask.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 7.6 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>ncdf_getmask.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="ncdf_getmask.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="../../../ReadWrite//ncdf_getmask.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="ncdf_getaxis.html">&lt;&lt;prev file</a> | <a href="ncdf_gettime.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="ncdf_getmask.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&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">ReadWrite/</a></h1>
82      <h2 class="pro_file">ncdf_getmask.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 get the land/sea mask array from a NetCDF file
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_ncdf_getmask">
105
106          <h2><a class="top" href="#container">top</a>ncdf_getmask <span class="categories">
107 Read NetCDF file
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>ncdf_getmask(<span class="result"><a href="#_ncdf_getmask_param_fileid">fileid</a></span>, <a href="#_ncdf_getmask_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_getmask_keyword_MASKNAME">MASKNAME</a>=<span class="result">string</span>, <a href="#_ncdf_getmask_keyword_USEASMASK">USEASMASK</a>=<span class="result">scalar string</span>, <a href="#_ncdf_getmask_keyword_MISSING_VALUE">MISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_ncdf_getmask_keyword_INVMASK">INVMASK</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_getmask_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 the land/sea mask 2D or 3D array or -1 in case of error or mask absence
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_ncdf_getmask_param_fileid">fileid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125              <span class="attr">in</span>
126             
127             
128              <span class="attr">required</span>
129             
130              <span class="attr">type:</span> <span class="value">salar string or long</span>
131             
132             
133            </h4>
134       
135          <div class="comments">
136 if fileid is a scalar string then it is the name of the file (with
137 the full path) to be opened (in that case, the file will be opened
138 and closed within ncdf_getmask).
139 if fileid is a scalar then it is the id of the file return by a call
140 to ncdf_open outside of ncdf_getmask (in that case, the file will
141 NOT be opened and closed within ncdf_getmask)
142</div>
143           
144
145         
146
147         
148
149            <h3>Keywords</h3>
150           
151            <h4 id="_ncdf_getmask_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152             
153             
154             
155             
156             
157              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
158              <span class="attr">default:</span> <span class="value">0</span>
159             
160            </h4>
161       
162            <div class="comments">
163 put 1 to apply add_offset ad scale factor on data before looking for
164 missing values when using USEASMASK keyword
165</div>
166           
167            <h4 id="_ncdf_getmask_keyword_MASKNAME">MASKNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168             
169             
170             
171             
172             
173              <span class="attr">type:</span> <span class="value">string</span>
174             
175             
176            </h4>
177       
178            <div class="comments">
179 A string giving the name of the variable in the file
180 that contains the land/sea mask
181</div>
182           
183            <h4 id="_ncdf_getmask_keyword_USEASMASK">USEASMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
184             
185             
186             
187             
188             
189              <span class="attr">type:</span> <span class="value">scalar string</span>
190             
191             
192            </h4>
193       
194            <div class="comments">
195 A string giving the name of the variable in the file
196 that will be used to build the land/sea mask. In this case the
197 mask is based on the first record (if record dimension
198 exists). The mask is build according to :
199    1 the keyword missing_value if existing
200    2 the attribute 'missing_value' if existing
201    3 NaN values if existing
202</div>
203           
204            <h4 id="_ncdf_getmask_keyword_MISSING_VALUE">MISSING_VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205             
206             
207             
208             
209             
210              <span class="attr">type:</span> <span class="value">scalar</span>
211             
212             
213            </h4>
214       
215            <div class="comments">
216 To define (or redefine if the attribute is
217 already existing) the missing values used with USEASMASK
218 keyword
219</div>
220           
221            <h4 id="_ncdf_getmask_keyword_INVMASK">INVMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
222             
223             
224             
225             
226             
227              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
228              <span class="attr">default:</span> <span class="value">0</span>
229             
230            </h4>
231       
232            <div class="comments">
233 Inverse the land/sea mask (that should have 0/1 values for land/sea): mask = 1-mask
234</div>
235           
236            <h4 id="_ncdf_getmask_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
237             
238             
239             
240             
241             
242             
243             
244             
245            </h4>
246       
247            <div class="comments"> to be able to call ncdf_getmask with _extra keyword
248</div>
249           
250         
251
252          <h3>Examples</h3><div class="preformat">
253
254 IDL> mask = ncdf_getmask('HadISST1_1m_187001_200702_sst_reg1m.nc',useasmask = 'sst', missing_value = -1.00000e+30)
255
256 IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask')
257</div>
258          <h3>Version history</h3>
259         
260          <h4>Version</h4><div class="preformat">
261 $Id: ncdf_getmask.pro 327 2007-12-13 16:22:35Z pinsard $
262</div>
263          <h4>History</h4><div class="preformat">
264 August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr)
265</div>
266         
267         
268         
269         
270         
271         
272         
273       
274         
275         
276         
277         
278         
279         
280         
281       
282          <h3>Statistics</h3>
283          <table class="statistics">
284            <tr><td>McCabe cyclic</td><td>          24</td></tr>
285            <tr><td>McCabe essential</td><td>           1</td></tr>
286            <tr><td>McCabe modular design</td><td>           1</td></tr>
287          </table>
288         
289       
290        </div>
291       
292      </div>
293
294     
295
296      <div id="tagline">Produced by IDLdoc 2.0.</div>
297
298    </div>
299
300  </body>
301</html>
Note: See TracBrowser for help on using the repository browser.