| 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?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_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?format=raw" 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?format=raw">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"></div> |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | <div id="routine_details"> |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | <div class="routine_details" id="_read_ncdf"> |
|---|
| 103 | |
|---|
| 104 | <h2><a class="top" href="#container">top</a>read_ncdf </h2> |
|---|
| 105 | |
|---|
| 106 | <p class="header"> |
|---|
| 107 | <span class="result">result = </span>read_ncdf(<span class="result"><a href="#_read_ncdf_param_name">name</a>, <a href="#_read_ncdf_param_debut">debut</a>, <a href="#_read_ncdf_param_fin">fin</a>, <a href="#_read_ncdf_param_pour_etre_compatible">pour_etre_compatible</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">FILENAME</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">TIMESTEP</span>, <a href="#_read_ncdf_keyword_TIMEVAR">TIMEVAR</a>=<span class="result">TIMEVAR</span>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<span class="result">TOUT</span>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">NOSTRUCT</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">INIT</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__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> |
|---|
| 108 | |
|---|
| 109 | <div class="comments"> |
|---|
| 110 | NAME: read_ncdf |
|---|
| 111 | |
|---|
| 112 | PURPOSE:fonction de lecture pour fichier net_cdf. |
|---|
| 113 | Ce programme, est moins universel que ncdf_lec (il fait appelle au |
|---|
| 114 | variables declarees dans common.pro) mais il est du cop bcp plus |
|---|
| 115 | facile d''utilisation. Il prend en compte la declaration des |
|---|
| 116 | differents zoom qui ont ete definis (ixminmesh...premierx...) la |
|---|
| 117 | declaration de la variable key_shift... bref le resultat de |
|---|
| 118 | read_ncdf peut dorectement etre utilise dans plt... |
|---|
| 119 | C''est aussi ce programme qui est utilise par defaut dans mes |
|---|
| 120 | widgets pour la partie lecture. |
|---|
| 121 | |
|---|
| 122 | CATEGORY:lecture de fichiers NetCdf |
|---|
| 123 | |
|---|
| 124 | CALLING SEQUENCE:res = read_ncdf(name,debut[,fin]) |
|---|
| 125 | |
|---|
| 126 | INPUTS: name: un string definissant le champ a lire. |
|---|
| 127 | debut et fin: sont relatifs a l''axe des temps. Ce peut etre |
|---|
| 128 | - 2 dates du type yyyymmdd et ds ce cas on selectionne les |
|---|
| 129 | dates qui sont comprisent entre ces 2 dates. |
|---|
| 130 | - 2 indices qui definissent entre quel et quel pas de temps |
|---|
| 131 | on doit extraire la dimension temporelle. |
|---|
| 132 | exp: ne sert a rien! |
|---|
| 133 | |
|---|
| 134 | KEYWORD PARAMETERS: utilisables hors du contexte des widgets |
|---|
| 135 | |
|---|
| 136 | BOXZOOM: contient la boxzoom sur laquelle on doit faire la |
|---|
| 137 | lecture |
|---|
| 138 | FILENAME: string contennant le nom du fichier |
|---|
| 139 | /INIT; to call automatically initncdf, filename and thus |
|---|
| 140 | redefine all the grid parameters |
|---|
| 141 | GRID='[UTVWF]' to specify the type of grid. Defaut is (1) |
|---|
| 142 | based on the name of the file if the file ends by |
|---|
| 143 | GRID[._][TUVFW].NC (not case sensible) or (2) T if case (1) |
|---|
| 144 | is not found. |
|---|
| 145 | IODIRECTORY;a string giving the name of iodirectory (see |
|---|
| 146 | isafile.pro for all possibilities). default value is common |
|---|
| 147 | variable iodir |
|---|
| 148 | TIMESTEP:activer pour specifier que debut et fin font |
|---|
| 149 | reference a des indices de l''axe du temps et non pas a des |
|---|
| 150 | dates. |
|---|
| 151 | TOUT: activer si on veut lire le ficher sur l''ensemble du |
|---|
| 152 | domaine sans tenir compte du sous domaine definit par boxzoom |
|---|
| 153 | ou lon1,lon2,lat1,lat2,vert1,vert2. |
|---|
| 154 | NOSTRUCT: activer si on ne veut pas que read_ncdf reourne |
|---|
| 155 | une structure mais uniquement le tableau se rapportant au |
|---|
| 156 | champ. |
|---|
| 157 | TIMEVAR: a string to define the name of the variable that |
|---|
| 158 | contains the time axis. This keyword can be usefull if there |
|---|
| 159 | is no unlimited dimension or if the time axis selected by defaut |
|---|
| 160 | (the first 1D array with unlimited dimension) is not the good one |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | OUTPUTS:une stucture lisible par litchamp.pro ou un simple tableau |
|---|
| 164 | si /NOSTRUCT est active |
|---|
| 165 | |
|---|
| 166 | COMMON BLOCKS:common.pro |
|---|
| 167 | |
|---|
| 168 | SIDE EFFECTS: |
|---|
| 169 | |
|---|
| 170 | RESTRICTIONS:le champ doit avoir une dimension temporelle |
|---|
| 171 | |
|---|
| 172 | EXAMPLE: |
|---|
| 173 | </div> |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | |
|---|
| 178 | <h3>Parameters</h3> |
|---|
| 179 | |
|---|
| 180 | |
|---|
| 181 | <h4 id="_read_ncdf_param_name">name |
|---|
| 182 | |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | </h4> |
|---|
| 191 | |
|---|
| 192 | <div class="comments"></div> |
|---|
| 193 | |
|---|
| 194 | <h4 id="_read_ncdf_param_debut">debut |
|---|
| 195 | |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | </h4> |
|---|
| 204 | |
|---|
| 205 | <div class="comments"></div> |
|---|
| 206 | |
|---|
| 207 | <h4 id="_read_ncdf_param_fin">fin |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | </h4> |
|---|
| 217 | |
|---|
| 218 | <div class="comments"></div> |
|---|
| 219 | |
|---|
| 220 | <h4 id="_read_ncdf_param_pour_etre_compatible">pour_etre_compatible |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | </h4> |
|---|
| 230 | |
|---|
| 231 | <div class="comments"></div> |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | <h3>Keywords</h3> |
|---|
| 239 | |
|---|
| 240 | <h4 id="_read_ncdf_keyword_BOXZOOM">BOXZOOM |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | </h4> |
|---|
| 250 | |
|---|
| 251 | <div class="comments"></div> |
|---|
| 252 | |
|---|
| 253 | <h4 id="_read_ncdf_keyword_FILENAME">FILENAME |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | </h4> |
|---|
| 263 | |
|---|
| 264 | <div class="comments"></div> |
|---|
| 265 | |
|---|
| 266 | <h4 id="_read_ncdf_keyword_PARENTIN">PARENTIN |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | </h4> |
|---|
| 276 | |
|---|
| 277 | <div class="comments"></div> |
|---|
| 278 | |
|---|
| 279 | <h4 id="_read_ncdf_keyword_TIMESTEP">TIMESTEP |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | </h4> |
|---|
| 289 | |
|---|
| 290 | <div class="comments"></div> |
|---|
| 291 | |
|---|
| 292 | <h4 id="_read_ncdf_keyword_TIMEVAR">TIMEVAR |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | </h4> |
|---|
| 302 | |
|---|
| 303 | <div class="comments"></div> |
|---|
| 304 | |
|---|
| 305 | <h4 id="_read_ncdf_keyword_TOUT">TOUT |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | |
|---|
| 314 | </h4> |
|---|
| 315 | |
|---|
| 316 | <div class="comments"></div> |
|---|
| 317 | |
|---|
| 318 | <h4 id="_read_ncdf_keyword_NOSTRUCT">NOSTRUCT |
|---|
| 319 | |
|---|
| 320 | |
|---|
| 321 | |
|---|
| 322 | |
|---|
| 323 | |
|---|
| 324 | |
|---|
| 325 | |
|---|
| 326 | |
|---|
| 327 | </h4> |
|---|
| 328 | |
|---|
| 329 | <div class="comments"></div> |
|---|
| 330 | |
|---|
| 331 | <h4 id="_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL |
|---|
| 332 | |
|---|
| 333 | |
|---|
| 334 | |
|---|
| 335 | |
|---|
| 336 | |
|---|
| 337 | |
|---|
| 338 | |
|---|
| 339 | |
|---|
| 340 | </h4> |
|---|
| 341 | |
|---|
| 342 | <div class="comments"></div> |
|---|
| 343 | |
|---|
| 344 | <h4 id="_read_ncdf_keyword_INIT">INIT |
|---|
| 345 | |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | |
|---|
| 349 | |
|---|
| 350 | |
|---|
| 351 | |
|---|
| 352 | |
|---|
| 353 | </h4> |
|---|
| 354 | |
|---|
| 355 | <div class="comments"></div> |
|---|
| 356 | |
|---|
| 357 | <h4 id="_read_ncdf_keyword_GRID">GRID |
|---|
| 358 | |
|---|
| 359 | |
|---|
| 360 | |
|---|
| 361 | |
|---|
| 362 | |
|---|
| 363 | |
|---|
| 364 | |
|---|
| 365 | |
|---|
| 366 | </h4> |
|---|
| 367 | |
|---|
| 368 | <div class="comments"></div> |
|---|
| 369 | |
|---|
| 370 | <h4 id="_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE |
|---|
| 371 | |
|---|
| 372 | |
|---|
| 373 | |
|---|
| 374 | |
|---|
| 375 | |
|---|
| 376 | |
|---|
| 377 | |
|---|
| 378 | |
|---|
| 379 | </h4> |
|---|
| 380 | |
|---|
| 381 | <div class="comments"></div> |
|---|
| 382 | |
|---|
| 383 | <h4 id="_read_ncdf_keyword__EXTRA">_EXTRA |
|---|
| 384 | |
|---|
| 385 | |
|---|
| 386 | |
|---|
| 387 | |
|---|
| 388 | |
|---|
| 389 | |
|---|
| 390 | |
|---|
| 391 | |
|---|
| 392 | </h4> |
|---|
| 393 | |
|---|
| 394 | <div class="comments"></div> |
|---|
| 395 | |
|---|
| 396 | |
|---|
| 397 | |
|---|
| 398 | |
|---|
| 399 | |
|---|
| 400 | |
|---|
| 401 | |
|---|
| 402 | |
|---|
| 403 | |
|---|
| 404 | |
|---|
| 405 | |
|---|
| 406 | |
|---|
| 407 | |
|---|
| 408 | |
|---|
| 409 | |
|---|
| 410 | |
|---|
| 411 | |
|---|
| 412 | |
|---|
| 413 | |
|---|
| 414 | |
|---|
| 415 | |
|---|
| 416 | |
|---|
| 417 | |
|---|
| 418 | |
|---|
| 419 | |
|---|
| 420 | |
|---|
| 421 | </div> |
|---|
| 422 | |
|---|
| 423 | </div> |
|---|
| 424 | |
|---|
| 425 | |
|---|
| 426 | |
|---|
| 427 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 428 | |
|---|
| 429 | </div> |
|---|
| 430 | |
|---|
| 431 | </body> |
|---|
| 432 | </html> |
|---|
