source: trunk/SRC/Documentation/idldoc_assistant_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: 6.4 KB
Line 
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__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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
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 if fileid is a scalar then it is the id of the file return by a call
106 to ncdf_open outside of ncdf_getmask (in that case, the file will
107 NOT be opened and closed within ncdf_getmask)
108
109   
110   
111
112   
113    <h3>Keywords</h3>
114
115   
116    <a name="#_ncdf_getmask_keyword_ADDSCL_BEFORE"></a>
117    <h4>ADDSCL_BEFORE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
118     
119     
120     
121     
122     
123      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
124      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
125     
126    </h4>
127
128   
129 put 1 to apply add_offset ad scale factor on data before looking for
130 missing values when using USEASMASK keyword
131
132   
133    <a name="#_ncdf_getmask_keyword_MASKNAME"></a>
134    <h4>MASKNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
135     
136     
137     
138     
139     
140      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
141     
142     
143    </h4>
144
145   
146 A string giving the name of the variable in the file
147 that contains the land/sea mask
148
149   
150    <a name="#_ncdf_getmask_keyword_USEASMASK"></a>
151    <h4>USEASMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152     
153     
154     
155     
156     
157      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
158     
159     
160    </h4>
161
162   
163 A string giving the name of the variable in the file
164 that will be used to build the land/sea mask. In this case the
165 mask is based on the first record (if record dimension
166 exists). The mask is build according to :
167    1 the keyword missing_value if existing
168    2 the attribute 'missing_value' if existing
169    3 NaN values if existing
170
171   
172    <a name="#_ncdf_getmask_keyword_MISSING_VALUE"></a>
173    <h4>MISSING_VALUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
174     
175     
176     
177     
178     
179      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
180     
181     
182    </h4>
183
184   
185 To define (or redefine if the attribute is
186 already existing) the missing values used with USEASMASK
187 keyword
188
189   
190    <a name="#_ncdf_getmask_keyword_INVMASK"></a>
191    <h4>INVMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192     
193     
194     
195     
196     
197      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
198      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
199     
200    </h4>
201
202   
203 Inverse the land/sea mask (that should have 0/1 values for land/sea): mask = 1-mask
204
205   
206    <a name="#_ncdf_getmask_keyword__EXTRA"></a>
207    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208     
209     
210     
211     
212     
213     
214     
215     
216    </h4>
217
218     to be able to call ncdf_getmask with _extra keyword
219
220   
221   
222
223    <h3>Examples</h3><pre>
224
225 IDL> mask = ncdf_getmask('HadISST1_1m_187001_200702_sst_reg1m.nc',useasmask = 'sst', missing_value = -1.00000e+30)
226
227 IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask')
228
229    </pre><h3>Version history</h3>
230   
231    <h4>Version</h4>
232 $Id: ncdf_getmask.pro 327 2007-12-13 16:22:35Z pinsard $
233
234    <h4>History</h4>
235 August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr)
236
237   
238
239   
240   
241   
242   
243   
244
245   
246   
247   
248   
249   
250   
251   
252
253    <font size="-3"><p>&nbsp;</p></font>
254    <hr size="1" color="#CCCCCC"/>
255     
256
257   
258
259    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
260
261  </body>
262</html>
Note: See TracBrowser for help on using the repository browser.