- Timestamp:
- 07/23/09 11:18:49 (15 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_getmask.html
r363 r402 74 74 </font></h2> 75 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_ 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>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 77 78 78 … … 103 103 the full path) to be opened (in that case, the file will be opened 104 104 and closed within ncdf_getmask). 105 105 106 if fileid is a scalar then it is the id of the file return by a call 106 107 to ncdf_open outside of ncdf_getmask (in that case, the file will … … 127 128 128 129 129 put 1 to apply add_offset a d scale factor on data before looking for130 put 1 to apply add_offset and scale factor on data before looking for 130 131 missing values when using USEASMASK keyword 131 132 … … 206 207 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 208 314 <a name="#_ncdf_getmask_keyword_TESTOP"></a> 209 315 <h4>TESTOP … … 222 328 mask. The test is performed on the variable specified by USEASMASK 223 329 keyword. 330 224 331 TESTOP can contain 1 or 2 words. The first word is the operator 225 332 definition: "EQ" "NE" "GE" "GT" "LE" "LT" (default is NE). The … … 250 357 <h3>Examples</h3><pre> 251 358 252 IDL> mask = ncdf_getmask('HadISST1_1m_187001_200702_sst_reg1m.nc',useasmask = 'sst', missing_value = -1.00000e+30)253 254 IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask')255 256 IDL> mask = ncdf_getmask('t106.nc', useasmask = 'SLM', testop = 'le 0.5')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') 257 364 258 365 </pre><h3>Version history</h3> 259 366 260 367 <h4>Version</h4> 261 $Id: ncdf_getmask.pro 3 61 2008-07-07 14:23:42Z smasson $368 $Id: ncdf_getmask.pro 399 2009-07-02 08:38:54Z smasson $ 262 369 263 370 <h4>History</h4>
Note: See TracChangeset
for help on using the changeset viewer.
