- Timestamp:
- 07/23/09 11:18:49 (15 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ReadWrite/ncdf_getmask.html
r363 r402 109 109 110 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_ TESTOP">TESTOP</a>=<span class="result">scalar string, for example 'GT 0.5'</span>, <a href="#_ncdf_getmask_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>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_XMINMESH">XMINMESH</a>=<span class="result">scalar</span>, <a href="#_ncdf_getmask_keyword_XMAXMESH">XMAXMESH</a>=<span class="result">scalar</span>, <a href="#_ncdf_getmask_keyword_YMINMESH">YMINMESH</a>=<span class="result">scalar</span>, <a href="#_ncdf_getmask_keyword_YMAXMESH">YMAXMESH</a>=<span class="result">scalar</span>, <a href="#_ncdf_getmask_keyword_ZMINMESH">ZMINMESH</a>=<span class="result">scalar</span>, <a href="#_ncdf_getmask_keyword_ZMAXMESH">ZMAXMESH</a>=<span class="result">scalar</span>, <a href="#_ncdf_getmask_keyword_TESTOP">TESTOP</a>=<span class="result">scalar string, for example 'GT 0.5'</span>, <a href="#_ncdf_getmask_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 112 112 113 113 <div class="comments"> … … 137 137 the full path) to be opened (in that case, the file will be opened 138 138 and closed within ncdf_getmask). 139 139 140 if fileid is a scalar then it is the id of the file return by a call 140 141 to ncdf_open outside of ncdf_getmask (in that case, the file will … … 161 162 162 163 <div class="comments"> 163 put 1 to apply add_offset a d scale factor on data before looking for164 put 1 to apply add_offset and scale factor on data before looking for 164 165 missing values when using USEASMASK keyword 165 166 </div> … … 236 237 </div> 237 238 239 <h4 id="_ncdf_getmask_keyword_XMINMESH">XMINMESH 240 241 242 243 244 245 <span class="attr">type:</span> <span class="value">scalar</span> 246 <span class="attr">default:</span> <span class="value">0L</span> 247 248 </h4> 249 250 <div class="comments"> 251 Define common (cm_4mesh) variables ixminmesh used to define the localization 252 of the first point of the grid along the x direction in a zoom of the original grid 253 </div> 254 255 <h4 id="_ncdf_getmask_keyword_XMAXMESH">XMAXMESH 256 257 258 259 260 261 <span class="attr">type:</span> <span class="value">scalar</span> 262 <span class="attr">default:</span> <span class="value">jpiglo-1</span> 263 264 </h4> 265 266 <div class="comments"> 267 Define common (cm_4mesh) variables ixmaxmesh used to define the localization 268 of the last point of the grid along the x direction in a zoom of the original grid 269 Note that if XMAXMESH < 0 then ixmaxmesh is defined as ixmaxmesh = jpiglo -1 + xmaxmesh 270 </div> 271 272 <h4 id="_ncdf_getmask_keyword_YMINMESH">YMINMESH 273 274 275 276 277 278 <span class="attr">type:</span> <span class="value">scalar</span> 279 <span class="attr">default:</span> <span class="value">0L</span> 280 281 </h4> 282 283 <div class="comments"> 284 Define common (cm_4mesh) variables iyminmesh used to define the localization 285 of the first point of the grid along the y direction in a zoom of the original grid 286 </div> 287 288 <h4 id="_ncdf_getmask_keyword_YMAXMESH">YMAXMESH 289 290 291 292 293 294 <span class="attr">type:</span> <span class="value">scalar</span> 295 <span class="attr">default:</span> <span class="value">jpjglo-1</span> 296 297 </h4> 298 299 <div class="comments"> 300 Define common (cm_4mesh) variables iymaxmesh used to define the localization 301 of the last point of the grid along the y direction in a zoom of the original grid 302 Note that if YMAXMESH < 0 then iymaxmesh is defined as iymaxmesh = jpjglo -1 + ymaxmesh 303 </div> 304 305 <h4 id="_ncdf_getmask_keyword_ZMINMESH">ZMINMESH 306 307 308 309 310 311 <span class="attr">type:</span> <span class="value">scalar</span> 312 <span class="attr">default:</span> <span class="value">0L</span> 313 314 </h4> 315 316 <div class="comments"> 317 Define common (cm_4mesh) variables izminmesh used to define the localization 318 of the first point of the grid along the z direction in a zoom of the original grid 319 </div> 320 321 <h4 id="_ncdf_getmask_keyword_ZMAXMESH">ZMAXMESH 322 323 324 325 326 327 <span class="attr">type:</span> <span class="value">scalar</span> 328 <span class="attr">default:</span> <span class="value">jpkglo-1</span> 329 330 </h4> 331 332 <div class="comments"> 333 Define common (cm_4mesh) variables izmaxmesh used to define the localization 334 of the last point of the grid along the z direction in a zoom of the original grid 335 Note that if ZMAXMESH < 0 then izmaxmesh is defined as izmaxmesh = jpkglo -1 + maxmesh 336 </div> 337 238 338 <h4 id="_ncdf_getmask_keyword_TESTOP">TESTOP 239 339 … … 251 351 mask. The test is performed on the variable specified by USEASMASK 252 352 keyword. 353 253 354 TESTOP can contain 1 or 2 words. The first word is the operator 254 355 definition: "EQ" "NE" "GE" "GT" "LE" "LT" (default is NE). The … … 278 379 <h3>Examples</h3><div class="preformat"> 279 380 280 IDL> mask = ncdf_getmask('HadISST1_1m_187001_200702_sst_reg1m.nc',useasmask = 'sst', missing_value = -1.00000e+30)281 282 IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask')283 284 IDL> mask = ncdf_getmask('t106.nc', useasmask = 'SLM', testop = 'le 0.5')381 IDL> mask = ncdf_getmask('HadISST1_1m_187001_200702_sst_reg1m.nc',useasmask = 'sst', missing_value = -1.00000e+30) 382 383 IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask') 384 385 IDL> mask = ncdf_getmask('t106.nc', useasmask = 'SLM', testop = 'le 0.5') 285 386 </div> 286 387 <h3>Version history</h3> 287 388 288 389 <h4>Version</h4><div class="preformat"> 289 $Id: ncdf_getmask.pro 3 61 2008-07-07 14:23:42Z smasson $390 $Id: ncdf_getmask.pro 399 2009-07-02 08:38:54Z smasson $ 290 391 </div> 291 392 <h4>History</h4><div class="preformat"> … … 310 411 <h3>Statistics</h3> 311 412 <table class="statistics"> 312 <tr><td>McCabe cyclic</td><td> 34</td></tr>313 <tr><td>McCabe essential</td><td> 1</td></tr>314 <tr><td>McCabe modular design</td><td> 1</td></tr>413 <tr><td>McCabe cyclic</td><td> 43</td></tr> 414 <tr><td>McCabe essential</td><td> 5</td></tr> 415 <tr><td>McCabe modular design</td><td> 5</td></tr> 315 416 </table> 316 417
Note: See TracChangeset
for help on using the changeset viewer.
