| 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_gettime.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_gettime.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_gettime.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 | <a href="ncdf_getmask.html"><<prev file</a> | <a href="read_grads.html">next file >></a> <a href="ncdf_gettime.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_gettime.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"> |
|---|
| 90 | get the time axis from a netcdf_file and transforms it in |
|---|
| 91 | Julian days of IDL. |
|---|
| 92 | </div> |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | <div id="routine_details"> |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | <div class="routine_details" id="_ncdf_gettime"> |
|---|
| 106 | |
|---|
| 107 | <h2><a class="top" href="#container">top</a>ncdf_gettime <span class="categories"> |
|---|
| 108 | Read NetCDF file |
|---|
| 109 | </span></h2> |
|---|
| 110 | |
|---|
| 111 | <p class="header"> |
|---|
| 112 | <span class="result">result = </span>ncdf_gettime(<span class="result"><a href="#_ncdf_gettime_param_filename">filename</a>[, <a href="#_ncdf_gettime_param_cdfid">cdfid</a>]</span>, <a href="#_ncdf_gettime_keyword_CALTYPE">CALTYPE</a>=<span class="result">CALTYPE</span>, <a href="#_ncdf_gettime_keyword_TIMEVAR">TIMEVAR</a>=<span class="result">string</span>, <a href="#_ncdf_gettime_keyword_CALLER">CALLER</a>=<span class="result">string</span>, <a href="#_ncdf_gettime_keyword_ERR">ERR</a>=<span class="result">ERR</span>, <a href="#_ncdf_gettime_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> |
|---|
| 113 | |
|---|
| 114 | <div class="comments"> |
|---|
| 115 | </div> |
|---|
| 116 | |
|---|
| 117 | <h3>Return value</h3><div class="preformat"> |
|---|
| 118 | a double 1D array of IDL Julian days |
|---|
| 119 | In case of error return -1 if the time dimension was not found |
|---|
| 120 | or return -jpt if it as been found that the time dimension size is jpt |
|---|
| 121 | </div> |
|---|
| 122 | |
|---|
| 123 | |
|---|
| 124 | <h3>Parameters</h3> |
|---|
| 125 | |
|---|
| 126 | |
|---|
| 127 | <h4 id="_ncdf_gettime_param_filename">filename |
|---|
| 128 | <span class="attr">in</span> |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | <span class="attr">required</span> |
|---|
| 132 | |
|---|
| 133 | <span class="attr">type:</span> <span class="value">scalar string</span> |
|---|
| 134 | |
|---|
| 135 | |
|---|
| 136 | </h4> |
|---|
| 137 | |
|---|
| 138 | <div class="comments"> |
|---|
| 139 | the name of the ncdf_file |
|---|
| 140 | </div> |
|---|
| 141 | |
|---|
| 142 | <h4 id="_ncdf_gettime_param_cdfid">cdfid |
|---|
| 143 | <span class="attr">in</span> |
|---|
| 144 | |
|---|
| 145 | <span class="attr">optional</span> |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | <span class="attr">type:</span> <span class="value">scalar</span> |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | </h4> |
|---|
| 152 | |
|---|
| 153 | <div class="comments"> |
|---|
| 154 | the ID of the ncdf_file, if the file is already open. |
|---|
| 155 | if not provided, ncdf_gettime open the file defined by filename |
|---|
| 156 | </div> |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | <h3>Keywords</h3> |
|---|
| 164 | |
|---|
| 165 | <h4 id="_ncdf_gettime_keyword_CALTYPE">CALTYPE |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | </h4> |
|---|
| 175 | |
|---|
| 176 | <div class="comments"> |
|---|
| 177 | Used to specify (or orverwrite) the type of calendar that should be |
|---|
| 178 | used. We accept only 'noleap', '360d', 'greg' and 'gregorian'. By |
|---|
| 179 | default, we use the type of calendar defied in the attibute |
|---|
| 180 | calendar. if not, we define it as gregorian. |
|---|
| 181 | </div> |
|---|
| 182 | |
|---|
| 183 | <h4 id="_ncdf_gettime_keyword_TIMEVAR">TIMEVAR |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | <span class="attr">type:</span> <span class="value">string</span> |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | </h4> |
|---|
| 193 | |
|---|
| 194 | <div class="comments"> |
|---|
| 195 | It define the name of the variable that |
|---|
| 196 | contains the time axis. This keyword can be useful if there |
|---|
| 197 | is no unlimited dimension or if the time axis selected by default |
|---|
| 198 | (the first 1D array with unlimited dimension) is not the good one. |
|---|
| 199 | </div> |
|---|
| 200 | |
|---|
| 201 | <h4 id="_ncdf_gettime_keyword_CALLER">CALLER |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | <span class="attr">required</span> |
|---|
| 206 | |
|---|
| 207 | <span class="attr">type:</span> <span class="value">string</span> |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | </h4> |
|---|
| 211 | |
|---|
| 212 | <div class="comments"> |
|---|
| 213 | Used to specify the error messages. Give the name of the calling |
|---|
| 214 | procedure. It can be only '<a href="..//ToBeReviewed/LECTURE/read_ncdf.html">read_ncdf</a>' or '<a href="..//ToBeReviewed/WIDGET/AUTOUR_de_XXX/scanfile.html">scanfile</a>'. |
|---|
| 215 | |
|---|
| 216 | </div> |
|---|
| 217 | |
|---|
| 218 | <h4 id="_ncdf_gettime_keyword_ERR">ERR |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | </h4> |
|---|
| 228 | |
|---|
| 229 | <div class="comments"> |
|---|
| 230 | Set this keyword to a named variable in which the value of the error |
|---|
| 231 | message will be returned |
|---|
| 232 | </div> |
|---|
| 233 | |
|---|
| 234 | <h4 id="_ncdf_gettime_keyword__EXTRA">_EXTRA |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | </h4> |
|---|
| 244 | |
|---|
| 245 | <div class="comments"> |
|---|
| 246 | _EXTRA to be able to call ncdf_getmask with _extra keyword |
|---|
| 247 | </div> |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | |
|---|
| 252 | <h3>Version history</h3> |
|---|
| 253 | |
|---|
| 254 | <h4>Version</h4><div class="preformat"> |
|---|
| 255 | $Id: ncdf_gettime.pro 401 2009-07-23 08:48:16Z smasson $</div> |
|---|
| 256 | <h4>History</h4><div class="preformat"> |
|---|
| 257 | August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 258 | </div> |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | <h3>Known issues</h3> |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | <h4>Restrictions</h4><div class="preformat"> |
|---|
| 266 | the calendar variable must have the units attribute |
|---|
| 267 | following the syntax below: |
|---|
| 268 | |
|---|
| 269 | time_counter:units = "seconds since 0001-01-01 00:00:00" ; |
|---|
| 270 | time_counter:units = "hours since 0001-01-01 00:00:00" ; |
|---|
| 271 | time_counter:units = "days since 1979-01-01 00:00:00" ; |
|---|
| 272 | time_counter:units = "months since 1979-01-01 00:00:00" ; |
|---|
| 273 | time_counter:units = "years since 1979-01-01 00:00:00" ; |
|---|
| 274 | </div> |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | |
|---|
| 284 | <h3>Statistics</h3> |
|---|
| 285 | <table class="statistics"> |
|---|
| 286 | <tr><td>McCabe cyclic</td><td> 51</td></tr> |
|---|
| 287 | <tr><td>McCabe essential</td><td> 1</td></tr> |
|---|
| 288 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
|---|
| 289 | </table> |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | </div> |
|---|
| 293 | |
|---|
| 294 | </div> |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 299 | |
|---|
| 300 | </div> |
|---|
| 301 | |
|---|
| 302 | </body> |
|---|
| 303 | </html> |
|---|
