[290] | 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>file_interp.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="file_interp.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="../../../Interpolation//file_interp.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 documentation</td> |
---|
| 67 | </tr> |
---|
| 68 | </table> |
---|
| 69 | |
---|
| 70 | </div> |
---|
| 71 | |
---|
| 72 | <div id="secondary_navbar"> |
---|
| 73 | |
---|
| 74 | <a href="extrapsmooth.html"><<prev file</a> | <a href="fromirr.html">next file >></a> <a href="file_interp.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a> summary: fields | routine 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">Interpolation/</a></h1> |
---|
| 82 | <h2 class="pro_file">file_interp.pro</h2> |
---|
| 83 | |
---|
| 84 | <div id="file_attr"> |
---|
| 85 | <dl> |
---|
| 86 | </dl> |
---|
| 87 | </div> |
---|
| 88 | |
---|
| 89 | <div id="file_comments"> |
---|
| 90 | interpolate a NetCDF file from a grid to another (both regular or not) |
---|
| 91 | </div> |
---|
| 92 | |
---|
| 93 | |
---|
| 94 | |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | |
---|
| 98 | |
---|
| 99 | |
---|
| 100 | |
---|
| 101 | <div id="routine_details"> |
---|
| 102 | |
---|
| 103 | |
---|
| 104 | <div class="routine_details" id="_file_interp"> |
---|
| 105 | |
---|
| 106 | <h2><a class="top" href="#container">top</a>file_interp <span class="categories"> |
---|
[321] | 107 | Interpolation, NetCDF |
---|
[290] | 108 | </span></h2> |
---|
| 109 | |
---|
| 110 | <p class="header"> |
---|
[363] | 111 | file_interp<span class="result">, <a href="#_file_interp_param_filein">filein</a>, <a href="#_file_interp_param_fileout">fileout</a>, <a href="#_file_interp_param_gridout">gridout</a></span>, <a href="#_file_interp_keyword_GRIDIN">GRIDIN</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_MASKIN">MASKIN</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_MASKOUT">MASKOUT</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_KEEP">KEEP</a>=<span class="result">string array</span>, <a href="#_file_interp_keyword_REMOVE">REMOVE</a>=<span class="result">string array</span>, <a href="#_file_interp_keyword_METHOD">METHOD</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SMOOTH">SMOOTH</a>=<span class="result">scalar 0 or 1</span>, <a href="#_file_interp_keyword_SET_XDIMNAME">SET_XDIMNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SET_YDIMNAME">SET_YDIMNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SET_XAXISNAME">SET_XAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_SET_YAXISNAME">SET_YAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_INMASKNAME">INMASKNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_ININVMASK">ININVMASK</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_INUSEASMASK">INUSEASMASK</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_INMISSING_VALUE">INMISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_file_interp_keyword_INADDSCL_BEFORE">INADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_INTESTOP">INTESTOP</a>=<span class="result">scalar string, for example 'GT 0.5'</span>, <a href="#_file_interp_keyword_OUTMASKNAME">OUTMASKNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTINVMASK">OUTINVMASK</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_OUTUSEASMASK">OUTUSEASMASK</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTMISSING_VALUE">OUTMISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_file_interp_keyword_OUTADDSCL_BEFORE">OUTADDSCL_BEFORE</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_file_interp_keyword_OUTTESTOP">OUTTESTOP</a>=<span class="result">scalar string, for example 'GT 0.5'</span>, <a href="#_file_interp_keyword_MISSING_VALUE">MISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_file_interp_keyword_WEIG">WEIG</a>=<span class="result">2d array or variable name</span>, <a href="#_file_interp_keyword_ADDR">ADDR</a>=<span class="result">2d array or variable name</span>, <a href="#_file_interp_keyword_INXAXISNAME">INXAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_INYAXISNAME">INYAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTXAXISNAME">OUTXAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword_OUTYAXISNAME">OUTYAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_file_interp_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> |
---|
[290] | 112 | |
---|
| 113 | <div class="comments"> |
---|
| 114 | </div> |
---|
| 115 | |
---|
| 116 | |
---|
| 117 | |
---|
| 118 | |
---|
| 119 | <h3>Parameters</h3> |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | <h4 id="_file_interp_param_filein">filein |
---|
| 123 | <span class="attr">in</span> |
---|
| 124 | |
---|
| 125 | |
---|
| 126 | |
---|
| 127 | |
---|
| 128 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 129 | |
---|
| 130 | |
---|
| 131 | </h4> |
---|
| 132 | |
---|
| 133 | <div class="comments"> |
---|
| 134 | input file name (must exist) |
---|
| 135 | </div> |
---|
| 136 | |
---|
| 137 | <h4 id="_file_interp_param_fileout">fileout |
---|
| 138 | <span class="attr">in</span> |
---|
| 139 | |
---|
| 140 | |
---|
| 141 | |
---|
| 142 | |
---|
| 143 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 144 | |
---|
| 145 | |
---|
| 146 | </h4> |
---|
| 147 | |
---|
| 148 | <div class="comments"> |
---|
| 149 | output file name (will be overwritten if already exist) |
---|
| 150 | </div> |
---|
| 151 | |
---|
| 152 | <h4 id="_file_interp_param_gridout">gridout |
---|
| 153 | <span class="attr">in</span> |
---|
| 154 | |
---|
| 155 | |
---|
| 156 | |
---|
| 157 | |
---|
| 158 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 159 | |
---|
| 160 | |
---|
| 161 | </h4> |
---|
| 162 | |
---|
| 163 | <div class="comments"> |
---|
| 164 | output grid file name (must exist and must contain the |
---|
| 165 | longitude and latitude axis as 1D or 2D arrays) |
---|
| 166 | </div> |
---|
| 167 | |
---|
| 168 | |
---|
| 169 | |
---|
| 170 | |
---|
| 171 | |
---|
| 172 | |
---|
| 173 | <h3>Keywords</h3> |
---|
| 174 | |
---|
| 175 | <h4 id="_file_interp_keyword_GRIDIN">GRIDIN |
---|
| 176 | |
---|
| 177 | |
---|
| 178 | |
---|
| 179 | |
---|
| 180 | |
---|
| 181 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 182 | <span class="attr">default:</span> <span class="value">set to filein</span> |
---|
| 183 | |
---|
| 184 | </h4> |
---|
| 185 | |
---|
| 186 | <div class="comments"> |
---|
[321] | 187 | define the input grid file name. It must exist and must contain the |
---|
[290] | 188 | longitude and latitude axis as 1D or 2D arrays. Useful if |
---|
| 189 | filein file doesn't contain longitude and latitude axis |
---|
| 190 | </div> |
---|
| 191 | |
---|
| 192 | <h4 id="_file_interp_keyword_MASKIN">MASKIN |
---|
| 193 | |
---|
| 194 | |
---|
| 195 | |
---|
| 196 | |
---|
| 197 | |
---|
| 198 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 199 | <span class="attr">default:</span> <span class="value">set to gridin</span> |
---|
| 200 | |
---|
| 201 | </h4> |
---|
| 202 | |
---|
| 203 | <div class="comments"> |
---|
| 204 | define the input mask file name. It must exist. The mask will be |
---|
[321] | 205 | determined through <a href="..//ReadWrite/ncdf_getmask.html">ncdf_getmask</a> according to the keywords |
---|
[290] | 206 | inmaskname, ininvmask, inuseasmask, inmissing_value, inaddscl_before |
---|
[321] | 207 | (see below) |
---|
[290] | 208 | </div> |
---|
| 209 | |
---|
| 210 | <h4 id="_file_interp_keyword_MASKOUT">MASKOUT |
---|
| 211 | |
---|
| 212 | |
---|
| 213 | |
---|
| 214 | |
---|
| 215 | |
---|
| 216 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 217 | <span class="attr">default:</span> <span class="value">set to gridout</span> |
---|
| 218 | |
---|
| 219 | </h4> |
---|
| 220 | |
---|
| 221 | <div class="comments"> |
---|
| 222 | define the output mask file name. It must exist. The mask will be |
---|
[321] | 223 | determined through <a href="..//ReadWrite/ncdf_getmask.html">ncdf_getmask</a> according to the keywords |
---|
[290] | 224 | outmaskname, outinvmask, outuseasmask, outmissing_value, |
---|
[363] | 225 | outaddscl_before (see below). |
---|
[290] | 226 | </div> |
---|
| 227 | |
---|
| 228 | <h4 id="_file_interp_keyword_KEEP">KEEP |
---|
| 229 | |
---|
| 230 | |
---|
| 231 | |
---|
| 232 | |
---|
| 233 | |
---|
| 234 | <span class="attr">type:</span> <span class="value">string array</span> |
---|
| 235 | <span class="attr">default:</span> <span class="value">all variables</span> |
---|
| 236 | |
---|
| 237 | </h4> |
---|
| 238 | |
---|
| 239 | <div class="comments"> |
---|
| 240 | array defining the name of the variables that must be kept in the |
---|
| 241 | output file |
---|
| 242 | </div> |
---|
| 243 | |
---|
| 244 | <h4 id="_file_interp_keyword_REMOVE">REMOVE |
---|
| 245 | |
---|
| 246 | |
---|
| 247 | |
---|
| 248 | |
---|
| 249 | |
---|
| 250 | <span class="attr">type:</span> <span class="value">string array</span> |
---|
| 251 | <span class="attr">default:</span> <span class="value">empty</span> |
---|
| 252 | |
---|
| 253 | </h4> |
---|
| 254 | |
---|
| 255 | <div class="comments"> |
---|
| 256 | array defining the name of the variables that will be removed in the |
---|
| 257 | output file |
---|
| 258 | </div> |
---|
| 259 | |
---|
| 260 | <h4 id="_file_interp_keyword_METHOD">METHOD |
---|
| 261 | |
---|
| 262 | |
---|
| 263 | |
---|
| 264 | |
---|
| 265 | |
---|
| 266 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 267 | <span class="attr">default:</span> <span class="value">'bilinear'</span> |
---|
| 268 | |
---|
| 269 | </h4> |
---|
| 270 | |
---|
| 271 | <div class="comments"> |
---|
[321] | 272 | interpolation method: can be only 'bilinear' (or 'imoms3' if the input grid |
---|
[290] | 273 | is a "regular" grid). A "regular/rectangular grid" is defined as a |
---|
[321] | 274 | grid for which each longitude lines have the same latitude and each |
---|
[290] | 275 | latitude columns have the same longitude. |
---|
| 276 | </div> |
---|
| 277 | |
---|
| 278 | <h4 id="_file_interp_keyword_SMOOTH">SMOOTH |
---|
| 279 | |
---|
| 280 | |
---|
| 281 | |
---|
| 282 | |
---|
| 283 | |
---|
| 284 | <span class="attr">type:</span> <span class="value">scalar 0 or 1</span> |
---|
| 285 | <span class="attr">default:</span> <span class="value">0</span> |
---|
| 286 | |
---|
| 287 | </h4> |
---|
| 288 | |
---|
| 289 | <div class="comments"> |
---|
| 290 | activate to use <a href="..//Interpolation/extrapsmooth.html">extrapsmooth</a> instead of |
---|
| 291 | <a href="..//Interpolation/extrapolate.html">extrapolate</a> when extrapolating input data over masked |
---|
| 292 | points. |
---|
[321] | 293 | </div> |
---|
[290] | 294 | |
---|
| 295 | <h4 id="_file_interp_keyword_SET_XDIMNAME">SET_XDIMNAME |
---|
| 296 | |
---|
| 297 | |
---|
| 298 | |
---|
| 299 | |
---|
| 300 | |
---|
| 301 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 302 | <span class="attr">default:</span> <span class="value">not used</span> |
---|
| 303 | |
---|
| 304 | </h4> |
---|
| 305 | |
---|
| 306 | <div class="comments"> |
---|
| 307 | used to defined the name of x dimension in filein input file when |
---|
| 308 | gridin keyword is used and when the x dimension name is not the same |
---|
| 309 | in filein and gridin files. By default, we assume both file have the |
---|
| 310 | same x dimension name. |
---|
| 311 | </div> |
---|
| 312 | |
---|
| 313 | <h4 id="_file_interp_keyword_SET_YDIMNAME">SET_YDIMNAME |
---|
| 314 | |
---|
| 315 | |
---|
| 316 | |
---|
| 317 | |
---|
| 318 | |
---|
| 319 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 320 | <span class="attr">default:</span> <span class="value">not used</span> |
---|
| 321 | |
---|
| 322 | </h4> |
---|
| 323 | |
---|
| 324 | <div class="comments"> |
---|
| 325 | same as set_xdimname but for y dimension |
---|
| 326 | </div> |
---|
| 327 | |
---|
| 328 | <h4 id="_file_interp_keyword_SET_XAXISNAME">SET_XAXISNAME |
---|
| 329 | |
---|
| 330 | |
---|
| 331 | |
---|
| 332 | |
---|
| 333 | |
---|
| 334 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 335 | <span class="attr">default:</span> <span class="value">not used</span> |
---|
| 336 | |
---|
| 337 | </h4> |
---|
| 338 | |
---|
| 339 | <div class="comments"> |
---|
| 340 | used to defined the name of the variable containing the x axis in |
---|
| 341 | filein input file when gridin keyword is used and when its variable |
---|
| 342 | containing the x axis name is not the same. By default, we assume |
---|
| 343 | both file have the same x axis name. Not that if filein includes x |
---|
[321] | 344 | axis there is no point to use gridin |
---|
[290] | 345 | </div> |
---|
| 346 | |
---|
| 347 | <h4 id="_file_interp_keyword_SET_YAXISNAME">SET_YAXISNAME |
---|
| 348 | |
---|
| 349 | |
---|
| 350 | |
---|
| 351 | |
---|
| 352 | |
---|
| 353 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 354 | <span class="attr">default:</span> <span class="value">not used</span> |
---|
| 355 | |
---|
| 356 | </h4> |
---|
| 357 | |
---|
| 358 | <div class="comments"> |
---|
| 359 | same as set_xaxisname but for y dimension |
---|
| 360 | </div> |
---|
| 361 | |
---|
| 362 | <h4 id="_file_interp_keyword_INMASKNAME">INMASKNAME |
---|
| 363 | |
---|
| 364 | |
---|
| 365 | |
---|
| 366 | |
---|
| 367 | |
---|
| 368 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 369 | <span class="attr">default:</span> <span class="value">not used</span> |
---|
| 370 | |
---|
| 371 | </h4> |
---|
| 372 | |
---|
| 373 | <div class="comments"> |
---|
| 374 | A string giving the name of the variable in the file maskin that |
---|
[321] | 375 | contains the land/sea mask |
---|
[290] | 376 | </div> |
---|
| 377 | |
---|
| 378 | <h4 id="_file_interp_keyword_ININVMASK">ININVMASK |
---|
| 379 | |
---|
| 380 | |
---|
| 381 | |
---|
| 382 | |
---|
| 383 | |
---|
| 384 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
---|
| 385 | <span class="attr">default:</span> <span class="value">0</span> |
---|
| 386 | |
---|
| 387 | </h4> |
---|
| 388 | |
---|
| 389 | <div class="comments"> |
---|
| 390 | Inverse the land/sea mask of the input mask file maskin (that should |
---|
[321] | 391 | have 0/1 values for land/sea) |
---|
[290] | 392 | </div> |
---|
| 393 | |
---|
| 394 | <h4 id="_file_interp_keyword_INUSEASMASK">INUSEASMASK |
---|
| 395 | |
---|
| 396 | |
---|
| 397 | |
---|
| 398 | |
---|
| 399 | |
---|
| 400 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 401 | |
---|
| 402 | |
---|
| 403 | </h4> |
---|
| 404 | |
---|
| 405 | <div class="comments"> |
---|
[363] | 406 | A string giving the name of the variable in the input mask file |
---|
| 407 | that will be used to build the input land/sea mask. In this case the |
---|
[290] | 408 | mask is based on the first record (if record dimension |
---|
[363] | 409 | exists). The input mask is build according to operator defined by INTESTOP |
---|
| 410 | keyword (default NE) and the testing values defined as |
---|
| 411 | 1) the second word of TESTOP if existing |
---|
| 412 | 2) MISSING_VALUE keyword |
---|
| 413 | 3) attribute missing_value or _fillvalue of the variable USEASMASK |
---|
| 414 | 4) !Values.f_nan (can be used only with NE and EQ operators) |
---|
[290] | 415 | </div> |
---|
| 416 | |
---|
| 417 | <h4 id="_file_interp_keyword_INMISSING_VALUE">INMISSING_VALUE |
---|
| 418 | |
---|
| 419 | |
---|
| 420 | |
---|
| 421 | |
---|
| 422 | |
---|
| 423 | <span class="attr">type:</span> <span class="value">scalar</span> |
---|
| 424 | |
---|
| 425 | |
---|
| 426 | </h4> |
---|
| 427 | |
---|
| 428 | <div class="comments"> |
---|
| 429 | To define (or redefine if the attribute is already existing) the |
---|
[363] | 430 | missing values used with INUSEASMASK keyword to build the input mask. |
---|
| 431 | Note that this value is not used if INTESTOP keyword is given and |
---|
| 432 | contains 2 words. |
---|
| 433 | Note: do not mismatch with MISSING_VALUE used to detect missing |
---|
| 434 | values at reach record. |
---|
[290] | 435 | </div> |
---|
| 436 | |
---|
| 437 | <h4 id="_file_interp_keyword_INADDSCL_BEFORE">INADDSCL_BEFORE |
---|
| 438 | |
---|
| 439 | |
---|
| 440 | |
---|
| 441 | |
---|
| 442 | |
---|
| 443 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
---|
| 444 | <span class="attr">default:</span> <span class="value">0</span> |
---|
| 445 | |
---|
| 446 | </h4> |
---|
| 447 | |
---|
| 448 | <div class="comments"> |
---|
[321] | 449 | put 1 to apply add_offset and scale factor on data before looking for |
---|
[290] | 450 | missing values when using INUSEASMASK keyword |
---|
| 451 | </div> |
---|
| 452 | |
---|
[363] | 453 | <h4 id="_file_interp_keyword_INTESTOP">INTESTOP |
---|
| 454 | |
---|
| 455 | |
---|
| 456 | |
---|
| 457 | |
---|
| 458 | |
---|
| 459 | <span class="attr">type:</span> <span class="value">scalar string, for example 'GT 0.5'</span> |
---|
| 460 | <span class="attr">default:</span> <span class="value">'NE'</span> |
---|
| 461 | |
---|
| 462 | </h4> |
---|
| 463 | |
---|
| 464 | <div class="comments"> |
---|
| 465 | a string describing the type of test that will be done to define the |
---|
| 466 | input mask. The test is performed on the variable specified by INUSEASMASK |
---|
| 467 | keyword. |
---|
| 468 | INTESTOP can contain 1 or 2 words. The first word is the operator |
---|
| 469 | definition: "EQ" "NE" "GE" "GT" "LE" "LT" (default is NE). The |
---|
| 470 | second word define the testing value. If INTESTOP contains only 1 |
---|
| 471 | word, then the test value is denifed by |
---|
| 472 | 1) INMISSING_VALUE keyword |
---|
| 473 | 2) attribute missing_value or _fillvalue of the variable INUSEASMASK |
---|
| 474 | 3) !Values.f_nan (can be used only with NE and EQ operators) |
---|
| 475 | </div> |
---|
| 476 | |
---|
[290] | 477 | <h4 id="_file_interp_keyword_OUTMASKNAME">OUTMASKNAME |
---|
| 478 | |
---|
| 479 | |
---|
| 480 | |
---|
| 481 | |
---|
| 482 | |
---|
| 483 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 484 | <span class="attr">default:</span> <span class="value">not used</span> |
---|
| 485 | |
---|
| 486 | </h4> |
---|
| 487 | |
---|
| 488 | <div class="comments"> |
---|
| 489 | same as inmaskname but for output mask file maskout |
---|
| 490 | </div> |
---|
| 491 | |
---|
| 492 | <h4 id="_file_interp_keyword_OUTINVMASK">OUTINVMASK |
---|
| 493 | |
---|
| 494 | |
---|
| 495 | |
---|
| 496 | |
---|
| 497 | |
---|
| 498 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
---|
| 499 | <span class="attr">default:</span> <span class="value">0</span> |
---|
| 500 | |
---|
| 501 | </h4> |
---|
| 502 | |
---|
| 503 | <div class="comments"> |
---|
| 504 | same as ininvmask but for output mask file maskout |
---|
| 505 | </div> |
---|
| 506 | |
---|
| 507 | <h4 id="_file_interp_keyword_OUTUSEASMASK">OUTUSEASMASK |
---|
| 508 | |
---|
| 509 | |
---|
| 510 | |
---|
| 511 | |
---|
| 512 | |
---|
| 513 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 514 | |
---|
| 515 | |
---|
| 516 | </h4> |
---|
| 517 | |
---|
| 518 | <div class="comments"> |
---|
| 519 | same as inuseasmask but for output mask file maskout |
---|
| 520 | </div> |
---|
| 521 | |
---|
| 522 | <h4 id="_file_interp_keyword_OUTMISSING_VALUE">OUTMISSING_VALUE |
---|
| 523 | |
---|
| 524 | |
---|
| 525 | |
---|
| 526 | |
---|
| 527 | |
---|
| 528 | <span class="attr">type:</span> <span class="value">scalar</span> |
---|
| 529 | |
---|
| 530 | |
---|
| 531 | </h4> |
---|
| 532 | |
---|
| 533 | <div class="comments"> |
---|
| 534 | same as inmissing_value but for output mask file maskout |
---|
| 535 | </div> |
---|
| 536 | |
---|
| 537 | <h4 id="_file_interp_keyword_OUTADDSCL_BEFORE">OUTADDSCL_BEFORE |
---|
| 538 | |
---|
| 539 | |
---|
| 540 | |
---|
| 541 | |
---|
| 542 | |
---|
| 543 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
---|
| 544 | <span class="attr">default:</span> <span class="value">0</span> |
---|
| 545 | |
---|
| 546 | </h4> |
---|
| 547 | |
---|
| 548 | <div class="comments"> |
---|
| 549 | same as inaddscl_before but for output mask file maskout |
---|
| 550 | </div> |
---|
| 551 | |
---|
[363] | 552 | <h4 id="_file_interp_keyword_OUTTESTOP">OUTTESTOP |
---|
[290] | 553 | |
---|
| 554 | |
---|
| 555 | |
---|
| 556 | |
---|
| 557 | |
---|
[363] | 558 | <span class="attr">type:</span> <span class="value">scalar string, for example 'GT 0.5'</span> |
---|
| 559 | <span class="attr">default:</span> <span class="value">'NE'</span> |
---|
| 560 | |
---|
| 561 | </h4> |
---|
| 562 | |
---|
| 563 | <div class="comments"> |
---|
| 564 | same as INTESTOP but for output mask file maskout |
---|
| 565 | </div> |
---|
| 566 | |
---|
| 567 | <h4 id="_file_interp_keyword_MISSING_VALUE">MISSING_VALUE |
---|
| 568 | |
---|
| 569 | |
---|
| 570 | |
---|
| 571 | |
---|
| 572 | |
---|
[290] | 573 | <span class="attr">type:</span> <span class="value">scalar</span> |
---|
[363] | 574 | <span class="attr">default:</span> <span class="value">defined by attribute missing_value or _fillvalue</span> |
---|
[290] | 575 | |
---|
| 576 | </h4> |
---|
| 577 | |
---|
| 578 | <div class="comments"> |
---|
[363] | 579 | (Re)define the missing value in input data (missing values are treated |
---|
[290] | 580 | like masked values and will be filled with extrapolation before |
---|
[363] | 581 | interpolation). |
---|
| 582 | Note: do not mismatch with (IN/OUT)MISSING_VALUE which are missing value |
---|
| 583 | used (in association with (IN/OUT)USEASMASK) to built the mask (that |
---|
| 584 | does not change from one record to another). |
---|
| 585 | Note: this value will be apply to all interpolated variables |
---|
[290] | 586 | </div> |
---|
| 587 | |
---|
| 588 | <h4 id="_file_interp_keyword_WEIG">WEIG |
---|
| 589 | |
---|
| 590 | |
---|
| 591 | |
---|
| 592 | |
---|
| 593 | |
---|
| 594 | <span class="attr">type:</span> <span class="value">2d array or variable name</span> |
---|
| 595 | |
---|
| 596 | |
---|
| 597 | </h4> |
---|
| 598 | |
---|
| 599 | <div class="comments"> |
---|
| 600 | (see ADDR) |
---|
[321] | 601 | </div> |
---|
[290] | 602 | |
---|
| 603 | <h4 id="_file_interp_keyword_ADDR">ADDR |
---|
| 604 | |
---|
| 605 | |
---|
| 606 | |
---|
| 607 | |
---|
| 608 | |
---|
| 609 | <span class="attr">type:</span> <span class="value">2d array or variable name</span> |
---|
| 610 | |
---|
| 611 | |
---|
| 612 | </h4> |
---|
| 613 | |
---|
| 614 | <div class="comments"> |
---|
[321] | 615 | 1) at the first call of file_interp: |
---|
[290] | 616 | This keyword can be set to a named variable (undefined or equal to |
---|
| 617 | 0) into which the addresses used to perform the interpolation will |
---|
| 618 | be copied when the current routine exits. |
---|
| 619 | 2) Next, once this keyword is set to a defined 2d array, it is used |
---|
| 620 | to bypass the computation of the weights and addresses used to |
---|
| 621 | perform the interpolation. In this case, interpolation is much |
---|
[321] | 622 | faster |
---|
[290] | 623 | </div> |
---|
| 624 | |
---|
| 625 | <h4 id="_file_interp_keyword_INXAXISNAME">INXAXISNAME |
---|
| 626 | |
---|
| 627 | |
---|
| 628 | |
---|
| 629 | |
---|
| 630 | |
---|
| 631 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 632 | <span class="attr">default:</span> <span class="value">'x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'</span> |
---|
| 633 | |
---|
| 634 | </h4> |
---|
| 635 | |
---|
| 636 | <div class="comments"> |
---|
[321] | 637 | A string giving the name of the variable containing the x axis in |
---|
[290] | 638 | the input grid file gridin |
---|
| 639 | </div> |
---|
| 640 | |
---|
| 641 | <h4 id="_file_interp_keyword_INYAXISNAME">INYAXISNAME |
---|
| 642 | |
---|
| 643 | |
---|
| 644 | |
---|
| 645 | |
---|
| 646 | |
---|
| 647 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 648 | <span class="attr">default:</span> <span class="value">'y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'</span> |
---|
| 649 | |
---|
| 650 | </h4> |
---|
| 651 | |
---|
| 652 | <div class="comments"> |
---|
| 653 | same as inxaxisname but for the y axis in the input grid file gridin |
---|
| 654 | </div> |
---|
| 655 | |
---|
| 656 | <h4 id="_file_interp_keyword_OUTXAXISNAME">OUTXAXISNAME |
---|
| 657 | |
---|
| 658 | |
---|
| 659 | |
---|
| 660 | |
---|
| 661 | |
---|
| 662 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 663 | <span class="attr">default:</span> <span class="value">'x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'</span> |
---|
| 664 | |
---|
| 665 | </h4> |
---|
| 666 | |
---|
| 667 | <div class="comments"> |
---|
| 668 | same as inxaxisname but for output grid file gridout |
---|
| 669 | </div> |
---|
| 670 | |
---|
| 671 | <h4 id="_file_interp_keyword_OUTYAXISNAME">OUTYAXISNAME |
---|
| 672 | |
---|
| 673 | |
---|
| 674 | |
---|
| 675 | |
---|
| 676 | |
---|
| 677 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 678 | <span class="attr">default:</span> <span class="value">'y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'</span> |
---|
| 679 | |
---|
| 680 | </h4> |
---|
| 681 | |
---|
| 682 | <div class="comments"> |
---|
| 683 | same as inyaxisname but for output grid file gridout |
---|
| 684 | </div> |
---|
| 685 | |
---|
| 686 | <h4 id="_file_interp_keyword__EXTRA">_EXTRA |
---|
| 687 | |
---|
| 688 | |
---|
| 689 | |
---|
| 690 | |
---|
| 691 | |
---|
| 692 | |
---|
| 693 | |
---|
| 694 | |
---|
| 695 | </h4> |
---|
| 696 | |
---|
| 697 | <div class="comments"> |
---|
| 698 | to use <a href="..//Interpolation/extrapolate.html">extrapolate</a>, <a href="..//Interpolation/extrapsmooth.html">extrapsmooth</a> and <a href="..//Interpolation/fromreg.html">fromreg</a> keywords |
---|
| 699 | </div> |
---|
| 700 | |
---|
| 701 | |
---|
| 702 | |
---|
| 703 | <h3>Examples</h3><div class="preformat"> |
---|
| 704 | |
---|
[402] | 705 | IDL> file_interp, filein, fileout, gridout, inxaxisname = 'lo', inyaxisname = 'la', keep = ['lo', 'la', 'cond_sed'] |
---|
| 706 | IDL> file_interp, in, out, gdout, inuseasmask = 'sst', inmissing_value = -1.00000e+30, missing_value = -1000.00 |
---|
[290] | 707 | </div> |
---|
| 708 | <h3>Version history</h3> |
---|
| 709 | |
---|
| 710 | <h4>Version</h4><div class="preformat"> |
---|
[402] | 711 | $Id: file_interp.pro 383 2008-10-30 13:55:33Z smasson $ |
---|
[290] | 712 | </div> |
---|
| 713 | <h4>History</h4><div class="preformat"> |
---|
| 714 | September 2007: Sebastien Masson (smasson@locean-ipsl.upmc.fr) |
---|
| 715 | </div> |
---|
| 716 | |
---|
| 717 | |
---|
| 718 | <h3>Known issues</h3> |
---|
| 719 | |
---|
| 720 | |
---|
| 721 | |
---|
| 722 | <h4>Restrictions</h4><div class="preformat"> |
---|
| 723 | |
---|
| 724 | - perform only horizontal interpolations on scalar fields |
---|
[363] | 725 | - all masked and missing values are filled before interpolation |
---|
| 726 | -> output data are not masked and have values everywhere. |
---|
[290] | 727 | - attributes (like valid_min...) are not updated |
---|
| 728 | - see restrictions of <a href="..//Interpolation/fromreg.html">fromreg</a> and <a href="..//Interpolation/fromirr.html">fromirr</a> |
---|
[363] | 729 | - output mask is not used but, if the input file contains the mask |
---|
| 730 | in a variable (defined by inmaskname), this variable will contain |
---|
| 731 | the output mask in the ouput file |
---|
[290] | 732 | </div> |
---|
| 733 | |
---|
| 734 | <h3>Other attributes</h3> |
---|
| 735 | |
---|
| 736 | |
---|
| 737 | <h4>Uses routines</h4><div class="preformat"> |
---|
| 738 | <a href="..//Interpolation/extrapsmooth.html">extrapsmooth</a>, <a href="..//Interpolation/extrapolate.html">extrapolate</a>, <a href="..//Interpolation/fromreg.html">fromreg</a> and <a href="..//Interpolation/fromirr.html">fromirr</a> |
---|
| 739 | </div> |
---|
| 740 | |
---|
| 741 | |
---|
| 742 | |
---|
| 743 | |
---|
| 744 | <h3>Statistics</h3> |
---|
| 745 | <table class="statistics"> |
---|
[402] | 746 | <tr><td>McCabe cyclic</td><td> 72</td></tr> |
---|
[290] | 747 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
| 748 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
| 749 | </table> |
---|
| 750 | |
---|
| 751 | |
---|
| 752 | </div> |
---|
| 753 | |
---|
| 754 | </div> |
---|
| 755 | |
---|
| 756 | |
---|
| 757 | |
---|
| 758 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 759 | |
---|
| 760 | </div> |
---|
| 761 | |
---|
| 762 | </body> |
---|
| 763 | </html> |
---|