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