| 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_hope.pro (IDLdoc API 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_hope.pro (IDLdoc API documentation)"; |
|---|
| 19 | } |
|---|
| 20 | </script> |
|---|
| 21 | </head> |
|---|
| 22 | |
|---|
| 23 | <body onload="setTitle();"> |
|---|
| 24 | |
|---|
| 25 | <div id="navbar_title"> |
|---|
| 26 | <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td> |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | <td >Directory</td> |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
|---|
| 48 | |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td> |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | <td id="selected">File</td> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <td >Source</td> |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | |
|---|
| 61 | <td><a href="./../../idldoc-help.html?format=raw" 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="findlineandpointtype.html"><<prev file</a> | <a href="rh_alldomains.html">next file >></a> <a href="read_hope.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a> summary: fields | <a href="#routine_summary">routine</a> 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?format=raw">ToBeReviewed/HOPE/</a></h1> |
|---|
| 82 | <h2 class="pro_file">read_hope.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"></div> |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | <div id="routine_summary"> |
|---|
| 99 | <h2>Routine summary</h2> |
|---|
| 100 | |
|---|
| 101 | <dl> |
|---|
| 102 | |
|---|
| 103 | <dt><p><a href="#_read_hope_event">read_hope_event<span class="result">, event</span></a></p><dt> |
|---|
| 104 | <dd> NAME: read_hope PURPOSE: read the Hope grid file converted in NetCdf by xconv CATEGORY: reading CALLING SEQUENCE: a=read_hope([typein, varnamein]) INPUTS: typein: a string specifing from which type of section the 4D array based: 'xy, 'xz', 'yz' varnamein: a string the name of the cariable to be read (in lower or upper case) KEYWORD PARAMETERS: FILENAME = the name of the file to be read XLIMITS = a two elements vertor [lonmin, lonmax]] the bondary of the longitudes (from 0 to 360) YLIMITS = a two elements vertor [latmin, latmax]] the bondary of the latitudes (from -90 to 90) ZLIMITS = a two elements vertor [depthmin, depthmax]] the bondary of the depth TLIMITS = a two elements vertor [date1, date2]] the bondary of the calendar with date1 and date2 folowing the syntaxe yyyymmdd /ODDPT: activate to read only the sections located on ODD points /EVENPT: activate to read only the sections located on even points /ODDEVENPT: activate to read only the sections located on both even and odd points (horizontal sections) OUTPUTS: -1 if typein and varnamein are undefine (this is the widget version) a structure which but be read by litchamp.</dd> |
|---|
| 105 | |
|---|
| 106 | <dt><p><a href="#_read_hope"><span class="result">result = </span>read_hope(<span class="result">typein, varnamein</span>, FILENAME=<span class="result">FILENAME</span>, XLIMITS=<span class="result">XLIMITS</span>, YLIMITS=<span class="result">YLIMITS</span>, ZLIMITS=<span class="result">ZLIMITS</span>, TLIMITS=<span class="result">TLIMITS</span>, ODDPT=<span class="result">ODDPT</span>, ODDEVENPT=<span class="result">ODDEVENPT</span>, EVENPT=<span class="result">EVENPT</span>, _extra=<span class="result">_extra</span>)</a></p><dt> |
|---|
| 107 | <dd></dd> |
|---|
| 108 | |
|---|
| 109 | </dl> |
|---|
| 110 | </div> |
|---|
| 111 | |
|---|
| 112 | |
|---|
| 113 | <div id="routine_details"> |
|---|
| 114 | |
|---|
| 115 | |
|---|
| 116 | <div class="routine_details" id="_read_hope_event"> |
|---|
| 117 | |
|---|
| 118 | <h2><a class="top" href="#container">top</a>read_hope_event </h2> |
|---|
| 119 | |
|---|
| 120 | <p class="header"> |
|---|
| 121 | read_hope_event<span class="result">, <a href="#_read_hope_event_param_event">event</a></span></p> |
|---|
| 122 | |
|---|
| 123 | <div class="comments"> |
|---|
| 124 | NAME: read_hope |
|---|
| 125 | |
|---|
| 126 | PURPOSE: read the Hope grid file converted in NetCdf by xconv |
|---|
| 127 | |
|---|
| 128 | CATEGORY: reading |
|---|
| 129 | |
|---|
| 130 | CALLING SEQUENCE: a=read_hope([typein, varnamein]) |
|---|
| 131 | |
|---|
| 132 | INPUTS: |
|---|
| 133 | typein: a string specifing from which type of section the 4D |
|---|
| 134 | array based: 'xy, 'xz', 'yz' |
|---|
| 135 | |
|---|
| 136 | varnamein: a string the name of the cariable to be read (in |
|---|
| 137 | lower or upper case) |
|---|
| 138 | |
|---|
| 139 | KEYWORD PARAMETERS: |
|---|
| 140 | |
|---|
| 141 | FILENAME = the name of the file to be read |
|---|
| 142 | |
|---|
| 143 | XLIMITS = a two elements vertor [lonmin, lonmax]] |
|---|
| 144 | the bondary of the longitudes (from 0 to 360) |
|---|
| 145 | |
|---|
| 146 | YLIMITS = a two elements vertor [latmin, latmax]] |
|---|
| 147 | the bondary of the latitudes (from -90 to 90) |
|---|
| 148 | |
|---|
| 149 | ZLIMITS = a two elements vertor [depthmin, depthmax]] |
|---|
| 150 | the bondary of the depth |
|---|
| 151 | |
|---|
| 152 | TLIMITS = a two elements vertor [date1, date2]] |
|---|
| 153 | the bondary of the calendar with date1 and date2 |
|---|
| 154 | folowing the syntaxe yyyymmdd |
|---|
| 155 | |
|---|
| 156 | /ODDPT: activate to read only the sections located on ODD |
|---|
| 157 | points |
|---|
| 158 | |
|---|
| 159 | /EVENPT: activate to read only the sections located on even |
|---|
| 160 | points |
|---|
| 161 | |
|---|
| 162 | /ODDEVENPT: activate to read only the sections located on |
|---|
| 163 | both even and odd points (horizontal sections) |
|---|
| 164 | |
|---|
| 165 | OUTPUTS: |
|---|
| 166 | |
|---|
| 167 | -1 if typein and varnamein are undefine (this is the widget |
|---|
| 168 | version) |
|---|
| 169 | |
|---|
| 170 | a structure which but be read by litchamp.pro and is |
|---|
| 171 | necessary to complute the grid associated to the data (see |
|---|
| 172 | the example). |
|---|
| 173 | |
|---|
| 174 | COMMON BLOCKS: common.pro (usefull only for the definition of iodir) |
|---|
| 175 | |
|---|
| 176 | SIDE EFFECTS: |
|---|
| 177 | 'x', 'y', 'z', 't', 'xt', 'yt' and 'zt' section not coded, xconv |
|---|
| 178 | must be able to works with this kind of fonction. |
|---|
| 179 | The grib file has no zoom possibilities on horizontal |
|---|
| 180 | dimensions. |
|---|
| 181 | |
|---|
| 182 | RESTRICTIONS: |
|---|
| 183 | |
|---|
| 184 | When typein and varnamein are defined, the methode to find the |
|---|
| 185 | godd variable is: |
|---|
| 186 | 1) find the variables which are available on this type of |
|---|
| 187 | sections woth this name |
|---|
| 188 | 2) if ODDPT, EVENPT or ODDEVENPT are specified, consider only |
|---|
| 189 | these types of sections |
|---|
| 190 | 3) for an XY section the chosen variable is the one which has |
|---|
| 191 | the most level in the vertical domain specified by ZLIMITS. |
|---|
| 192 | for an XZ section the chosen variable is the one which has |
|---|
| 193 | the most points in the latitude domain specified by YLIMITS. |
|---|
| 194 | for an YZ section the chosen variable is the one which has |
|---|
| 195 | the most points in the longitude domain specified by XLIMITS. |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | EXAMPLE: |
|---|
| 199 | |
|---|
| 200 | IDL> a=read_hope('xy','ocpt',filename='CLIM_CNT_1993-1998.nc') |
|---|
| 201 | IDL> help, a,/struct |
|---|
| 202 | ** Structure <82ec344>, 6 tags, length=1860176, refs=1: |
|---|
| 203 | ARRAY FLOAT Array[128, 242, 15] |
|---|
| 204 | UNIT STRING 'deg C' |
|---|
| 205 | NAME STRING 'Ocean potential temperature' |
|---|
| 206 | DATE FLOAT Array[1] |
|---|
| 207 | GRID STRING 'T' |
|---|
| 208 | HOPEGRID STRUCT -> <Anonymous> Array[1] |
|---|
| 209 | IDL> help, a.hopegrid,/struct |
|---|
| 210 | ** Structure <82eb9cc>, 8 tags, length=1588, refs=2: |
|---|
| 211 | XAXIS FLOAT Array[128] |
|---|
| 212 | YAXIS FLOAT Array[242] |
|---|
| 213 | ZAXIS FLOAT Array[15] |
|---|
| 214 | FIRSTS LONG Array[3] |
|---|
| 215 | LASTS LONG Array[3] |
|---|
| 216 | TYPE STRING 'xy' |
|---|
| 217 | LINETYPE STRING 'odd-even' |
|---|
| 218 | PTTYPE STRING 'T' |
|---|
| 219 | IDL> help, litchamp(a) |
|---|
| 220 | <Expression> FLOAT = Array[128, 242, 15] |
|---|
| 221 | </div> |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | <h3>Parameters</h3> |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | <h4 id="_read_hope_event_param_event">event |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | </h4> |
|---|
| 239 | |
|---|
| 240 | <div class="comments"></div> |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | |
|---|
| 252 | |
|---|
| 253 | |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | |
|---|
| 266 | |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | </div> |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | <div class="routine_details" id="_read_hope"> |
|---|
| 274 | |
|---|
| 275 | <h2><a class="top" href="#container">top</a>read_hope </h2> |
|---|
| 276 | |
|---|
| 277 | <p class="header"> |
|---|
| 278 | <span class="result">result = </span>read_hope(<span class="result"><a href="#_read_hope_param_typein">typein</a>, <a href="#_read_hope_param_varnamein">varnamein</a></span>, <a href="#_read_hope_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_hope_keyword_XLIMITS">XLIMITS</a>=<span class="result">XLIMITS</span>, <a href="#_read_hope_keyword_YLIMITS">YLIMITS</a>=<span class="result">YLIMITS</span>, <a href="#_read_hope_keyword_ZLIMITS">ZLIMITS</a>=<span class="result">ZLIMITS</span>, <a href="#_read_hope_keyword_TLIMITS">TLIMITS</a>=<span class="result">TLIMITS</span>, <a href="#_read_hope_keyword_ODDPT">ODDPT</a>=<span class="result">ODDPT</span>, <a href="#_read_hope_keyword_ODDEVENPT">ODDEVENPT</a>=<span class="result">ODDEVENPT</span>, <a href="#_read_hope_keyword_EVENPT">EVENPT</a>=<span class="result">EVENPT</span>, <a href="#_read_hope_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> |
|---|
| 279 | |
|---|
| 280 | <div class="comments"></div> |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | <h3>Parameters</h3> |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | <h4 id="_read_hope_param_typein">typein |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | </h4> |
|---|
| 298 | |
|---|
| 299 | <div class="comments"></div> |
|---|
| 300 | |
|---|
| 301 | <h4 id="_read_hope_param_varnamein">varnamein |
|---|
| 302 | |
|---|
| 303 | |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | |
|---|
| 310 | </h4> |
|---|
| 311 | |
|---|
| 312 | <div class="comments"></div> |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | |
|---|
| 317 | |
|---|
| 318 | |
|---|
| 319 | <h3>Keywords</h3> |
|---|
| 320 | |
|---|
| 321 | <h4 id="_read_hope_keyword_FILENAME">FILENAME |
|---|
| 322 | |
|---|
| 323 | |
|---|
| 324 | |
|---|
| 325 | |
|---|
| 326 | |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | |
|---|
| 330 | </h4> |
|---|
| 331 | |
|---|
| 332 | <div class="comments"></div> |
|---|
| 333 | |
|---|
| 334 | <h4 id="_read_hope_keyword_XLIMITS">XLIMITS |
|---|
| 335 | |
|---|
| 336 | |
|---|
| 337 | |
|---|
| 338 | |
|---|
| 339 | |
|---|
| 340 | |
|---|
| 341 | |
|---|
| 342 | |
|---|
| 343 | </h4> |
|---|
| 344 | |
|---|
| 345 | <div class="comments"></div> |
|---|
| 346 | |
|---|
| 347 | <h4 id="_read_hope_keyword_YLIMITS">YLIMITS |
|---|
| 348 | |
|---|
| 349 | |
|---|
| 350 | |
|---|
| 351 | |
|---|
| 352 | |
|---|
| 353 | |
|---|
| 354 | |
|---|
| 355 | |
|---|
| 356 | </h4> |
|---|
| 357 | |
|---|
| 358 | <div class="comments"></div> |
|---|
| 359 | |
|---|
| 360 | <h4 id="_read_hope_keyword_ZLIMITS">ZLIMITS |
|---|
| 361 | |
|---|
| 362 | |
|---|
| 363 | |
|---|
| 364 | |
|---|
| 365 | |
|---|
| 366 | |
|---|
| 367 | |
|---|
| 368 | |
|---|
| 369 | </h4> |
|---|
| 370 | |
|---|
| 371 | <div class="comments"></div> |
|---|
| 372 | |
|---|
| 373 | <h4 id="_read_hope_keyword_TLIMITS">TLIMITS |
|---|
| 374 | |
|---|
| 375 | |
|---|
| 376 | |
|---|
| 377 | |
|---|
| 378 | |
|---|
| 379 | |
|---|
| 380 | |
|---|
| 381 | |
|---|
| 382 | </h4> |
|---|
| 383 | |
|---|
| 384 | <div class="comments"></div> |
|---|
| 385 | |
|---|
| 386 | <h4 id="_read_hope_keyword_ODDPT">ODDPT |
|---|
| 387 | |
|---|
| 388 | |
|---|
| 389 | |
|---|
| 390 | |
|---|
| 391 | |
|---|
| 392 | |
|---|
| 393 | |
|---|
| 394 | |
|---|
| 395 | </h4> |
|---|
| 396 | |
|---|
| 397 | <div class="comments"></div> |
|---|
| 398 | |
|---|
| 399 | <h4 id="_read_hope_keyword_ODDEVENPT">ODDEVENPT |
|---|
| 400 | |
|---|
| 401 | |
|---|
| 402 | |
|---|
| 403 | |
|---|
| 404 | |
|---|
| 405 | |
|---|
| 406 | |
|---|
| 407 | |
|---|
| 408 | </h4> |
|---|
| 409 | |
|---|
| 410 | <div class="comments"></div> |
|---|
| 411 | |
|---|
| 412 | <h4 id="_read_hope_keyword_EVENPT">EVENPT |
|---|
| 413 | |
|---|
| 414 | |
|---|
| 415 | |
|---|
| 416 | |
|---|
| 417 | |
|---|
| 418 | |
|---|
| 419 | |
|---|
| 420 | |
|---|
| 421 | </h4> |
|---|
| 422 | |
|---|
| 423 | <div class="comments"></div> |
|---|
| 424 | |
|---|
| 425 | <h4 id="_read_hope_keyword__extra">_extra |
|---|
| 426 | |
|---|
| 427 | |
|---|
| 428 | |
|---|
| 429 | |
|---|
| 430 | |
|---|
| 431 | |
|---|
| 432 | |
|---|
| 433 | |
|---|
| 434 | </h4> |
|---|
| 435 | |
|---|
| 436 | <div class="comments"></div> |
|---|
| 437 | |
|---|
| 438 | |
|---|
| 439 | |
|---|
| 440 | |
|---|
| 441 | |
|---|
| 442 | |
|---|
| 443 | |
|---|
| 444 | |
|---|
| 445 | |
|---|
| 446 | |
|---|
| 447 | |
|---|
| 448 | |
|---|
| 449 | |
|---|
| 450 | |
|---|
| 451 | |
|---|
| 452 | |
|---|
| 453 | |
|---|
| 454 | |
|---|
| 455 | |
|---|
| 456 | |
|---|
| 457 | |
|---|
| 458 | |
|---|
| 459 | |
|---|
| 460 | |
|---|
| 461 | |
|---|
| 462 | |
|---|
| 463 | </div> |
|---|
| 464 | |
|---|
| 465 | </div> |
|---|
| 466 | |
|---|
| 467 | |
|---|
| 468 | |
|---|
| 469 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 470 | |
|---|
| 471 | </div> |
|---|
| 472 | |
|---|
| 473 | </body> |
|---|
| 474 | </html> |
|---|
