| 1 | |
|---|
| 2 | |
|---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 4 | <head> |
|---|
| 5 | <title>ncdf_quickread_helper.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="ncdf_quickread.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">ReadWrite/idl-NetCDF/ncdf_quickread/</font></h1> |
|---|
| 58 | <h2>ncdf_quickread_helper.pro</h2> |
|---|
| 59 | |
|---|
| 60 | <dl> |
|---|
| 61 | </dl> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | This function returns the filename name from the full path. |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | This function returns the directory name from the full path. |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | This routine ensures that the given name does not start with a number, |
|---|
| 71 | nor contain a dash. IDL cannot accept a variable starting with a |
|---|
| 72 | number or containing a dash. If the name starts with a number, an |
|---|
| 73 | underscore is prepended to the name, and if it contains a dash, the |
|---|
| 74 | dash is replaced with an underscore. |
|---|
| 75 | |
|---|
| 76 | |
|---|
| 77 | This procedure creates a script to read the data in a given netCDF |
|---|
| 78 | file into IDL. The default output file is the name of the netCDF |
|---|
| 79 | file with idl replacing any existing suffix. The default output is |
|---|
| 80 | variable data only. |
|---|
| 81 | |
|---|
| 82 | |
|---|
| 83 | |
|---|
| 84 | <h2>Routine summary</h2> |
|---|
| 85 | |
|---|
| 86 | <dl> |
|---|
| 87 | |
|---|
| 88 | <dt><a href="#_ncdf_quickread_getfile"><i>result = </i>ncdf_quickread_getfile(<i>fullpath</i>, suffix=<i>suffix</i>)</a><dt> |
|---|
| 89 | <dd><font size="-1"></font></dd> |
|---|
| 90 | |
|---|
| 91 | <dt><a href="#_ncdf_quickread_getdir"><i>result = </i>ncdf_quickread_getdir(<i>fullpath</i>)</a><dt> |
|---|
| 92 | <dd><font size="-1"></font></dd> |
|---|
| 93 | |
|---|
| 94 | <dt><a href="#_ncdf_quickread_validatename"><i>result = </i>ncdf_quickread_validatename(<i>varname</i>)</a><dt> |
|---|
| 95 | <dd><font size="-1"></font></dd> |
|---|
| 96 | |
|---|
| 97 | <dt><a href="#_ncdf_quickread_helper"><i>result = </i>ncdf_quickread_helper(<i>infile</i>, verbose=<i>verbose</i>, prefix=<i>prefix</i>, fields=<i>fields</i>, reform=<i>reform</i>)</a><dt> |
|---|
| 98 | <dd><font size="-1"></font></dd> |
|---|
| 99 | |
|---|
| 100 | </dl> |
|---|
| 101 | |
|---|
| 102 | <p> </p> |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | |
|---|
| 106 | <a name="#_ncdf_quickread_getfile"></a> |
|---|
| 107 | |
|---|
| 108 | <h2>ncdf_quickread_getfile <font size="-1" color="#006633"> |
|---|
| 109 | |
|---|
| 110 | </font></h2> |
|---|
| 111 | |
|---|
| 112 | <p><font face="Courier"><i>result = </i>ncdf_quickread_getfile(<i><a href="#_ncdf_quickread_getfile_keyword_fullpath">fullpath</a></i>, <a href="#_ncdf_quickread_getfile_keyword_suffix">suffix</a>=<i>suffix</i>)</font></p> |
|---|
| 113 | |
|---|
| 114 | |
|---|
| 115 | |
|---|
| 116 | <h3>Return value</h3> |
|---|
| 117 | file - filename |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | |
|---|
| 121 | <h3>Parameters</h3> |
|---|
| 122 | |
|---|
| 123 | |
|---|
| 124 | <a name="#_ncdf_quickread_getfile_keyword_fullpath"></a> |
|---|
| 125 | <h4>fullpath |
|---|
| 126 | |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | |
|---|
| 133 | |
|---|
| 134 | </h4> |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | full directory+file path |
|---|
| 138 | |
|---|
| 139 | |
|---|
| 140 | |
|---|
| 141 | |
|---|
| 142 | |
|---|
| 143 | <h3>Keywords</h3> |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | <a name="#_ncdf_quickread_getfile_keyword_suffix"></a> |
|---|
| 147 | <h4>suffix |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | |
|---|
| 156 | </h4> |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | include input suffix in output file name |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | <h3>Examples</h3> |
|---|
| 165 | Call: file = ncdf_quickread_getfile(fullpath) |
|---|
| 166 | |
|---|
| 167 | <h3>Version history</h3> |
|---|
| 168 | |
|---|
| 169 | <h4>Version</h4> |
|---|
| 170 | $Id: ncdf_quickread_helper.pro 157 2006-08-21 09:01:50Z navarro $ |
|---|
| 171 | <h4>History</h4> |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | <h3>Known issues</h3> |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | |
|---|
| 180 | <h4>Restrictions</h4> |
|---|
| 181 | |
|---|
| 182 | |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | <font size="-3"><p> </p></font> |
|---|
| 193 | <hr size="1" color="#CCCCCC"/> |
|---|
| 194 | |
|---|
| 195 | <a name="#_ncdf_quickread_getdir"></a> |
|---|
| 196 | |
|---|
| 197 | <h2>ncdf_quickread_getdir <font size="-1" color="#006633"> |
|---|
| 198 | |
|---|
| 199 | </font></h2> |
|---|
| 200 | |
|---|
| 201 | <p><font face="Courier"><i>result = </i>ncdf_quickread_getdir(<i><a href="#_ncdf_quickread_getdir_keyword_fullpath">fullpath</a></i>)</font></p> |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | <h3>Return value</h3> |
|---|
| 206 | directory path |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | <h3>Parameters</h3> |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | <a name="#_ncdf_quickread_getdir_keyword_fullpath"></a> |
|---|
| 214 | <h4>fullpath |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | </h4> |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | full directory+file path |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | <h3>Examples</h3> |
|---|
| 234 | Call: dir = ncdf_quickread_getdir(fullpath) |
|---|
| 235 | |
|---|
| 236 | <h3>Version history</h3> |
|---|
| 237 | |
|---|
| 238 | <h4>Version</h4> |
|---|
| 239 | $Id: ncdf_quickread_helper.pro 157 2006-08-21 09:01:50Z navarro $ |
|---|
| 240 | <h4>History</h4> |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | |
|---|
| 244 | |
|---|
| 245 | <h3>Known issues</h3> |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | <h4>Restrictions</h4> |
|---|
| 250 | |
|---|
| 251 | |
|---|
| 252 | |
|---|
| 253 | |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | <font size="-3"><p> </p></font> |
|---|
| 262 | <hr size="1" color="#CCCCCC"/> |
|---|
| 263 | |
|---|
| 264 | <a name="#_ncdf_quickread_validatename"></a> |
|---|
| 265 | |
|---|
| 266 | <h2>ncdf_quickread_validatename <font size="-1" color="#006633"> |
|---|
| 267 | |
|---|
| 268 | </font></h2> |
|---|
| 269 | |
|---|
| 270 | <p><font face="Courier"><i>result = </i>ncdf_quickread_validatename(<i><a href="#_ncdf_quickread_validatename_keyword_varname">varname</a></i>)</font></p> |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | <h3>Return value</h3> |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | <h3>Parameters</h3> |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | <a name="#_ncdf_quickread_validatename_keyword_varname"></a> |
|---|
| 283 | <h4>varname |
|---|
| 284 | |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | </h4> |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | The name of the variable to be read |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | |
|---|
| 303 | <h3>Examples</h3> |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | <h3>Version history</h3> |
|---|
| 307 | |
|---|
| 308 | <h4>Version</h4> |
|---|
| 309 | $Id: ncdf_quickread_helper.pro 157 2006-08-21 09:01:50Z navarro $ |
|---|
| 310 | <h4>History</h4> |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | <h3>Known issues</h3> |
|---|
| 316 | |
|---|
| 317 | |
|---|
| 318 | |
|---|
| 319 | <h4>Restrictions</h4> |
|---|
| 320 | |
|---|
| 321 | |
|---|
| 322 | |
|---|
| 323 | |
|---|
| 324 | |
|---|
| 325 | |
|---|
| 326 | |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | |
|---|
| 330 | |
|---|
| 331 | <font size="-3"><p> </p></font> |
|---|
| 332 | <hr size="1" color="#CCCCCC"/> |
|---|
| 333 | |
|---|
| 334 | <a name="#_ncdf_quickread_helper"></a> |
|---|
| 335 | |
|---|
| 336 | <h2>ncdf_quickread_helper <font size="-1" color="#006633"> |
|---|
| 337 | |
|---|
| 338 | </font></h2> |
|---|
| 339 | |
|---|
| 340 | <p><font face="Courier"><i>result = </i>ncdf_quickread_helper(<i><a href="#_ncdf_quickread_helper_keyword_infile">infile</a></i>, <a href="#_ncdf_quickread_helper_keyword_verbose">verbose</a>=<i>verbose</i>, <a href="#_ncdf_quickread_helper_keyword_prefix">prefix</a>=<i>prefix</i>, <a href="#_ncdf_quickread_helper_keyword_fields">fields</a>=<i>fields</i>, <a href="#_ncdf_quickread_helper_keyword_reform">reform</a>=<i>reform</i>)</font></p> |
|---|
| 341 | |
|---|
| 342 | |
|---|
| 343 | |
|---|
| 344 | <h3>Return value</h3> |
|---|
| 345 | array of commands to run at top level |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | |
|---|
| 349 | <h3>Parameters</h3> |
|---|
| 350 | |
|---|
| 351 | |
|---|
| 352 | <a name="#_ncdf_quickread_helper_keyword_infile"></a> |
|---|
| 353 | <h4>infile |
|---|
| 354 | |
|---|
| 355 | |
|---|
| 356 | |
|---|
| 357 | |
|---|
| 358 | |
|---|
| 359 | |
|---|
| 360 | |
|---|
| 361 | |
|---|
| 362 | </h4> |
|---|
| 363 | |
|---|
| 364 | |
|---|
| 365 | full path to netCDF file of interest |
|---|
| 366 | |
|---|
| 367 | |
|---|
| 368 | |
|---|
| 369 | |
|---|
| 370 | |
|---|
| 371 | <h3>Keywords</h3> |
|---|
| 372 | |
|---|
| 373 | |
|---|
| 374 | <a name="#_ncdf_quickread_helper_keyword_verbose"></a> |
|---|
| 375 | <h4>verbose |
|---|
| 376 | |
|---|
| 377 | |
|---|
| 378 | |
|---|
| 379 | |
|---|
| 380 | |
|---|
| 381 | |
|---|
| 382 | |
|---|
| 383 | |
|---|
| 384 | </h4> |
|---|
| 385 | |
|---|
| 386 | |
|---|
| 387 | Set this keyword to return an error message in case of an error. |
|---|
| 388 | |
|---|
| 389 | |
|---|
| 390 | <a name="#_ncdf_quickread_helper_keyword_prefix"></a> |
|---|
| 391 | <h4>prefix |
|---|
| 392 | |
|---|
| 393 | |
|---|
| 394 | |
|---|
| 395 | |
|---|
| 396 | |
|---|
| 397 | |
|---|
| 398 | |
|---|
| 399 | |
|---|
| 400 | </h4> |
|---|
| 401 | |
|---|
| 402 | |
|---|
| 403 | see changelog above. |
|---|
| 404 | |
|---|
| 405 | |
|---|
| 406 | <a name="#_ncdf_quickread_helper_keyword_fields"></a> |
|---|
| 407 | <h4>fields |
|---|
| 408 | |
|---|
| 409 | |
|---|
| 410 | |
|---|
| 411 | |
|---|
| 412 | |
|---|
| 413 | |
|---|
| 414 | |
|---|
| 415 | |
|---|
| 416 | </h4> |
|---|
| 417 | |
|---|
| 418 | |
|---|
| 419 | |
|---|
| 420 | |
|---|
| 421 | |
|---|
| 422 | <a name="#_ncdf_quickread_helper_keyword_reform"></a> |
|---|
| 423 | <h4>reform |
|---|
| 424 | |
|---|
| 425 | |
|---|
| 426 | |
|---|
| 427 | |
|---|
| 428 | |
|---|
| 429 | |
|---|
| 430 | |
|---|
| 431 | |
|---|
| 432 | </h4> |
|---|
| 433 | |
|---|
| 434 | |
|---|
| 435 | see changelog above. |
|---|
| 436 | |
|---|
| 437 | |
|---|
| 438 | |
|---|
| 439 | |
|---|
| 440 | <h3>Examples</h3> |
|---|
| 441 | |
|---|
| 442 | |
|---|
| 443 | <h3>Version history</h3> |
|---|
| 444 | |
|---|
| 445 | <h4>Version</h4> |
|---|
| 446 | $Id: ncdf_quickread_helper.pro 157 2006-08-21 09:01:50Z navarro $ |
|---|
| 447 | |
|---|
| 448 | <h4>History</h4> |
|---|
| 449 | |
|---|
| 450 | |
|---|
| 451 | |
|---|
| 452 | |
|---|
| 453 | <h3>Known issues</h3> |
|---|
| 454 | |
|---|
| 455 | |
|---|
| 456 | |
|---|
| 457 | <h4>Restrictions</h4> |
|---|
| 458 | |
|---|
| 459 | |
|---|
| 460 | |
|---|
| 461 | |
|---|
| 462 | |
|---|
| 463 | |
|---|
| 464 | |
|---|
| 465 | |
|---|
| 466 | |
|---|
| 467 | |
|---|
| 468 | |
|---|
| 469 | <font size="-3"><p> </p></font> |
|---|
| 470 | <hr size="1" color="#CCCCCC"/> |
|---|
| 471 | |
|---|
| 472 | |
|---|
| 473 | |
|---|
| 474 | |
|---|
| 475 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0 on Tue Aug 29 14:49:34 2006.</font></p> |
|---|
| 476 | |
|---|
| 477 | </body> |
|---|
| 478 | </html> |
|---|
