| 1 | |
|---|
| 2 | |
|---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 4 | <head> |
|---|
| 5 | <title>ncdf_getaxis.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="ncdf_timeget.html"><img src="./../next.gif" border="0" alt="Next"></a></td> |
|---|
| 53 | </tr> |
|---|
| 54 | </table> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <h1><font size="-2">ReadWrite/</font></h1> |
|---|
| 58 | <h2>ncdf_getaxis.pro</h2> |
|---|
| 59 | |
|---|
| 60 | <dl> |
|---|
| 61 | </dl> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | get the x/y dimension Id and x/y axes from a netcdf file |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | <a name="#_ncdf_getaxis"></a> |
|---|
| 71 | |
|---|
| 72 | <h2>ncdf_getaxis <font size="-1" color="#006633"> |
|---|
| 73 | Reading |
|---|
| 74 | </font></h2> |
|---|
| 75 | |
|---|
| 76 | <p><font face="Courier">ncdf_getaxis<i>, <a href="#_ncdf_getaxis_keyword_cdfid">cdfid</a>, <a href="#_ncdf_getaxis_keyword_dimidx">dimidx</a>, <a href="#_ncdf_getaxis_keyword_dimidy">dimidy</a>, <a href="#_ncdf_getaxis_keyword_xaxis">xaxis</a>, <a href="#_ncdf_getaxis_keyword_yaxis">yaxis</a></i>, <a href="#_ncdf_getaxis_keyword_XAXISNAME">XAXISNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_YAXISNAME">YAXISNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_XDIMNAME">XDIMNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_YDIMNAME">YDIMNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_XYINDEX">XYINDEX</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getaxis_keyword_START1">START1</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getaxis_keyword_ROMSGRID">ROMSGRID</a>=<i>variable</i>, <a href="#_ncdf_getaxis_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="#_ncdf_getaxis_keyword_cdfid"></a> |
|---|
| 88 | <h4>cdfid |
|---|
| 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>scalar</i></font> |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | </h4> |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | the id of the netcdf file |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | <a name="#_ncdf_getaxis_keyword_dimidx"></a> |
|---|
| 105 | <h4>dimidx |
|---|
| 106 | |
|---|
| 107 | <font size="-1" color="#006633">out</font> |
|---|
| 108 | |
|---|
| 109 | |
|---|
| 110 | |
|---|
| 111 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar (long)</i></font> |
|---|
| 112 | |
|---|
| 113 | |
|---|
| 114 | </h4> |
|---|
| 115 | |
|---|
| 116 | |
|---|
| 117 | id of the x dimension |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | |
|---|
| 121 | <a name="#_ncdf_getaxis_keyword_dimidy"></a> |
|---|
| 122 | <h4>dimidy |
|---|
| 123 | |
|---|
| 124 | <font size="-1" color="#006633">out</font> |
|---|
| 125 | |
|---|
| 126 | |
|---|
| 127 | |
|---|
| 128 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar (long)</i></font> |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | </h4> |
|---|
| 132 | |
|---|
| 133 | |
|---|
| 134 | id of the y dimension |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | |
|---|
| 138 | <a name="#_ncdf_getaxis_keyword_xaxis"></a> |
|---|
| 139 | <h4>xaxis |
|---|
| 140 | |
|---|
| 141 | <font size="-1" color="#006633">out</font> |
|---|
| 142 | |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1D or 2D array</i></font> |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | </h4> |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | the x axis |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | <a name="#_ncdf_getaxis_keyword_yaxis"></a> |
|---|
| 156 | <h4>yaxis |
|---|
| 157 | |
|---|
| 158 | <font size="-1" color="#006633">out</font> |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1D or 2D array</i></font> |
|---|
| 163 | |
|---|
| 164 | |
|---|
| 165 | </h4> |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | the y axis |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | <h3>Keywords</h3> |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | <a name="#_ncdf_getaxis_keyword_XAXISNAME"></a> |
|---|
| 178 | <h4>XAXISNAME |
|---|
| 179 | |
|---|
| 180 | |
|---|
| 181 | |
|---|
| 182 | |
|---|
| 183 | |
|---|
| 184 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> |
|---|
| 185 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'</i></font> |
|---|
| 186 | |
|---|
| 187 | </h4> |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | A string giving the name of the variable in the file |
|---|
| 191 | that contains the [xyz]axis. |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | <a name="#_ncdf_getaxis_keyword_YAXISNAME"></a> |
|---|
| 195 | <h4>YAXISNAME |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> |
|---|
| 202 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'</i></font> |
|---|
| 203 | |
|---|
| 204 | </h4> |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | A string giving the name of the variable in the file |
|---|
| 208 | that contains the [xyz]axis. |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | <a name="#_ncdf_getaxis_keyword_XDIMNAME"></a> |
|---|
| 212 | <h4>XDIMNAME |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> |
|---|
| 219 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'longitude', 'lon', 'x', 'longitude*', 'lon*', 'x*', '*longitude*', '*lon*' or '*x*'</i></font> |
|---|
| 220 | |
|---|
| 221 | </h4> |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | A string giving the name of the x dimension |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | <a name="#_ncdf_getaxis_keyword_YDIMNAME"></a> |
|---|
| 228 | <h4>YDIMNAME |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> |
|---|
| 235 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'latitude', 'lat', 'y', 'latitude*', 'lat*', 'y*', 'eta_*', '*latitude*', '*lat*', '*y*'</i></font> |
|---|
| 236 | |
|---|
| 237 | </h4> |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | A string giving the name of the y dimension |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | <a name="#_ncdf_getaxis_keyword_XYINDEX"></a> |
|---|
| 244 | <h4>XYINDEX |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> |
|---|
| 251 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> |
|---|
| 252 | |
|---|
| 253 | </h4> |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | To define the x/y axis with index instead of using |
|---|
| 257 | the values contained in X/YAXISNAME. |
|---|
| 258 | x/yaxis = keyword_set(start1) + findgen(jpi/jpj) |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | <a name="#_ncdf_getaxis_keyword_START1"></a> |
|---|
| 264 | <h4>START1 |
|---|
| 265 | |
|---|
| 266 | |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> |
|---|
| 271 | <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> |
|---|
| 272 | |
|---|
| 273 | </h4> |
|---|
| 274 | |
|---|
| 275 | |
|---|
| 276 | Index the axis from 1 instead of 0 when using /xyindex |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | <a name="#_ncdf_getaxis_keyword_ROMSGRID"></a> |
|---|
| 280 | <h4>ROMSGRID |
|---|
| 281 | |
|---|
| 282 | <font size="-1" color="#006633">out</font> |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | |
|---|
| 286 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | </h4> |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | gives back if we are using a ROMS grid (1) or not (0) |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | <a name="#_ncdf_getaxis_keyword__EXTRA"></a> |
|---|
| 296 | <h4>_EXTRA |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | |
|---|
| 303 | |
|---|
| 304 | |
|---|
| 305 | </h4> |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | Used to be able to call ncdf_getaxis with _extra |
|---|
| 309 | |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | |
|---|
| 314 | </pre><h3>Version history</h3> |
|---|
| 315 | |
|---|
| 316 | <h4>Version</h4> |
|---|
| 317 | $Id: ncdf_getaxis.pro 232 2007-03-20 16:59:36Z pinsard $ |
|---|
| 318 | <h4>History</h4> |
|---|
| 319 | March 2007: Sebastien Masson (smasson@locean-ipsl.upmc.fr) |
|---|
| 320 | |
|---|
| 321 | |
|---|
| 322 | |
|---|
| 323 | |
|---|
| 324 | |
|---|
| 325 | |
|---|
| 326 | |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | |
|---|
| 330 | |
|---|
| 331 | |
|---|
| 332 | |
|---|
| 333 | |
|---|
| 334 | |
|---|
| 335 | |
|---|
| 336 | |
|---|
| 337 | |
|---|
| 338 | <font size="-3"><p> </p></font> |
|---|
| 339 | <hr size="1" color="#CCCCCC"/> |
|---|
| 340 | |
|---|
| 341 | |
|---|
| 342 | |
|---|
| 343 | |
|---|
| 344 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
|---|
| 345 | |
|---|
| 346 | </body> |
|---|
| 347 | </html> |
|---|
