| 1 | |
|---|
| 2 | |
|---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 4 | <head> |
|---|
| 5 | <title>xncdf_lec.pro (SAXO Documentation Assistant)</title> |
|---|
| 6 | </head> |
|---|
| 7 | |
|---|
| 8 | <body text="#000000" bgcolor="#FFFFFF"> |
|---|
| 9 | |
|---|
| 10 | |
|---|
| 11 | <!-- Navbar template takes a structure with the following fields: |
|---|
| 12 | overview_href : |
|---|
| 13 | overview_selected : |
|---|
| 14 | dir_overview_href : |
|---|
| 15 | dir_overview_selected : |
|---|
| 16 | categories_href : |
|---|
| 17 | categories_selected : |
|---|
| 18 | index_href : |
|---|
| 19 | index_selected : |
|---|
| 20 | search_href : |
|---|
| 21 | search_selected : |
|---|
| 22 | file_selected : |
|---|
| 23 | source_href : |
|---|
| 24 | source_selected : |
|---|
| 25 | help_href : |
|---|
| 26 | help_selected : |
|---|
| 27 | etc_selected : |
|---|
| 28 | |
|---|
| 29 | prev_file_href : |
|---|
| 30 | next_file_href : |
|---|
| 31 | |
|---|
| 32 | view_single_page_href : |
|---|
| 33 | view_frames_href : |
|---|
| 34 | |
|---|
| 35 | summary_fields_href : |
|---|
| 36 | summary_routine_href : |
|---|
| 37 | details_routine_href : |
|---|
| 38 | |
|---|
| 39 | title : |
|---|
| 40 | subtitle : |
|---|
| 41 | user : |
|---|
| 42 | --> |
|---|
| 43 | |
|---|
| 44 | |
|---|
| 45 | <table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom"> |
|---|
| 46 | <tr> |
|---|
| 47 | <td width="10%"> |
|---|
| 48 | <a href="read_ncdf_varget.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td> |
|---|
| 49 | <td width="80%" align="center" valign="center"> |
|---|
| 50 | <font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td> |
|---|
| 51 | <td width="10%" align="right"> |
|---|
| 52 | <a href=""><img src="./../../next.gif" border="0" alt="Next"></a></td> |
|---|
| 53 | </tr> |
|---|
| 54 | </table> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <h1><font size="-2">ToBeReviewed/LECTURE/</font></h1> |
|---|
| 58 | <h2>xncdf_lec.pro</h2> |
|---|
| 59 | |
|---|
| 60 | <dl> |
|---|
| 61 | </dl> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | Reading of a NetCdf file with widgets |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | Procedure called by xmanager when we press on a button of a second widget created by wid_var. |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | This procedure manage the second created widget when we call xncdf_lec. |
|---|
| 71 | This widget concern the reading of the variable. |
|---|
| 72 | |
|---|
| 73 | |
|---|
| 74 | Procedure called by xmanager when we press a button of the first widget |
|---|
| 75 | created by par xncdf_lec |
|---|
| 76 | |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | <h2>Routine summary</h2> |
|---|
| 80 | |
|---|
| 81 | <dl> |
|---|
| 82 | |
|---|
| 83 | <dt><a href="#_xncdf_lec"><i>result = </i>xncdf_lec(<i>[name]</i>, ATT=<i>ATT</i>, COUNT=<i>vector</i>, GROUP=<i>GROUP</i>, OFFSET=<i>vector</i>, IODIR=<i>string</i>, SHIFT=<i>vector</i>, STRIDE=<i>vector</i>, VAR=<i>VAR</i>)</a><dt> |
|---|
| 84 | <dd><font size="-1"> </font></dd> |
|---|
| 85 | |
|---|
| 86 | <dt><a href="#_wid_var_event">wid_var_event<i>, event</i></a><dt> |
|---|
| 87 | <dd><font size="-1"> </font></dd> |
|---|
| 88 | |
|---|
| 89 | <dt><a href="#_wid_var">wid_var<i>, widid_pere</i></a><dt> |
|---|
| 90 | <dd><font size="-1"> </font></dd> |
|---|
| 91 | |
|---|
| 92 | <dt><a href="#_xncdf_lec_event">xncdf_lec_event<i>, event</i></a><dt> |
|---|
| 93 | <dd><font size="-1"> </font></dd> |
|---|
| 94 | |
|---|
| 95 | </dl> |
|---|
| 96 | |
|---|
| 97 | <p> </p> |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | <a name="#_xncdf_lec"></a> |
|---|
| 102 | |
|---|
| 103 | <h2>xncdf_lec <font size="-1" color="#006633"> |
|---|
| 104 | Widget |
|---|
| 105 | </font></h2> |
|---|
| 106 | |
|---|
| 107 | <p><font face="Courier"><i>result = </i>xncdf_lec(<i>[<a href="#_xncdf_lec_keyword_name">name</a>]</i>, <a href="#_xncdf_lec_keyword_ATT">ATT</a>=<i>ATT</i>, <a href="#_xncdf_lec_keyword_COUNT">COUNT</a>=<i>vector</i>, <a href="#_xncdf_lec_keyword_GROUP">GROUP</a>=<i>GROUP</i>, <a href="#_xncdf_lec_keyword_OFFSET">OFFSET</a>=<i>vector</i>, <a href="#_xncdf_lec_keyword_IODIR">IODIR</a>=<i>string</i>, <a href="#_xncdf_lec_keyword_SHIFT">SHIFT</a>=<i>vector</i>, <a href="#_xncdf_lec_keyword_STRIDE">STRIDE</a>=<i>vector</i>, <a href="#_xncdf_lec_keyword_VAR">VAR</a>=<i>VAR</i>)</font></p> |
|---|
| 108 | |
|---|
| 109 | |
|---|
| 110 | |
|---|
| 111 | |
|---|
| 112 | <h3>Return value</h3> |
|---|
| 113 | 2 different cases: |
|---|
| 114 | 1) None attribute has been selected. In this case, res is the array we |
|---|
| 115 | wanted to read. |
|---|
| 116 | 2) Some attributes has been selected. In this case, res is a structure |
|---|
| 117 | whose the first element having the name of the variable is the values |
|---|
| 118 | array and the other arguments are the select arguments. |
|---|
| 119 | |
|---|
| 120 | |
|---|
| 121 | |
|---|
| 122 | <h3>Parameters</h3> |
|---|
| 123 | |
|---|
| 124 | |
|---|
| 125 | <a name="#_xncdf_lec_keyword_name"></a> |
|---|
| 126 | <h4>name |
|---|
| 127 | <font size="-1" color="#006633">in</font> |
|---|
| 128 | |
|---|
| 129 | <font size="-1" color="#006633">optional</font> |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> |
|---|
| 133 | |
|---|
| 134 | |
|---|
| 135 | </h4> |
|---|
| 136 | |
|---|
| 137 | |
|---|
| 138 | It give the name of the file to be opened. If NAME |
|---|
| 139 | does not contain the separating character of directories ('/' under |
|---|
| 140 | unix for example), the file will be looked for in the current directory. |
|---|
| 141 | |
|---|
| 142 | |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | <h3>Keywords</h3> |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | <a name="#_xncdf_lec_keyword_ATT"></a> |
|---|
| 150 | <h4>ATT |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | |
|---|
| 156 | |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | </h4> |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | <a name="#_xncdf_lec_keyword_COUNT"></a> |
|---|
| 164 | <h4>COUNT |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | |
|---|
| 170 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font> |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | </h4> |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | An optional vector containing the counts to be used in |
|---|
| 177 | reading Value. COUNT is a 1-based vector with an element for |
|---|
| 178 | each dimension of the data to be written.The default matches |
|---|
| 179 | the size of the variable so that all data is written out. |
|---|
| 180 | |
|---|
| 181 | |
|---|
| 182 | <a name="#_xncdf_lec_keyword_GROUP"></a> |
|---|
| 183 | <h4>GROUP |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | </h4> |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | The widget ID of the widget that calls XNCDF_LEC. When |
|---|
| 196 | this ID is specified, a death of the caller results in a death |
|---|
| 197 | of XNCDF_LEC. |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | <a name="#_xncdf_lec_keyword_OFFSET"></a> |
|---|
| 201 | <h4>OFFSET |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font> |
|---|
| 208 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[0, 0,...]</i></font> |
|---|
| 209 | |
|---|
| 210 | </h4> |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | An optional vector containing the starting position |
|---|
| 214 | for the read. The default start position is [0, 0, ...]. |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | <a name="#_xncdf_lec_keyword_IODIR"></a> |
|---|
| 218 | <h4>IODIR |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | </h4> |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | It contains the directory where to go look for the file to be read. |
|---|
| 231 | If NAME does not contain the separating character of directories ('/' under |
|---|
| 232 | unix for example), the file will be called iodir+nom_fichier. |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | <a name="#_xncdf_lec_keyword_SHIFT"></a> |
|---|
| 236 | <h4>SHIFT |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | |
|---|
| 241 | |
|---|
| 242 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font> |
|---|
| 243 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[0, 0,...]</i></font> |
|---|
| 244 | |
|---|
| 245 | </h4> |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | A vector of integers, specifying for each dimension how much we have to shift it. |
|---|
| 249 | By default, it is [0,0,...]. See the function <proidl>shift</proidl> for more explanations. BEWARE, |
|---|
| 250 | the shift is done on the biggest array before a possible reduction determined |
|---|
| 251 | by OFFSET and COUNT. On the other hand, it is done after the possible extraction |
|---|
| 252 | created by the STRIDE. |
|---|
| 253 | |
|---|
| 254 | |
|---|
| 255 | <a name="#_xncdf_lec_keyword_STRIDE"></a> |
|---|
| 256 | <h4>STRIDE |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font> |
|---|
| 263 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[1, 1,...]</i></font> |
|---|
| 264 | |
|---|
| 265 | </h4> |
|---|
| 266 | |
|---|
| 267 | |
|---|
| 268 | An optional vector containing the strides, or sampling |
|---|
| 269 | intervals, between accessed values of the netCDF variable. The |
|---|
| 270 | default stride vector is that for a contiguous read, [1, 1,...]. |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | <a name="#_xncdf_lec_keyword_VAR"></a> |
|---|
| 274 | <h4>VAR |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | </h4> |
|---|
| 284 | |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | <h3>Examples</h3><pre> |
|---|
| 290 | IDL> help, xncdf_lec() |
|---|
| 291 | |
|---|
| 292 | </pre><h3>Version history</h3> |
|---|
| 293 | |
|---|
| 294 | <h4>Version</h4> |
|---|
| 295 | $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $ |
|---|
| 296 | |
|---|
| 297 | <h4>History</h4> |
|---|
| 298 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 299 | 24/8/1999 |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | |
|---|
| 303 | |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | <h3>Other attributes</h3> |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | <h4>Uses routines</h4> |
|---|
| 313 | wididbase, infovariable, resultat, motcle |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | |
|---|
| 317 | <h4>Common blocks used</h4>wididbase |
|---|
| 318 | infovariable |
|---|
| 319 | resultat |
|---|
| 320 | motcle |
|---|
| 321 | |
|---|
| 322 | <font size="-3"><p> </p></font> |
|---|
| 323 | <hr size="1" color="#CCCCCC"/> |
|---|
| 324 | |
|---|
| 325 | <a name="#_wid_var_event"></a> |
|---|
| 326 | |
|---|
| 327 | <h2>wid_var_event </h2> |
|---|
| 328 | |
|---|
| 329 | <p><font face="Courier">wid_var_event<i>, <a href="#_wid_var_event_keyword_event">event</a></i></font></p> |
|---|
| 330 | |
|---|
| 331 | |
|---|
| 332 | |
|---|
| 333 | |
|---|
| 334 | |
|---|
| 335 | |
|---|
| 336 | |
|---|
| 337 | <h3>Parameters</h3> |
|---|
| 338 | |
|---|
| 339 | |
|---|
| 340 | <a name="#_wid_var_event_keyword_event"></a> |
|---|
| 341 | <h4>event |
|---|
| 342 | <font size="-1" color="#006633">in</font> |
|---|
| 343 | |
|---|
| 344 | |
|---|
| 345 | <font size="-1" color="#006633">required</font> |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | |
|---|
| 349 | |
|---|
| 350 | </h4> |
|---|
| 351 | |
|---|
| 352 | |
|---|
| 353 | A structure characterizing the type of event which arrive to a widget number1 2 |
|---|
| 354 | |
|---|
| 355 | |
|---|
| 356 | |
|---|
| 357 | |
|---|
| 358 | |
|---|
| 359 | |
|---|
| 360 | |
|---|
| 361 | </pre><h3>Version history</h3> |
|---|
| 362 | |
|---|
| 363 | <h4>Version</h4> |
|---|
| 364 | $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $ |
|---|
| 365 | |
|---|
| 366 | |
|---|
| 367 | |
|---|
| 368 | |
|---|
| 369 | |
|---|
| 370 | |
|---|
| 371 | |
|---|
| 372 | |
|---|
| 373 | |
|---|
| 374 | |
|---|
| 375 | <h3>Other attributes</h3> |
|---|
| 376 | |
|---|
| 377 | |
|---|
| 378 | <h4>Uses routines</h4> |
|---|
| 379 | wididbase,resultat,infovariable,indicewid,motcle |
|---|
| 380 | |
|---|
| 381 | |
|---|
| 382 | |
|---|
| 383 | <h4>Common blocks used</h4>wididbase |
|---|
| 384 | resultat |
|---|
| 385 | infovariable |
|---|
| 386 | indicewid_var |
|---|
| 387 | motcle |
|---|
| 388 | |
|---|
| 389 | <font size="-3"><p> </p></font> |
|---|
| 390 | <hr size="1" color="#CCCCCC"/> |
|---|
| 391 | |
|---|
| 392 | <a name="#_wid_var"></a> |
|---|
| 393 | |
|---|
| 394 | <h2>wid_var </h2> |
|---|
| 395 | |
|---|
| 396 | <p><font face="Courier">wid_var<i>, <a href="#_wid_var_keyword_widid_pere">widid_pere</a></i></font></p> |
|---|
| 397 | |
|---|
| 398 | |
|---|
| 399 | |
|---|
| 400 | |
|---|
| 401 | |
|---|
| 402 | |
|---|
| 403 | |
|---|
| 404 | <h3>Parameters</h3> |
|---|
| 405 | |
|---|
| 406 | |
|---|
| 407 | <a name="#_wid_var_keyword_widid_pere"></a> |
|---|
| 408 | <h4>widid_pere |
|---|
| 409 | <font size="-1" color="#006633">in</font> |
|---|
| 410 | |
|---|
| 411 | |
|---|
| 412 | <font size="-1" color="#006633">required</font> |
|---|
| 413 | |
|---|
| 414 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> |
|---|
| 415 | |
|---|
| 416 | |
|---|
| 417 | </h4> |
|---|
| 418 | |
|---|
| 419 | |
|---|
| 420 | It contains the identity of the father widget which was |
|---|
| 421 | created by xncdf_lec and which has allowed to select the variable to be read. |
|---|
| 422 | |
|---|
| 423 | |
|---|
| 424 | |
|---|
| 425 | |
|---|
| 426 | |
|---|
| 427 | |
|---|
| 428 | |
|---|
| 429 | </pre><h3>Version history</h3> |
|---|
| 430 | |
|---|
| 431 | <h4>Version</h4> |
|---|
| 432 | $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $ |
|---|
| 433 | |
|---|
| 434 | |
|---|
| 435 | |
|---|
| 436 | |
|---|
| 437 | |
|---|
| 438 | |
|---|
| 439 | |
|---|
| 440 | |
|---|
| 441 | |
|---|
| 442 | <h3>Other attributes</h3> |
|---|
| 443 | |
|---|
| 444 | |
|---|
| 445 | <h4>Uses routines</h4> |
|---|
| 446 | resultat,infovariable,indicewid_var,motcle |
|---|
| 447 | |
|---|
| 448 | |
|---|
| 449 | |
|---|
| 450 | <h4>Common blocks used</h4>resultat |
|---|
| 451 | infovariable |
|---|
| 452 | indicewid_var |
|---|
| 453 | motcle |
|---|
| 454 | |
|---|
| 455 | <font size="-3"><p> </p></font> |
|---|
| 456 | <hr size="1" color="#CCCCCC"/> |
|---|
| 457 | |
|---|
| 458 | <a name="#_xncdf_lec_event"></a> |
|---|
| 459 | |
|---|
| 460 | <h2>xncdf_lec_event </h2> |
|---|
| 461 | |
|---|
| 462 | <p><font face="Courier">xncdf_lec_event<i>, <a href="#_xncdf_lec_event_keyword_event">event</a></i></font></p> |
|---|
| 463 | |
|---|
| 464 | |
|---|
| 465 | |
|---|
| 466 | |
|---|
| 467 | |
|---|
| 468 | |
|---|
| 469 | |
|---|
| 470 | <h3>Parameters</h3> |
|---|
| 471 | |
|---|
| 472 | |
|---|
| 473 | <a name="#_xncdf_lec_event_keyword_event"></a> |
|---|
| 474 | <h4>event |
|---|
| 475 | |
|---|
| 476 | |
|---|
| 477 | |
|---|
| 478 | |
|---|
| 479 | |
|---|
| 480 | |
|---|
| 481 | |
|---|
| 482 | |
|---|
| 483 | </h4> |
|---|
| 484 | |
|---|
| 485 | |
|---|
| 486 | A structure characterising the event type which arrive at the widget number 1. |
|---|
| 487 | |
|---|
| 488 | |
|---|
| 489 | |
|---|
| 490 | |
|---|
| 491 | |
|---|
| 492 | |
|---|
| 493 | |
|---|
| 494 | </pre><h3>Version history</h3> |
|---|
| 495 | |
|---|
| 496 | <h4>Version</h4> |
|---|
| 497 | $Id: xncdf_lec.pro 327 2007-12-13 16:22:35Z pinsard $ |
|---|
| 498 | |
|---|
| 499 | |
|---|
| 500 | |
|---|
| 501 | |
|---|
| 502 | |
|---|
| 503 | |
|---|
| 504 | |
|---|
| 505 | |
|---|
| 506 | |
|---|
| 507 | |
|---|
| 508 | <h3>Other attributes</h3> |
|---|
| 509 | |
|---|
| 510 | |
|---|
| 511 | <h4>Uses routines</h4> |
|---|
| 512 | resultat, infovariable, motcle |
|---|
| 513 | |
|---|
| 514 | |
|---|
| 515 | |
|---|
| 516 | <h4>Common blocks used</h4>resultat |
|---|
| 517 | infovariable |
|---|
| 518 | motcle |
|---|
| 519 | |
|---|
| 520 | <font size="-3"><p> </p></font> |
|---|
| 521 | <hr size="1" color="#CCCCCC"/> |
|---|
| 522 | |
|---|
| 523 | |
|---|
| 524 | |
|---|
| 525 | |
|---|
| 526 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
|---|
| 527 | |
|---|
| 528 | </body> |
|---|
| 529 | </html> |
|---|
