| 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>read_ncdf.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="read_ncdf.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="../../../../ToBeReviewed/LECTURE//read_ncdf.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="read_ftp.html"><<prev file</a> | <a href="read_ncdf_varget.html">next file >></a> <a href="read_ncdf.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">ToBeReviewed/LECTURE/</a></h1> |
|---|
| 82 | <h2 class="pro_file">read_ncdf.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"> |
|---|
| 90 | Reading function for the file net_cdf. |
|---|
| 91 | This program is less universal than ncdf_lec (it appeal to declared |
|---|
| 92 | variables in common.pro) but it is very easier to be used. It considerate |
|---|
| 93 | the declaration of the different zooms which have been defined |
|---|
| 94 | (ixminmesh...premierx...), the declaration of the variable key_shift... |
|---|
| 95 | To put it in a nutshell, the result of read_ncdf can be directly used in plt... |
|---|
| 96 | This is also this program which is used by default in our reading widgets. |
|---|
| 97 | </div> |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | |
|---|
| 106 | |
|---|
| 107 | <div id="routine_details"> |
|---|
| 108 | |
|---|
| 109 | |
|---|
| 110 | <div class="routine_details" id="_read_ncdf"> |
|---|
| 111 | |
|---|
| 112 | <h2><a class="top" href="#container">top</a>read_ncdf <span class="categories"> |
|---|
| 113 | Reading |
|---|
| 114 | </span></h2> |
|---|
| 115 | |
|---|
| 116 | <p class="header"> |
|---|
| 117 | <span class="result">result = </span>read_ncdf(<span class="result"><a href="#_read_ncdf_param_name">name</a>, <a href="#_read_ncdf_param_beginning">beginning</a>, <a href="#_read_ncdf_param_ending">ending</a>[, <a href="#_read_ncdf_param_compatibility">compatibility</a>]</span>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<span class="result">PARENTIN</span>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_TIMEVAR">TIMEVAR</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_read_ncdf_keyword_CALLITSELF">CALLITSELF</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_ZETAZERO">ZETAZERO</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> |
|---|
| 118 | |
|---|
| 119 | <div class="comments"></div> |
|---|
| 120 | |
|---|
| 121 | <h3>Return value</h3><div class="preformat"> |
|---|
| 122 | Structure readable by litchamp.pro or an array if NOSTRUCT is activated. |
|---|
| 123 | </div> |
|---|
| 124 | |
|---|
| 125 | |
|---|
| 126 | <h3>Parameters</h3> |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | <h4 id="_read_ncdf_param_name">name |
|---|
| 130 | <span class="attr">in</span> |
|---|
| 131 | |
|---|
| 132 | |
|---|
| 133 | <span class="attr">required</span> |
|---|
| 134 | |
|---|
| 135 | <span class="attr">type:</span> <span class="value">string</span> |
|---|
| 136 | |
|---|
| 137 | |
|---|
| 138 | </h4> |
|---|
| 139 | |
|---|
| 140 | <div class="comments"> |
|---|
| 141 | It define the field to be read. |
|---|
| 142 | </div> |
|---|
| 143 | |
|---|
| 144 | <h4 id="_read_ncdf_param_beginning">beginning |
|---|
| 145 | <span class="attr">in</span> |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | <span class="attr">required</span> |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | </h4> |
|---|
| 154 | |
|---|
| 155 | <div class="comments"> |
|---|
| 156 | Relative with the time axis. |
|---|
| 157 | These can be |
|---|
| 158 | - 2 date of the type yyyymmdd and in this case, we select dates |
|---|
| 159 | which are included between these two dates. |
|---|
| 160 | - 2 indexes which define between which and which time step we have |
|---|
| 161 | to extract the temporal dimension. |
|---|
| 162 | </div> |
|---|
| 163 | |
|---|
| 164 | <h4 id="_read_ncdf_param_ending">ending |
|---|
| 165 | <span class="attr">in</span> |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | <span class="attr">required</span> |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | </h4> |
|---|
| 174 | |
|---|
| 175 | <div class="comments"> |
|---|
| 176 | Relative with the time axis. |
|---|
| 177 | See BEGINNING. |
|---|
| 178 | </div> |
|---|
| 179 | |
|---|
| 180 | <h4 id="_read_ncdf_param_compatibility">compatibility |
|---|
| 181 | <span class="attr">in</span> |
|---|
| 182 | |
|---|
| 183 | <span class="attr">optional</span> |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | </h4> |
|---|
| 190 | |
|---|
| 191 | <div class="comments"> |
|---|
| 192 | Useless, defined for compatibility |
|---|
| 193 | </div> |
|---|
| 194 | |
|---|
| 195 | |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | <h3>Keywords</h3> |
|---|
| 201 | |
|---|
| 202 | <h4 id="_read_ncdf_keyword_BOXZOOM">BOXZOOM |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | </h4> |
|---|
| 212 | |
|---|
| 213 | <div class="comments"> |
|---|
| 214 | Contain the boxzoom on which we have to do the reading |
|---|
| 215 | </div> |
|---|
| 216 | |
|---|
| 217 | <h4 id="_read_ncdf_keyword_FILENAME">FILENAME |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | <span class="attr">required</span> |
|---|
| 222 | |
|---|
| 223 | <span class="attr">type:</span> <span class="value">string</span> |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | </h4> |
|---|
| 227 | |
|---|
| 228 | <div class="comments"> |
|---|
| 229 | It contains he file's name. |
|---|
| 230 | </div> |
|---|
| 231 | |
|---|
| 232 | <h4 id="_read_ncdf_keyword_PARENTIN">PARENTIN |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | |
|---|
| 241 | </h4> |
|---|
| 242 | |
|---|
| 243 | <div class="comments"></div> |
|---|
| 244 | |
|---|
| 245 | <h4 id="_read_ncdf_keyword_TIMESTEP">TIMESTEP |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
|---|
| 252 | <span class="attr">default:</span> <span class="value">0</span> |
|---|
| 253 | |
|---|
| 254 | </h4> |
|---|
| 255 | |
|---|
| 256 | <div class="comments"> |
|---|
| 257 | Specify that BEGINNING and ENDING refer to indexes of the time axis and not to dates |
|---|
| 258 | </div> |
|---|
| 259 | |
|---|
| 260 | <h4 id="_read_ncdf_keyword_TIMEVAR">TIMEVAR |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | |
|---|
| 266 | <span class="attr">type:</span> <span class="value">string</span> |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | </h4> |
|---|
| 270 | |
|---|
| 271 | <div class="comments"> |
|---|
| 272 | It define the name of the variable that |
|---|
| 273 | contains the time axis. This keyword can be useful if there |
|---|
| 274 | is no unlimited dimension or if the time axis selected by default |
|---|
| 275 | (the first 1D array with unlimited dimension) is not the good one. |
|---|
| 276 | </div> |
|---|
| 277 | |
|---|
| 278 | <h4 id="_read_ncdf_keyword_TOUT">TOUT |
|---|
| 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 | We activate it if we want to read the file on the whole domain without |
|---|
| 291 | considerate the sub-domain defined by the boxzoom or |
|---|
| 292 | lon1,lon2,lat1,lat2,vert1,vert2. |
|---|
| 293 | </div> |
|---|
| 294 | |
|---|
| 295 | <h4 id="_read_ncdf_keyword_NOSTRUCT">NOSTRUCT |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
|---|
| 302 | <span class="attr">default:</span> <span class="value">0</span> |
|---|
| 303 | |
|---|
| 304 | </h4> |
|---|
| 305 | |
|---|
| 306 | <div class="comments"> |
|---|
| 307 | We activate it if we do not want that read_ncdf send back a structure |
|---|
| 308 | but only the array referring to the field. |
|---|
| 309 | </div> |
|---|
| 310 | |
|---|
| 311 | <h4 id="_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL |
|---|
| 312 | |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | |
|---|
| 317 | |
|---|
| 318 | |
|---|
| 319 | |
|---|
| 320 | </h4> |
|---|
| 321 | |
|---|
| 322 | <div class="comments"></div> |
|---|
| 323 | |
|---|
| 324 | <h4 id="_read_ncdf_keyword_INIT">INIT |
|---|
| 325 | |
|---|
| 326 | |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | |
|---|
| 330 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
|---|
| 331 | <span class="attr">default:</span> <span class="value">0</span> |
|---|
| 332 | |
|---|
| 333 | </h4> |
|---|
| 334 | |
|---|
| 335 | <div class="comments"> |
|---|
| 336 | To call automatically initncdf, filename and thus |
|---|
| 337 | redefine all the grid parameters |
|---|
| 338 | </div> |
|---|
| 339 | |
|---|
| 340 | <h4 id="_read_ncdf_keyword_GRID">GRID |
|---|
| 341 | |
|---|
| 342 | |
|---|
| 343 | |
|---|
| 344 | |
|---|
| 345 | |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | |
|---|
| 349 | </h4> |
|---|
| 350 | |
|---|
| 351 | <div class="comments"> |
|---|
| 352 | ='[UTVWF]' to specify the type of grid. Default is (1) |
|---|
| 353 | based on the name of the file if the file ends by |
|---|
| 354 | GRID[._][TUVFW].NC (not case sensible) or (2) T if case (1) |
|---|
| 355 | is not found. |
|---|
| 356 | </div> |
|---|
| 357 | |
|---|
| 358 | <h4 id="_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE |
|---|
| 359 | |
|---|
| 360 | |
|---|
| 361 | |
|---|
| 362 | |
|---|
| 363 | |
|---|
| 364 | |
|---|
| 365 | |
|---|
| 366 | |
|---|
| 367 | </h4> |
|---|
| 368 | |
|---|
| 369 | <div class="comments"></div> |
|---|
| 370 | |
|---|
| 371 | <h4 id="_read_ncdf_keyword_CALLITSELF">CALLITSELF |
|---|
| 372 | |
|---|
| 373 | |
|---|
| 374 | |
|---|
| 375 | |
|---|
| 376 | |
|---|
| 377 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
|---|
| 378 | <span class="attr">default:</span> <span class="value">0</span> |
|---|
| 379 | |
|---|
| 380 | </h4> |
|---|
| 381 | |
|---|
| 382 | <div class="comments"> |
|---|
| 383 | For ROMS outputs. Use by read_ncdf itself to access auxilliary data (h and zeta). |
|---|
| 384 | </div> |
|---|
| 385 | |
|---|
| 386 | <h4 id="_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME |
|---|
| 387 | |
|---|
| 388 | |
|---|
| 389 | |
|---|
| 390 | |
|---|
| 391 | |
|---|
| 392 | <span class="attr">type:</span> <span class="value">string</span> |
|---|
| 393 | <span class="attr">default:</span> <span class="value">FILENAME</span> |
|---|
| 394 | |
|---|
| 395 | </h4> |
|---|
| 396 | |
|---|
| 397 | <div class="comments"> |
|---|
| 398 | For ROMS outputs. The filename of the file where zeta vriable should be read |
|---|
| 399 | </div> |
|---|
| 400 | |
|---|
| 401 | <h4 id="_read_ncdf_keyword_ZETAZERO">ZETAZERO |
|---|
| 402 | |
|---|
| 403 | |
|---|
| 404 | |
|---|
| 405 | |
|---|
| 406 | |
|---|
| 407 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
|---|
| 408 | <span class="attr">default:</span> <span class="value">0</span> |
|---|
| 409 | |
|---|
| 410 | </h4> |
|---|
| 411 | |
|---|
| 412 | <div class="comments"> |
|---|
| 413 | For ROMS outputs. To define zeta to 0. instead of reading it |
|---|
| 414 | </div> |
|---|
| 415 | |
|---|
| 416 | <h4 id="_read_ncdf_keyword__EXTRA">_EXTRA |
|---|
| 417 | |
|---|
| 418 | |
|---|
| 419 | |
|---|
| 420 | |
|---|
| 421 | |
|---|
| 422 | |
|---|
| 423 | |
|---|
| 424 | |
|---|
| 425 | </h4> |
|---|
| 426 | |
|---|
| 427 | <div class="comments"> |
|---|
| 428 | Used to pass your keywords |
|---|
| 429 | </div> |
|---|
| 430 | |
|---|
| 431 | |
|---|
| 432 | |
|---|
| 433 | |
|---|
| 434 | <h3>Version history</h3> |
|---|
| 435 | |
|---|
| 436 | <h4>Version</h4><div class="preformat"> |
|---|
| 437 | $Id: read_ncdf.pro 199 2006-12-13 07:47:14Z smasson $ </div> |
|---|
| 438 | <h4>History</h4><div class="preformat"> |
|---|
| 439 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 440 | 15/10/1999 |
|---|
| 441 | </div> |
|---|
| 442 | |
|---|
| 443 | |
|---|
| 444 | <h3>Known issues</h3> |
|---|
| 445 | |
|---|
| 446 | |
|---|
| 447 | |
|---|
| 448 | <h4>Restrictions</h4><div class="preformat"> |
|---|
| 449 | The field must have a temporal dimension. |
|---|
| 450 | </div> |
|---|
| 451 | |
|---|
| 452 | <h3>Other attributes</h3> |
|---|
| 453 | |
|---|
| 454 | |
|---|
| 455 | <h4>Uses routines</h4><div class="preformat"> |
|---|
| 456 | common.pro |
|---|
| 457 | </div> |
|---|
| 458 | |
|---|
| 459 | |
|---|
| 460 | |
|---|
| 461 | |
|---|
| 462 | <h3>Statistics</h3> |
|---|
| 463 | <table class="statistics"> |
|---|
| 464 | <tr><td>McCabe cyclic</td><td> 141</td></tr> |
|---|
| 465 | <tr><td>McCabe essential</td><td> 1</td></tr> |
|---|
| 466 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
|---|
| 467 | </table> |
|---|
| 468 | |
|---|
| 469 | |
|---|
| 470 | </div> |
|---|
| 471 | |
|---|
| 472 | </div> |
|---|
| 473 | |
|---|
| 474 | |
|---|
| 475 | |
|---|
| 476 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 477 | |
|---|
| 478 | </div> |
|---|
| 479 | |
|---|
| 480 | </body> |
|---|
| 481 | </html> |
|---|
