| 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>ncdf_getatt.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="ncdf_getatt.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" title="Overview of library">Overview</a></td> |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | <td >Directory</td> |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td> |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td> |
|---|
| 48 | |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | <td><a href="./../search-page.html" title="Search library">Search</a></td> |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | <td id="selected">File</td> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <td><a href="../../../ReadWrite//ncdf_getatt.pro" title="Source code of a file">Source</a></td> |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | |
|---|
| 61 | <td><a href="./../idldoc-help.html" 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 | << prev file | <a href="ncdf_getaxis.html">next file >></a> <a href="ncdf_getatt.html" target="_TOP">view single page</a> | <a href="./../index.html" 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">ReadWrite/</a></h1> |
|---|
| 82 | <h2 class="pro_file">ncdf_getatt.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"> |
|---|
| 90 | Get variable attibutes from a NetCDF file |
|---|
| 91 | </div> |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | <div id="routine_details"> |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | <div class="routine_details" id="_ncdf_getatt"> |
|---|
| 105 | |
|---|
| 106 | <h2><a class="top" href="#container">top</a>ncdf_getatt <span class="categories"> |
|---|
| 107 | Read NetCDF file |
|---|
| 108 | </span></h2> |
|---|
| 109 | |
|---|
| 110 | <p class="header"> |
|---|
| 111 | ncdf_getatt<span class="result">, <a href="#_ncdf_getatt_param_fileid">fileid</a>, <a href="#_ncdf_getatt_param_varid">varid</a></span>, <a href="#_ncdf_getatt_keyword_ADD_OFFSET">ADD_OFFSET</a>=<span class="result">ADD_OFFSET</span>, <a href="#_ncdf_getatt_keyword_SCALE_FACTOR">SCALE_FACTOR</a>=<span class="result">SCALE_FACTOR</span>, <a href="#_ncdf_getatt_keyword_MISSING_VALUE">MISSING_VALUE</a>=<span class="result">MISSING_VALUE</span>, <a href="#_ncdf_getatt_keyword_UNITS">UNITS</a>=<span class="result">UNITS</span>, <a href="#_ncdf_getatt_keyword_CALENDAR">CALENDAR</a>=<span class="result">CALENDAR</span>, <a href="#_ncdf_getatt_keyword_LONG_NAME">LONG_NAME</a>=<span class="result">LONG_NAME</span>, <a href="#_ncdf_getatt_keyword_STANDARD_NAME">STANDARD_NAME</a>=<span class="result">STANDARD_NAME</span>, <a href="#_ncdf_getatt_keyword_DOUBLE">DOUBLE</a>=<span class="result">1 or 0</span>, <a href="#_ncdf_getatt_keyword__extra">_extra</a>=<span class="result">_extra</span></p> |
|---|
| 112 | |
|---|
| 113 | <div class="comments"> |
|---|
| 114 | </div> |
|---|
| 115 | |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | <h3>Parameters</h3> |
|---|
| 120 | |
|---|
| 121 | |
|---|
| 122 | <h4 id="_ncdf_getatt_param_fileid">fileid |
|---|
| 123 | <span class="attr">in</span> |
|---|
| 124 | |
|---|
| 125 | |
|---|
| 126 | <span class="attr">required</span> |
|---|
| 127 | |
|---|
| 128 | <span class="attr">type:</span> <span class="value">salar string or long</span> |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | </h4> |
|---|
| 132 | |
|---|
| 133 | <div class="comments"> |
|---|
| 134 | if fileid is a scalar string then it is the name of the file (with |
|---|
| 135 | the full path) to be opened (in that case, the file will be opened |
|---|
| 136 | and closed within ncdf_getatt). |
|---|
| 137 | if fileid is a scalar long then it is the id of the file return by a call |
|---|
| 138 | to ncdf_open outside of ncdf_getatt (in that case, the file will |
|---|
| 139 | NOT be opened and closed within ncdf_getatt) |
|---|
| 140 | </div> |
|---|
| 141 | |
|---|
| 142 | <h4 id="_ncdf_getatt_param_varid">varid |
|---|
| 143 | <span class="attr">in</span> |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | <span class="attr">required</span> |
|---|
| 147 | |
|---|
| 148 | <span class="attr">type:</span> <span class="value">salar string or long</span> |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | </h4> |
|---|
| 152 | |
|---|
| 153 | <div class="comments"> |
|---|
| 154 | The netCDF variable ID, returned from a previous call to NCDF_VARDEF |
|---|
| 155 | or NCDF_VARID, or the name of the variable. |
|---|
| 156 | </div> |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | <h3>Keywords</h3> |
|---|
| 164 | |
|---|
| 165 | <h4 id="_ncdf_getatt_keyword_ADD_OFFSET">ADD_OFFSET |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | </h4> |
|---|
| 175 | |
|---|
| 176 | <div class="comments"> |
|---|
| 177 | Set this keyword to a named variable in which the value of |
|---|
| 178 | add_offset attribute is returned. Return 0. if this attribute |
|---|
| 179 | doesn't exist. |
|---|
| 180 | </div> |
|---|
| 181 | |
|---|
| 182 | <h4 id="_ncdf_getatt_keyword_SCALE_FACTOR">SCALE_FACTOR |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | </h4> |
|---|
| 192 | |
|---|
| 193 | <div class="comments"> |
|---|
| 194 | Set this keyword to a named variable in which the value of |
|---|
| 195 | scale_factor attribute is returned. Return 0. if this attribute |
|---|
| 196 | doesn't exist. |
|---|
| 197 | </div> |
|---|
| 198 | |
|---|
| 199 | <h4 id="_ncdf_getatt_keyword_MISSING_VALUE">MISSING_VALUE |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | </h4> |
|---|
| 209 | |
|---|
| 210 | <div class="comments"> |
|---|
| 211 | Set this keyword to a named variable in which the value of |
|---|
| 212 | missing_value or _fillvalue attribute is returned. Return the scalar |
|---|
| 213 | 'no' if this attribute doesn't exist. |
|---|
| 214 | </div> |
|---|
| 215 | |
|---|
| 216 | <h4 id="_ncdf_getatt_keyword_UNITS">UNITS |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | </h4> |
|---|
| 226 | |
|---|
| 227 | <div class="comments"> |
|---|
| 228 | Set this keyword to a named variable in which the value of |
|---|
| 229 | units attribute is returned. Return the empty string '' if this attribute |
|---|
| 230 | doesn't exist. |
|---|
| 231 | </div> |
|---|
| 232 | |
|---|
| 233 | <h4 id="_ncdf_getatt_keyword_CALENDAR">CALENDAR |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | |
|---|
| 241 | |
|---|
| 242 | </h4> |
|---|
| 243 | |
|---|
| 244 | <div class="comments"> |
|---|
| 245 | Set this keyword to a named variable in which the value of |
|---|
| 246 | calendar attribute is returned. Return the string 'greg' if this attribute |
|---|
| 247 | doesn't exist. |
|---|
| 248 | </div> |
|---|
| 249 | |
|---|
| 250 | <h4 id="_ncdf_getatt_keyword_LONG_NAME">LONG_NAME |
|---|
| 251 | |
|---|
| 252 | |
|---|
| 253 | |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | </h4> |
|---|
| 260 | |
|---|
| 261 | <div class="comments"> |
|---|
| 262 | Set this keyword to a named variable in which the value of |
|---|
| 263 | long_name is returned. Return empty string if this attribute |
|---|
| 264 | does not exist. |
|---|
| 265 | </div> |
|---|
| 266 | |
|---|
| 267 | <h4 id="_ncdf_getatt_keyword_STANDARD_NAME">STANDARD_NAME |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | |
|---|
| 276 | </h4> |
|---|
| 277 | |
|---|
| 278 | <div class="comments"> |
|---|
| 279 | Set this keyword to a named variable in which the value of |
|---|
| 280 | standard_name (CF convention) is returned. Return empty string |
|---|
| 281 | if this attribute does not exist. |
|---|
| 282 | </div> |
|---|
| 283 | |
|---|
| 284 | <h4 id="_ncdf_getatt_keyword_DOUBLE">DOUBLE |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | <span class="attr">type:</span> <span class="value">1 or 0</span> |
|---|
| 291 | <span class="attr">default:</span> <span class="value">0</span> |
|---|
| 292 | |
|---|
| 293 | </h4> |
|---|
| 294 | |
|---|
| 295 | <div class="comments"> |
|---|
| 296 | activate to force double-precision floating-point value of |
|---|
| 297 | add_offset and scale_factor |
|---|
| 298 | </div> |
|---|
| 299 | |
|---|
| 300 | <h4 id="_ncdf_getatt_keyword__extra">_extra |
|---|
| 301 | |
|---|
| 302 | |
|---|
| 303 | |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | </h4> |
|---|
| 310 | |
|---|
| 311 | <div class="comments"> |
|---|
| 312 | defined only to be able to call ncdf_getatt with the _extra keyword |
|---|
| 313 | </div> |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | |
|---|
| 317 | <h3>Examples</h3><div class="preformat"> |
|---|
| 318 | IDL> ncdf_getatt, cdfid, 'sst', add_offset = add_offset, scale_factor = scale_factor, units = units |
|---|
| 319 | </div> |
|---|
| 320 | <h3>Version history</h3> |
|---|
| 321 | |
|---|
| 322 | <h4>Version</h4><div class="preformat"> |
|---|
| 323 | $Id: ncdf_getatt.pro 334 2008-03-07 14:39:18Z smasson $ |
|---|
| 324 | </div> |
|---|
| 325 | <h4>History</h4><div class="preformat"> |
|---|
| 326 | August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 327 | </div> |
|---|
| 328 | |
|---|
| 329 | |
|---|
| 330 | |
|---|
| 331 | |
|---|
| 332 | |
|---|
| 333 | |
|---|
| 334 | |
|---|
| 335 | |
|---|
| 336 | |
|---|
| 337 | |
|---|
| 338 | |
|---|
| 339 | |
|---|
| 340 | |
|---|
| 341 | |
|---|
| 342 | |
|---|
| 343 | |
|---|
| 344 | <h3>Statistics</h3> |
|---|
| 345 | <table class="statistics"> |
|---|
| 346 | <tr><td>McCabe cyclic</td><td> 22</td></tr> |
|---|
| 347 | <tr><td>McCabe essential</td><td> 1</td></tr> |
|---|
| 348 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
|---|
| 349 | </table> |
|---|
| 350 | |
|---|
| 351 | |
|---|
| 352 | </div> |
|---|
| 353 | |
|---|
| 354 | </div> |
|---|
| 355 | |
|---|
| 356 | |
|---|
| 357 | |
|---|
| 358 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 359 | |
|---|
| 360 | </div> |
|---|
| 361 | |
|---|
| 362 | </body> |
|---|
| 363 | </html> |
|---|
