[163] | 1 | |
---|
| 2 | |
---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
| 4 | <head> |
---|
| 5 | <title>initncdf.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=""><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="initncdfxxx.html"><img src="./../../next.gif" border="0" alt="Next"></a></td> |
---|
| 53 | </tr> |
---|
| 54 | </table> |
---|
| 55 | |
---|
| 56 | |
---|
| 57 | <h1><font size="-2">ToBeReviewed/INIT/</font></h1> |
---|
| 58 | <h2>initncdf.pro</h2> |
---|
| 59 | |
---|
| 60 | <dl> |
---|
| 61 | </dl> |
---|
| 62 | |
---|
| 63 | |
---|
| 64 | Initfile for Netcdf file. define all the grid parameters |
---|
| 65 | |
---|
| 66 | |
---|
| 67 | |
---|
| 68 | |
---|
| 69 | |
---|
| 70 | <a name="#_initncdf"></a> |
---|
| 71 | |
---|
| 72 | <h2>initncdf <font size="-1" color="#006633"> |
---|
| 73 | |
---|
| 74 | </font></h2> |
---|
| 75 | |
---|
| 76 | <p><font face="Courier">initncdf<i>, <a href="#_initncdf_keyword_ncfilein">ncfilein</a></i>, <a href="#_initncdf_keyword_XAXISNAME">XAXISNAME</a>=<i>string</i>, <a href="#_initncdf_keyword_YAXISNAME">YAXISNAME</a>=<i>string</i>, <a href="#_initncdf_keyword_ZAXISNAME">ZAXISNAME</a>=<i>string</i>, <a href="#_initncdf_keyword_MASKNAME">MASKNAME</a>=<i>string</i>, <a href="#_initncdf_keyword_INVMASK">INVMASK</a>=<i>INVMASK</i>, <a href="#_initncdf_keyword_USEASMASK">USEASMASK</a>=<i>string</i>, <a href="#_initncdf_keyword_MISSING_VALUE">MISSING_VALUE</a>=<i>MISSING_VALUE</i>, <a href="#_initncdf_keyword_START1">START1</a>=<i>START1</i>, <a href="#_initncdf_keyword_XYINDEX">XYINDEX</a>=<i>XYINDEX</i>, <a href="#_initncdf_keyword_ZINDEX">ZINDEX</a>=<i>ZINDEX</i>, <a href="#_initncdf_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p> |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | |
---|
| 80 | |
---|
| 81 | |
---|
| 82 | |
---|
| 83 | |
---|
| 84 | <h3>Parameters</h3> |
---|
| 85 | |
---|
| 86 | |
---|
| 87 | <a name="#_initncdf_keyword_ncfilein"></a> |
---|
| 88 | <h4>ncfilein |
---|
| 89 | <font size="-1" color="#006633">in</font> |
---|
| 90 | |
---|
| 91 | |
---|
| 92 | <font size="-1" color="#006633">required</font> |
---|
| 93 | |
---|
| 94 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | </h4> |
---|
| 98 | |
---|
| 99 | |
---|
| 100 | A string giving the name of the NetCdf file |
---|
| 101 | |
---|
| 102 | |
---|
| 103 | |
---|
| 104 | |
---|
| 105 | |
---|
| 106 | <h3>Keywords</h3> |
---|
| 107 | |
---|
| 108 | |
---|
| 109 | <a name="#_initncdf_keyword_XAXISNAME"></a> |
---|
| 110 | <h4>XAXISNAME |
---|
| 111 | |
---|
| 112 | |
---|
| 113 | |
---|
| 114 | |
---|
| 115 | |
---|
| 116 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> |
---|
| 117 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'x', 'longitude', 'nav_lon' or 'lon'</i></font> |
---|
| 118 | |
---|
| 119 | </h4> |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | A string giving the name of the variable in the file |
---|
| 123 | that contains the [xyz]axis. |
---|
| 124 | |
---|
| 125 | |
---|
| 126 | <a name="#_initncdf_keyword_YAXISNAME"></a> |
---|
| 127 | <h4>YAXISNAME |
---|
| 128 | |
---|
| 129 | |
---|
| 130 | |
---|
| 131 | |
---|
| 132 | |
---|
| 133 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> |
---|
| 134 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'y', 'latitude', 'nav_lat' or 'lat'</i></font> |
---|
| 135 | |
---|
| 136 | </h4> |
---|
| 137 | |
---|
| 138 | |
---|
| 139 | A string giving the name of the variable in the file |
---|
| 140 | that contains the [xyz]axis. |
---|
| 141 | |
---|
| 142 | |
---|
| 143 | <a name="#_initncdf_keyword_ZAXISNAME"></a> |
---|
| 144 | <h4>ZAXISNAME |
---|
| 145 | |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> |
---|
| 151 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'z', 'level', 'lev', 'depth...'</i></font> |
---|
| 152 | |
---|
| 153 | </h4> |
---|
| 154 | |
---|
| 155 | |
---|
| 156 | A string giving the name of the variable in the file |
---|
| 157 | that contains the [xyz]axis. |
---|
| 158 | |
---|
| 159 | |
---|
| 160 | <a name="#_initncdf_keyword_MASKNAME"></a> |
---|
| 161 | <h4>MASKNAME |
---|
| 162 | |
---|
| 163 | |
---|
| 164 | |
---|
| 165 | |
---|
| 166 | |
---|
| 167 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> |
---|
| 168 | |
---|
| 169 | |
---|
| 170 | </h4> |
---|
| 171 | |
---|
| 172 | |
---|
| 173 | A string giving the name of the variable in the file |
---|
| 174 | that contains the land/sea mask |
---|
| 175 | |
---|
| 176 | |
---|
| 177 | <a name="#_initncdf_keyword_INVMASK"></a> |
---|
| 178 | <h4>INVMASK |
---|
| 179 | |
---|
| 180 | |
---|
| 181 | |
---|
| 182 | |
---|
| 183 | |
---|
| 184 | |
---|
| 185 | |
---|
| 186 | |
---|
| 187 | </h4> |
---|
| 188 | |
---|
| 189 | |
---|
| 190 | To inverse the mask: mask = 1-mask |
---|
| 191 | |
---|
| 192 | |
---|
| 193 | <a name="#_initncdf_keyword_USEASMASK"></a> |
---|
| 194 | <h4>USEASMASK |
---|
| 195 | |
---|
| 196 | |
---|
| 197 | |
---|
| 198 | |
---|
| 199 | |
---|
| 200 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> |
---|
| 201 | |
---|
| 202 | |
---|
| 203 | </h4> |
---|
| 204 | |
---|
| 205 | |
---|
| 206 | A string giving the name of the variable in the file |
---|
| 207 | that will be used to build the land/sea mask. In this case the |
---|
| 208 | mask is based on the first record (if record dimension |
---|
| 209 | exists). The mask is build according to : |
---|
| 210 | 1 the keyword missing_value if existing |
---|
| 211 | 2 the attribute 'missing_value' if existing |
---|
| 212 | 3 NaN values if existing |
---|
| 213 | |
---|
| 214 | |
---|
| 215 | <a name="#_initncdf_keyword_MISSING_VALUE"></a> |
---|
| 216 | <h4>MISSING_VALUE |
---|
| 217 | |
---|
| 218 | |
---|
| 219 | |
---|
| 220 | |
---|
| 221 | |
---|
| 222 | |
---|
| 223 | |
---|
| 224 | |
---|
| 225 | </h4> |
---|
| 226 | |
---|
| 227 | |
---|
| 228 | To define (or redefine if the attribute is |
---|
| 229 | already existing) the missing values used with USEASMASK |
---|
| 230 | keyword |
---|
| 231 | |
---|
| 232 | |
---|
| 233 | <a name="#_initncdf_keyword_START1"></a> |
---|
| 234 | <h4>START1 |
---|
| 235 | |
---|
| 236 | |
---|
| 237 | |
---|
| 238 | |
---|
| 239 | |
---|
| 240 | |
---|
| 241 | |
---|
| 242 | |
---|
| 243 | </h4> |
---|
| 244 | |
---|
| 245 | |
---|
| 246 | Index the axis from 1 instead of 0 when using |
---|
| 247 | /xyindex and/or zindex |
---|
| 248 | |
---|
| 249 | |
---|
| 250 | <a name="#_initncdf_keyword_XYINDEX"></a> |
---|
| 251 | <h4>XYINDEX |
---|
| 252 | |
---|
| 253 | |
---|
| 254 | |
---|
| 255 | |
---|
| 256 | |
---|
| 257 | |
---|
| 258 | |
---|
| 259 | |
---|
| 260 | </h4> |
---|
| 261 | |
---|
| 262 | |
---|
| 263 | To define the x/y axis with index instead of using |
---|
| 264 | the values contained in X/YAXISNAME. |
---|
| 265 | x/yaxis = keyword_set(start1) + findgen(jpi/jpj) |
---|
| 266 | this forces key_onearth = 0 |
---|
| 267 | |
---|
| 268 | |
---|
| 269 | <a name="#_initncdf_keyword_ZINDEX"></a> |
---|
| 270 | <h4>ZINDEX |
---|
| 271 | |
---|
| 272 | |
---|
| 273 | |
---|
| 274 | |
---|
| 275 | |
---|
| 276 | |
---|
| 277 | |
---|
| 278 | |
---|
| 279 | </h4> |
---|
| 280 | |
---|
| 281 | |
---|
| 282 | To define the z axis with index instead of using |
---|
| 283 | the values contained in ZAXISNAME. |
---|
| 284 | zaxis = keyword_set(start1) + findgen(jpk) |
---|
| 285 | |
---|
| 286 | |
---|
| 287 | <a name="#_initncdf_keyword__EXTRA"></a> |
---|
| 288 | <h4>_EXTRA |
---|
| 289 | |
---|
| 290 | |
---|
| 291 | |
---|
| 292 | |
---|
| 293 | |
---|
| 294 | |
---|
| 295 | |
---|
| 296 | |
---|
| 297 | </h4> |
---|
| 298 | |
---|
| 299 | |
---|
| 300 | Used to pass your keywords/ |
---|
| 301 | |
---|
| 302 | |
---|
| 303 | |
---|
| 304 | |
---|
| 305 | <h3>Examples</h3> |
---|
| 306 | IDL> initncdf,'toto.nc',glam=[-180,180] |
---|
| 307 | |
---|
| 308 | <h3>Version history</h3> |
---|
| 309 | |
---|
| 310 | <h4>Version</h4> |
---|
| 311 | $Id: initncdf.pro 157 2006-08-21 09:01:50Z navarro $ |
---|
| 312 | |
---|
| 313 | <h4>History</h4> |
---|
| 314 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
| 315 | 8 May 2002 |
---|
| 316 | |
---|
| 317 | |
---|
| 318 | |
---|
| 319 | <h3>Known issues</h3> |
---|
| 320 | |
---|
| 321 | |
---|
| 322 | |
---|
| 323 | <h4>Restrictions</h4> |
---|
| 324 | Change the grid parameters of the common.pro |
---|
| 325 | |
---|
| 326 | |
---|
| 327 | the file must contain an x and an y axis. (1 ou 2 dimentional array) |
---|
| 328 | |
---|
| 329 | |
---|
| 330 | <h3>Other attributes</h3> |
---|
| 331 | |
---|
| 332 | |
---|
| 333 | <h4>Uses routines</h4> |
---|
| 334 | common.pro |
---|
| 335 | |
---|
| 336 | |
---|
| 337 | |
---|
| 338 | |
---|
| 339 | |
---|
| 340 | <font size="-3"><p> </p></font> |
---|
| 341 | <hr size="1" color="#CCCCCC"/> |
---|
| 342 | |
---|
| 343 | |
---|
| 344 | |
---|
| 345 | |
---|
| 346 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0 on Tue Aug 29 14:50:00 2006.</font></p> |
---|
| 347 | |
---|
| 348 | </body> |
---|
| 349 | </html> |
---|