[89] | 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> |
---|
[104] | 9 | <title>initncdf.pro (SAXO Documentation)</title> |
---|
[89] | 10 | |
---|
| 11 | |
---|
[191] | 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" /> |
---|
[89] | 14 | |
---|
| 15 | |
---|
| 16 | <script type="text/javascript"> |
---|
| 17 | function setTitle() { |
---|
[104] | 18 | parent.document.title="initncdf.pro (SAXO Documentation)"; |
---|
[89] | 19 | } |
---|
| 20 | </script> |
---|
| 21 | </head> |
---|
| 22 | |
---|
| 23 | <body onload="setTitle();"> |
---|
| 24 | |
---|
| 25 | <div id="navbar_title"> |
---|
[104] | 26 | <h1>SAXO Documentation</h1> |
---|
[89] | 27 | </div> |
---|
| 28 | |
---|
| 29 | |
---|
| 30 | <div id="main_navbar"> |
---|
| 31 | |
---|
| 32 | <table cellspacing="0"> |
---|
| 33 | <tr> |
---|
| 34 | |
---|
[189] | 35 | <td><a href="./../../overview.html" title="Overview of library">Overview</a></td> |
---|
[89] | 36 | |
---|
| 37 | |
---|
| 38 | |
---|
| 39 | <td >Directory</td> |
---|
| 40 | |
---|
| 41 | |
---|
| 42 | |
---|
[189] | 43 | <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td> |
---|
[89] | 44 | |
---|
| 45 | |
---|
| 46 | |
---|
[189] | 47 | <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td> |
---|
[89] | 48 | |
---|
| 49 | |
---|
| 50 | |
---|
[189] | 51 | <td><a href="./../../search-page.html" title="Search library">Search</a></td> |
---|
[89] | 52 | |
---|
| 53 | |
---|
| 54 | <td id="selected">File</td> |
---|
| 55 | |
---|
| 56 | |
---|
[189] | 57 | <td><a href="../../../../ToBeReviewed/INIT//initncdf.pro" title="Source code of a file">Source</a></td> |
---|
[89] | 58 | |
---|
| 59 | |
---|
| 60 | |
---|
[189] | 61 | <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td> |
---|
[89] | 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 | |
---|
[189] | 74 | << prev file | <a href="initncdfxxx.html">next file >></a> <a href="initncdf.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> |
---|
[89] | 75 | |
---|
| 76 | </div> |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | <div id="container"> |
---|
| 80 | |
---|
[189] | 81 | <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/INIT/</a></h1> |
---|
[89] | 82 | <h2 class="pro_file">initncdf.pro</h2> |
---|
| 83 | |
---|
| 84 | <div id="file_attr"> |
---|
| 85 | <dl> |
---|
| 86 | </dl> |
---|
| 87 | </div> |
---|
| 88 | |
---|
[142] | 89 | <div id="file_comments"> |
---|
[177] | 90 | Initfile for Netcdf file. define all the grid parameters through |
---|
| 91 | an appropriate call to computegid |
---|
[142] | 92 | </div> |
---|
[89] | 93 | |
---|
| 94 | |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | |
---|
| 98 | |
---|
| 99 | |
---|
| 100 | |
---|
| 101 | |
---|
| 102 | <div id="routine_details"> |
---|
| 103 | |
---|
| 104 | |
---|
| 105 | <div class="routine_details" id="_initncdf"> |
---|
| 106 | |
---|
[142] | 107 | <h2><a class="top" href="#container">top</a>initncdf <span class="categories"> |
---|
[177] | 108 | Grid |
---|
[142] | 109 | </span></h2> |
---|
[89] | 110 | |
---|
| 111 | <p class="header"> |
---|
[177] | 112 | initncdf<span class="result">, <a href="#_initncdf_param_ncfilein">ncfilein</a></span>, <a href="#_initncdf_keyword_XAXISNAME">XAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_initncdf_keyword_YAXISNAME">YAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_initncdf_keyword_ZAXISNAME">ZAXISNAME</a>=<span class="result">scalar string</span>, <a href="#_initncdf_keyword_MASKNAME">MASKNAME</a>=<span class="result">string</span>, <a href="#_initncdf_keyword_INVMASK">INVMASK</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_initncdf_keyword_USEASMASK">USEASMASK</a>=<span class="result">scalar string</span>, <a href="#_initncdf_keyword_MISSING_VALUE">MISSING_VALUE</a>=<span class="result">scalar</span>, <a href="#_initncdf_keyword_START1">START1</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_initncdf_keyword_XYINDEX">XYINDEX</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_initncdf_keyword_ZINDEX">ZINDEX</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_initncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> |
---|
[89] | 113 | |
---|
| 114 | <div class="comments"> |
---|
| 115 | </div> |
---|
| 116 | |
---|
| 117 | |
---|
| 118 | |
---|
| 119 | |
---|
| 120 | <h3>Parameters</h3> |
---|
| 121 | |
---|
| 122 | |
---|
| 123 | <h4 id="_initncdf_param_ncfilein">ncfilein |
---|
[142] | 124 | <span class="attr">in</span> |
---|
[89] | 125 | |
---|
| 126 | |
---|
[142] | 127 | <span class="attr">required</span> |
---|
[89] | 128 | |
---|
[177] | 129 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
[89] | 130 | |
---|
| 131 | |
---|
| 132 | </h4> |
---|
| 133 | |
---|
[142] | 134 | <div class="comments"> |
---|
| 135 | A string giving the name of the NetCdf file |
---|
| 136 | </div> |
---|
[89] | 137 | |
---|
| 138 | |
---|
| 139 | |
---|
| 140 | |
---|
| 141 | |
---|
| 142 | |
---|
| 143 | <h3>Keywords</h3> |
---|
| 144 | |
---|
| 145 | <h4 id="_initncdf_keyword_XAXISNAME">XAXISNAME |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | |
---|
[177] | 151 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 152 | <span class="attr">default:</span> <span class="value">'x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'</span> |
---|
[89] | 153 | |
---|
| 154 | </h4> |
---|
| 155 | |
---|
[142] | 156 | <div class="comments"> |
---|
| 157 | A string giving the name of the variable in the file |
---|
| 158 | that contains the [xyz]axis. |
---|
| 159 | </div> |
---|
[89] | 160 | |
---|
| 161 | <h4 id="_initncdf_keyword_YAXISNAME">YAXISNAME |
---|
| 162 | |
---|
| 163 | |
---|
| 164 | |
---|
| 165 | |
---|
| 166 | |
---|
[177] | 167 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 168 | <span class="attr">default:</span> <span class="value">'y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'</span> |
---|
[89] | 169 | |
---|
| 170 | </h4> |
---|
| 171 | |
---|
[142] | 172 | <div class="comments"> |
---|
| 173 | A string giving the name of the variable in the file |
---|
| 174 | that contains the [xyz]axis. |
---|
| 175 | </div> |
---|
[89] | 176 | |
---|
| 177 | <h4 id="_initncdf_keyword_ZAXISNAME">ZAXISNAME |
---|
| 178 | |
---|
| 179 | |
---|
| 180 | |
---|
| 181 | |
---|
| 182 | |
---|
[177] | 183 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
[163] | 184 | <span class="attr">default:</span> <span class="value">'z', 'level', 'lev', 'depth...'</span> |
---|
[89] | 185 | |
---|
| 186 | </h4> |
---|
| 187 | |
---|
[142] | 188 | <div class="comments"> |
---|
| 189 | A string giving the name of the variable in the file |
---|
| 190 | that contains the [xyz]axis. |
---|
| 191 | </div> |
---|
[89] | 192 | |
---|
| 193 | <h4 id="_initncdf_keyword_MASKNAME">MASKNAME |
---|
| 194 | |
---|
| 195 | |
---|
| 196 | |
---|
| 197 | |
---|
| 198 | |
---|
[163] | 199 | <span class="attr">type:</span> <span class="value">string</span> |
---|
[89] | 200 | |
---|
| 201 | |
---|
| 202 | </h4> |
---|
| 203 | |
---|
[142] | 204 | <div class="comments"> |
---|
| 205 | A string giving the name of the variable in the file |
---|
| 206 | that contains the land/sea mask |
---|
| 207 | </div> |
---|
[89] | 208 | |
---|
| 209 | <h4 id="_initncdf_keyword_INVMASK">INVMASK |
---|
| 210 | |
---|
| 211 | |
---|
| 212 | |
---|
| 213 | |
---|
| 214 | |
---|
[177] | 215 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
---|
| 216 | <span class="attr">default:</span> <span class="value">0</span> |
---|
[89] | 217 | |
---|
| 218 | </h4> |
---|
| 219 | |
---|
[142] | 220 | <div class="comments"> |
---|
[177] | 221 | Inverse the land/sea mask (that should have 0/1 values for land/sea): mask = 1-mask |
---|
[142] | 222 | </div> |
---|
[89] | 223 | |
---|
| 224 | <h4 id="_initncdf_keyword_USEASMASK">USEASMASK |
---|
| 225 | |
---|
| 226 | |
---|
| 227 | |
---|
| 228 | |
---|
| 229 | |
---|
[177] | 230 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
[89] | 231 | |
---|
| 232 | |
---|
| 233 | </h4> |
---|
| 234 | |
---|
[142] | 235 | <div class="comments"> |
---|
| 236 | A string giving the name of the variable in the file |
---|
| 237 | that will be used to build the land/sea mask. In this case the |
---|
| 238 | mask is based on the first record (if record dimension |
---|
| 239 | exists). The mask is build according to : |
---|
| 240 | 1 the keyword missing_value if existing |
---|
| 241 | 2 the attribute 'missing_value' if existing |
---|
| 242 | 3 NaN values if existing |
---|
| 243 | </div> |
---|
[89] | 244 | |
---|
| 245 | <h4 id="_initncdf_keyword_MISSING_VALUE">MISSING_VALUE |
---|
| 246 | |
---|
| 247 | |
---|
| 248 | |
---|
| 249 | |
---|
| 250 | |
---|
[177] | 251 | <span class="attr">type:</span> <span class="value">scalar</span> |
---|
[89] | 252 | |
---|
| 253 | |
---|
| 254 | </h4> |
---|
| 255 | |
---|
[142] | 256 | <div class="comments"> |
---|
[163] | 257 | To define (or redefine if the attribute is |
---|
[142] | 258 | already existing) the missing values used with USEASMASK |
---|
| 259 | keyword |
---|
| 260 | </div> |
---|
[89] | 261 | |
---|
| 262 | <h4 id="_initncdf_keyword_START1">START1 |
---|
| 263 | |
---|
| 264 | |
---|
| 265 | |
---|
| 266 | |
---|
| 267 | |
---|
[177] | 268 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
---|
| 269 | <span class="attr">default:</span> <span class="value">0</span> |
---|
[89] | 270 | |
---|
| 271 | </h4> |
---|
| 272 | |
---|
[142] | 273 | <div class="comments"> |
---|
| 274 | Index the axis from 1 instead of 0 when using |
---|
| 275 | /xyindex and/or zindex |
---|
| 276 | </div> |
---|
[89] | 277 | |
---|
| 278 | <h4 id="_initncdf_keyword_XYINDEX">XYINDEX |
---|
| 279 | |
---|
| 280 | |
---|
| 281 | |
---|
| 282 | |
---|
| 283 | |
---|
[177] | 284 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
---|
| 285 | <span class="attr">default:</span> <span class="value">0</span> |
---|
[89] | 286 | |
---|
| 287 | </h4> |
---|
| 288 | |
---|
[142] | 289 | <div class="comments"> |
---|
| 290 | To define the x/y axis with index instead of using |
---|
| 291 | the values contained in X/YAXISNAME. |
---|
| 292 | x/yaxis = keyword_set(start1) + findgen(jpi/jpj) |
---|
| 293 | this forces key_onearth = 0 |
---|
| 294 | </div> |
---|
[89] | 295 | |
---|
| 296 | <h4 id="_initncdf_keyword_ZINDEX">ZINDEX |
---|
| 297 | |
---|
| 298 | |
---|
| 299 | |
---|
| 300 | |
---|
| 301 | |
---|
[177] | 302 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
---|
| 303 | <span class="attr">default:</span> <span class="value">0</span> |
---|
[89] | 304 | |
---|
| 305 | </h4> |
---|
| 306 | |
---|
[142] | 307 | <div class="comments"> |
---|
| 308 | To define the z axis with index instead of using |
---|
| 309 | the values contained in ZAXISNAME. |
---|
| 310 | zaxis = keyword_set(start1) + findgen(jpk) |
---|
| 311 | </div> |
---|
[89] | 312 | |
---|
| 313 | <h4 id="_initncdf_keyword__EXTRA">_EXTRA |
---|
| 314 | |
---|
| 315 | |
---|
| 316 | |
---|
| 317 | |
---|
| 318 | |
---|
| 319 | |
---|
| 320 | |
---|
| 321 | |
---|
| 322 | </h4> |
---|
| 323 | |
---|
[142] | 324 | <div class="comments"> |
---|
[177] | 325 | Used to pass keywords to computegrid |
---|
[142] | 326 | </div> |
---|
[89] | 327 | |
---|
| 328 | |
---|
| 329 | |
---|
[142] | 330 | <h3>Examples</h3><div class="preformat"> |
---|
| 331 | IDL> initncdf,'toto.nc',glam=[-180,180] |
---|
| 332 | </div> |
---|
| 333 | <h3>Version history</h3> |
---|
[89] | 334 | |
---|
[142] | 335 | <h4>Version</h4><div class="preformat"> |
---|
[195] | 336 | $Id: initncdf.pro 192 2006-09-22 09:37:08Z smasson $ |
---|
[142] | 337 | </div> |
---|
[157] | 338 | <h4>History</h4><div class="preformat"> |
---|
| 339 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
| 340 | 8 May 2002 |
---|
| 341 | </div> |
---|
[89] | 342 | |
---|
| 343 | |
---|
[142] | 344 | <h3>Known issues</h3> |
---|
[89] | 345 | |
---|
| 346 | |
---|
| 347 | |
---|
[142] | 348 | <h4>Restrictions</h4><div class="preformat"> |
---|
[177] | 349 | Change the grid parameters (see computegrid) |
---|
[142] | 350 | |
---|
| 351 | |
---|
| 352 | the file must contain an x and an y axis. (1 ou 2 dimentional array) |
---|
| 353 | </div> |
---|
[89] | 354 | |
---|
[142] | 355 | <h3>Other attributes</h3> |
---|
[89] | 356 | |
---|
| 357 | |
---|
[142] | 358 | <h4>Uses routines</h4><div class="preformat"> |
---|
| 359 | common.pro |
---|
| 360 | </div> |
---|
[89] | 361 | |
---|
| 362 | |
---|
| 363 | |
---|
| 364 | |
---|
[163] | 365 | <h3>Statistics</h3> |
---|
| 366 | <table class="statistics"> |
---|
[177] | 367 | <tr><td>McCabe cyclic</td><td> 64</td></tr> |
---|
[163] | 368 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
| 369 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
| 370 | </table> |
---|
[89] | 371 | |
---|
| 372 | |
---|
| 373 | </div> |
---|
| 374 | |
---|
| 375 | </div> |
---|
| 376 | |
---|
| 377 | |
---|
| 378 | |
---|
| 379 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 380 | |
---|
| 381 | </div> |
---|
| 382 | |
---|
| 383 | </body> |
---|
| 384 | </html> |
---|