| 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>xncdf_lec.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="xncdf_lec.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="read_ncdf_varget.html"><<prev file</a> | next file >> <a href="xncdf_lec.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/LECTURE/</a></h1> |
|---|
| 82 | <h2 class="pro_file">xncdf_lec.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="#_wid_var_event">wid_var_event<span class="result">, event</span></a></p><dt> |
|---|
| 104 | <dd></dd> |
|---|
| 105 | |
|---|
| 106 | <dt><p><a href="#_wid_var">wid_var<span class="result">, widid_pere</span></a></p><dt> |
|---|
| 107 | <dd></dd> |
|---|
| 108 | |
|---|
| 109 | <dt><p><a href="#_xncdf_lec_event">xncdf_lec_event<span class="result">, event</span></a></p><dt> |
|---|
| 110 | <dd></dd> |
|---|
| 111 | |
|---|
| 112 | <dt><p><a href="#_xncdf_lec"><span class="result">result = </span>xncdf_lec(<span class="result">nom</span>, ATT=<span class="result">ATT</span>, COUNT=<span class="result">COUNT</span>, GROUP=<span class="result">GROUP</span>, OFFSET=<span class="result">OFFSET</span>, IODIR=<span class="result">IODIR</span>, SHIFT=<span class="result">SHIFT</span>, STRIDE=<span class="result">STRIDE</span>, VAR=<span class="result">VAR</span>)</a></p><dt> |
|---|
| 113 | <dd> NAME: xncdf_lec PURPOSE: lecture d''un fichier Net Cdf avec des widgets ! CATEGORY: lecture de fichiers avec widgets CALLING SEQUENCE: res=xncdf_lec([nom_fichier]) INPUTS: OPTIONNEL, nom_fichier: c''est un string qui donne le nom du fichier a ouvrir.</dd> |
|---|
| 114 | |
|---|
| 115 | </dl> |
|---|
| 116 | </div> |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | <div id="routine_details"> |
|---|
| 120 | |
|---|
| 121 | |
|---|
| 122 | <div class="routine_details" id="_wid_var_event"> |
|---|
| 123 | |
|---|
| 124 | <h2><a class="top" href="#container">top</a>wid_var_event </h2> |
|---|
| 125 | |
|---|
| 126 | <p class="header"> |
|---|
| 127 | wid_var_event<span class="result">, <a href="#_wid_var_event_param_event">event</a></span></p> |
|---|
| 128 | |
|---|
| 129 | <div class="comments"></div> |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | |
|---|
| 133 | |
|---|
| 134 | <h3>Parameters</h3> |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | <h4 id="_wid_var_event_param_event">event |
|---|
| 138 | |
|---|
| 139 | |
|---|
| 140 | |
|---|
| 141 | |
|---|
| 142 | |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | </h4> |
|---|
| 147 | |
|---|
| 148 | <div class="comments"></div> |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | |
|---|
| 156 | |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | <h3>Other attributes</h3> |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | <h4>Common blocks used</h4><div class="value">wididbase |
|---|
| 175 | resultat |
|---|
| 176 | infovariable |
|---|
| 177 | indicewid_var |
|---|
| 178 | motcle</div> |
|---|
| 179 | |
|---|
| 180 | |
|---|
| 181 | |
|---|
| 182 | </div> |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | <div class="routine_details" id="_wid_var"> |
|---|
| 186 | |
|---|
| 187 | <h2><a class="top" href="#container">top</a>wid_var </h2> |
|---|
| 188 | |
|---|
| 189 | <p class="header"> |
|---|
| 190 | wid_var<span class="result">, <a href="#_wid_var_param_widid_pere">widid_pere</a></span></p> |
|---|
| 191 | |
|---|
| 192 | <div class="comments"></div> |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | |
|---|
| 196 | |
|---|
| 197 | <h3>Parameters</h3> |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | <h4 id="_wid_var_param_widid_pere">widid_pere |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | </h4> |
|---|
| 210 | |
|---|
| 211 | <div class="comments"></div> |
|---|
| 212 | |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | <h3>Other attributes</h3> |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | <h4>Common blocks used</h4><div class="value">resultat |
|---|
| 238 | infovariable |
|---|
| 239 | indicewid_var |
|---|
| 240 | motcle</div> |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | |
|---|
| 244 | </div> |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | <div class="routine_details" id="_xncdf_lec_event"> |
|---|
| 248 | |
|---|
| 249 | <h2><a class="top" href="#container">top</a>xncdf_lec_event </h2> |
|---|
| 250 | |
|---|
| 251 | <p class="header"> |
|---|
| 252 | xncdf_lec_event<span class="result">, <a href="#_xncdf_lec_event_param_event">event</a></span></p> |
|---|
| 253 | |
|---|
| 254 | <div class="comments"></div> |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | <h3>Parameters</h3> |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | <h4 id="_xncdf_lec_event_param_event">event |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | |
|---|
| 266 | |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | </h4> |
|---|
| 272 | |
|---|
| 273 | <div class="comments"></div> |
|---|
| 274 | |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | <h3>Other attributes</h3> |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | <h4>Common blocks used</h4><div class="value">resultat |
|---|
| 300 | infovariable |
|---|
| 301 | motcle</div> |
|---|
| 302 | |
|---|
| 303 | |
|---|
| 304 | |
|---|
| 305 | </div> |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | <div class="routine_details" id="_xncdf_lec"> |
|---|
| 309 | |
|---|
| 310 | <h2><a class="top" href="#container">top</a>xncdf_lec </h2> |
|---|
| 311 | |
|---|
| 312 | <p class="header"> |
|---|
| 313 | <span class="result">result = </span>xncdf_lec(<span class="result"><a href="#_xncdf_lec_param_nom">nom</a></span>, <a href="#_xncdf_lec_keyword_ATT">ATT</a>=<span class="result">ATT</span>, <a href="#_xncdf_lec_keyword_COUNT">COUNT</a>=<span class="result">COUNT</span>, <a href="#_xncdf_lec_keyword_GROUP">GROUP</a>=<span class="result">GROUP</span>, <a href="#_xncdf_lec_keyword_OFFSET">OFFSET</a>=<span class="result">OFFSET</span>, <a href="#_xncdf_lec_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span>, <a href="#_xncdf_lec_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_xncdf_lec_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_xncdf_lec_keyword_VAR">VAR</a>=<span class="result">VAR</span>)</p> |
|---|
| 314 | |
|---|
| 315 | <div class="comments"> |
|---|
| 316 | NAME: xncdf_lec |
|---|
| 317 | |
|---|
| 318 | PURPOSE: lecture d''un fichier Net Cdf avec des widgets ! |
|---|
| 319 | |
|---|
| 320 | CATEGORY: lecture de fichiers avec widgets |
|---|
| 321 | |
|---|
| 322 | CALLING SEQUENCE: res=xncdf_lec([nom_fichier]) |
|---|
| 323 | |
|---|
| 324 | INPUTS: |
|---|
| 325 | OPTIONNEL, nom_fichier: c''est un string qui donne le nom du |
|---|
| 326 | fichier a ouvrir.Si nomfichier ne contient pas le caractere |
|---|
| 327 | separateur de repertoirte ('/' sous unix par ex), Le fichier |
|---|
| 328 | sera cherche ds le repertoire courant |
|---|
| 329 | |
|---|
| 330 | KEYWORD PARAMETERS: |
|---|
| 331 | |
|---|
| 332 | IODIR: string contenant le repertoire ou aller chercher le |
|---|
| 333 | fichier a lire. Si nomfichier ne contient pas le caractere |
|---|
| 334 | separateur de repertoirte ('/' sous unix par ex), Le fichier |
|---|
| 335 | cherche s''appelera iodir+nom_fichier. |
|---|
| 336 | |
|---|
| 337 | COUNT: An optional vector containing the counts to be used in |
|---|
| 338 | reading Value. COUNT is a 1-based vector with an element for |
|---|
| 339 | each dimension of the data to be written.The default matches |
|---|
| 340 | the size of the variable so that all data is written out. |
|---|
| 341 | |
|---|
| 342 | GROUP: The widget ID of the widget that calls XNCDF_LEC. When |
|---|
| 343 | this ID is specified, a death of the caller results in a death |
|---|
| 344 | of XNCDF_LEC. |
|---|
| 345 | |
|---|
| 346 | OFFSET: An optional vector containing the starting position |
|---|
| 347 | for the read. The default start position is [0, 0, ...]. |
|---|
| 348 | |
|---|
| 349 | SHIFT: un vecteur d''entiers, specifiant pour chaque dimension |
|---|
| 350 | de combien il faut la shifter. Par defaut c''est |
|---|
| 351 | [0,0,...]. cf. la fonction shift pour + |
|---|
| 352 | d''explications. ATTENTION, le shift est effectue sur le |
|---|
| 353 | tableau de taille maximum avant la reduction eventuelle |
|---|
| 354 | determinee par OFFSET et COUNT. Par contre il est effectue |
|---|
| 355 | apres l''extraction eventuelle cree par le STRIDE. |
|---|
| 356 | |
|---|
| 357 | STRIDE: An optional vector containing the strides, or sampling |
|---|
| 358 | intervals, between accessed values of the netCDF variable. The |
|---|
| 359 | default stride vector is that for a contiguous read, [1, 1, |
|---|
| 360 | ...]. |
|---|
| 361 | |
|---|
| 362 | OUTPUTS: 2 cas possibles: |
|---|
| 363 | 1) aucun attributs n''a ete selectionne. Dans ce cas res est |
|---|
| 364 | le tableau que l''on voulait lire. |
|---|
| 365 | 2) Des attributs ont ete selectionnes. Dans ce cas res est une |
|---|
| 366 | structre dont le premier element portant le nom de la variable |
|---|
| 367 | est le tableau de valeurs et les autre auguments sont les |
|---|
| 368 | arguments selectiones |
|---|
| 369 | |
|---|
| 370 | COMMON BLOCKS: wididbase, infovariable, resultat, motcle |
|---|
| 371 | |
|---|
| 372 | SIDE EFFECTS: |
|---|
| 373 | |
|---|
| 374 | RESTRICTIONS: |
|---|
| 375 | |
|---|
| 376 | EXAMPLE: help, xncdf_lec() |
|---|
| 377 | </div> |
|---|
| 378 | |
|---|
| 379 | |
|---|
| 380 | |
|---|
| 381 | |
|---|
| 382 | <h3>Parameters</h3> |
|---|
| 383 | |
|---|
| 384 | |
|---|
| 385 | <h4 id="_xncdf_lec_param_nom">nom |
|---|
| 386 | |
|---|
| 387 | |
|---|
| 388 | |
|---|
| 389 | |
|---|
| 390 | |
|---|
| 391 | |
|---|
| 392 | |
|---|
| 393 | |
|---|
| 394 | </h4> |
|---|
| 395 | |
|---|
| 396 | <div class="comments"></div> |
|---|
| 397 | |
|---|
| 398 | |
|---|
| 399 | |
|---|
| 400 | |
|---|
| 401 | |
|---|
| 402 | |
|---|
| 403 | <h3>Keywords</h3> |
|---|
| 404 | |
|---|
| 405 | <h4 id="_xncdf_lec_keyword_ATT">ATT |
|---|
| 406 | |
|---|
| 407 | |
|---|
| 408 | |
|---|
| 409 | |
|---|
| 410 | |
|---|
| 411 | |
|---|
| 412 | |
|---|
| 413 | |
|---|
| 414 | </h4> |
|---|
| 415 | |
|---|
| 416 | <div class="comments"></div> |
|---|
| 417 | |
|---|
| 418 | <h4 id="_xncdf_lec_keyword_COUNT">COUNT |
|---|
| 419 | |
|---|
| 420 | |
|---|
| 421 | |
|---|
| 422 | |
|---|
| 423 | |
|---|
| 424 | |
|---|
| 425 | |
|---|
| 426 | |
|---|
| 427 | </h4> |
|---|
| 428 | |
|---|
| 429 | <div class="comments"></div> |
|---|
| 430 | |
|---|
| 431 | <h4 id="_xncdf_lec_keyword_GROUP">GROUP |
|---|
| 432 | |
|---|
| 433 | |
|---|
| 434 | |
|---|
| 435 | |
|---|
| 436 | |
|---|
| 437 | |
|---|
| 438 | |
|---|
| 439 | |
|---|
| 440 | </h4> |
|---|
| 441 | |
|---|
| 442 | <div class="comments"></div> |
|---|
| 443 | |
|---|
| 444 | <h4 id="_xncdf_lec_keyword_OFFSET">OFFSET |
|---|
| 445 | |
|---|
| 446 | |
|---|
| 447 | |
|---|
| 448 | |
|---|
| 449 | |
|---|
| 450 | |
|---|
| 451 | |
|---|
| 452 | |
|---|
| 453 | </h4> |
|---|
| 454 | |
|---|
| 455 | <div class="comments"></div> |
|---|
| 456 | |
|---|
| 457 | <h4 id="_xncdf_lec_keyword_IODIR">IODIR |
|---|
| 458 | |
|---|
| 459 | |
|---|
| 460 | |
|---|
| 461 | |
|---|
| 462 | |
|---|
| 463 | |
|---|
| 464 | |
|---|
| 465 | |
|---|
| 466 | </h4> |
|---|
| 467 | |
|---|
| 468 | <div class="comments"></div> |
|---|
| 469 | |
|---|
| 470 | <h4 id="_xncdf_lec_keyword_SHIFT">SHIFT |
|---|
| 471 | |
|---|
| 472 | |
|---|
| 473 | |
|---|
| 474 | |
|---|
| 475 | |
|---|
| 476 | |
|---|
| 477 | |
|---|
| 478 | |
|---|
| 479 | </h4> |
|---|
| 480 | |
|---|
| 481 | <div class="comments"></div> |
|---|
| 482 | |
|---|
| 483 | <h4 id="_xncdf_lec_keyword_STRIDE">STRIDE |
|---|
| 484 | |
|---|
| 485 | |
|---|
| 486 | |
|---|
| 487 | |
|---|
| 488 | |
|---|
| 489 | |
|---|
| 490 | |
|---|
| 491 | |
|---|
| 492 | </h4> |
|---|
| 493 | |
|---|
| 494 | <div class="comments"></div> |
|---|
| 495 | |
|---|
| 496 | <h4 id="_xncdf_lec_keyword_VAR">VAR |
|---|
| 497 | |
|---|
| 498 | |
|---|
| 499 | |
|---|
| 500 | |
|---|
| 501 | |
|---|
| 502 | |
|---|
| 503 | |
|---|
| 504 | |
|---|
| 505 | </h4> |
|---|
| 506 | |
|---|
| 507 | <div class="comments"></div> |
|---|
| 508 | |
|---|
| 509 | |
|---|
| 510 | |
|---|
| 511 | |
|---|
| 512 | |
|---|
| 513 | |
|---|
| 514 | |
|---|
| 515 | |
|---|
| 516 | |
|---|
| 517 | |
|---|
| 518 | |
|---|
| 519 | |
|---|
| 520 | |
|---|
| 521 | |
|---|
| 522 | |
|---|
| 523 | |
|---|
| 524 | <h3>Other attributes</h3> |
|---|
| 525 | |
|---|
| 526 | |
|---|
| 527 | |
|---|
| 528 | |
|---|
| 529 | |
|---|
| 530 | <h4>Common blocks used</h4><div class="value">wididbase |
|---|
| 531 | infovariable |
|---|
| 532 | resultat |
|---|
| 533 | motcle</div> |
|---|
| 534 | |
|---|
| 535 | |
|---|
| 536 | |
|---|
| 537 | </div> |
|---|
| 538 | |
|---|
| 539 | </div> |
|---|
| 540 | |
|---|
| 541 | |
|---|
| 542 | |
|---|
| 543 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 544 | |
|---|
| 545 | </div> |
|---|
| 546 | |
|---|
| 547 | </body> |
|---|
| 548 | </html> |
|---|
