| 1 | |
|---|
| 2 | |
|---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 4 | <head> |
|---|
| 5 | <title>get_gridparams.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="fromreg.html"><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="imoms3.html"><img src="./../next.gif" border="0" alt="Next"></a></td> |
|---|
| 53 | </tr> |
|---|
| 54 | </table> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <h1><font size="-2">Interpolation/</font></h1> |
|---|
| 58 | <h2>get_gridparams.pro</h2> |
|---|
| 59 | |
|---|
| 60 | <dl> |
|---|
| 61 | </dl> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | 1) extract from a NetCDF file the longitude, latitude, and their dimensions |
|---|
| 65 | and make sure it is 1D or 2D arrays |
|---|
| 66 | |
|---|
| 67 | or |
|---|
| 68 | 2) given longitude and latitude arrays get their dimensions and make |
|---|
| 69 | sure they are 1D or 2D arrays |
|---|
| 70 | |
|---|
| 71 | |
|---|
| 72 | |
|---|
| 73 | |
|---|
| 74 | |
|---|
| 75 | <a name="#_get_gridparams"></a> |
|---|
| 76 | |
|---|
| 77 | <h2>get_gridparams <font size="-1" color="#006633"> |
|---|
| 78 | Interpolation |
|---|
| 79 | </font></h2> |
|---|
| 80 | |
|---|
| 81 | <p><font face="Courier">get_gridparams<i>, <a href="#_get_gridparams_keyword_in1">in1</a>, <a href="#_get_gridparams_keyword_in2">in2</a>, <a href="#_get_gridparams_keyword_in3">in3</a>, <a href="#_get_gridparams_keyword_in4">in4</a>, <a href="#_get_gridparams_keyword_in5">in5</a>, <a href="#_get_gridparams_keyword_in6">in6</a>, <a href="#_get_gridparams_keyword_in7">in7</a>, <a href="#_get_gridparams_keyword_in8">in8</a></i>, <a href="#_get_gridparams_keyword_DOUBLE">DOUBLE</a>=<i>DOUBLE</i></font></p> |
|---|
| 82 | |
|---|
| 83 | |
|---|
| 84 | |
|---|
| 85 | |
|---|
| 86 | |
|---|
| 87 | |
|---|
| 88 | |
|---|
| 89 | <h3>Parameters</h3> |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | <a name="#_get_gridparams_keyword_in1"></a> |
|---|
| 93 | <h4>in1 |
|---|
| 94 | <font size="-1" color="#006633">in</font> |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | <font size="-1" color="#006633">required</font> |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | </h4> |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | Case 1: the name of the netcdf file |
|---|
| 106 | Case 2: 1d or 2D arrays defining longitudes and latitudes. |
|---|
| 107 | Out: the variable that will contain the longitudes |
|---|
| 108 | |
|---|
| 109 | |
|---|
| 110 | |
|---|
| 111 | <a name="#_get_gridparams_keyword_in2"></a> |
|---|
| 112 | <h4>in2 |
|---|
| 113 | <font size="-1" color="#006633">in</font> |
|---|
| 114 | |
|---|
| 115 | |
|---|
| 116 | <font size="-1" color="#006633">required</font> |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | |
|---|
| 121 | </h4> |
|---|
| 122 | |
|---|
| 123 | |
|---|
| 124 | Case 1: the name of the variable that contains the longitude in the NetCDF file |
|---|
| 125 | Case 2: 1d or 2D arrays defining longitudes and latitudes. |
|---|
| 126 | Note that these arrays are also outputs and can therefore be modified. |
|---|
| 127 | Out: the variable that will contain the latitudes |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | <a name="#_get_gridparams_keyword_in3"></a> |
|---|
| 132 | <h4>in3 |
|---|
| 133 | <font size="-1" color="#006633">in</font> |
|---|
| 134 | |
|---|
| 135 | |
|---|
| 136 | <font size="-1" color="#006633">required</font> |
|---|
| 137 | |
|---|
| 138 | |
|---|
| 139 | |
|---|
| 140 | |
|---|
| 141 | </h4> |
|---|
| 142 | |
|---|
| 143 | |
|---|
| 144 | Case 1: the name of the variable that contains the latitude in the NetCDF file |
|---|
| 145 | Case 2: the number of points in the longitudinal direction. |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | <a name="#_get_gridparams_keyword_in4"></a> |
|---|
| 150 | <h4>in4 |
|---|
| 151 | |
|---|
| 152 | <font size="-1" color="#006633">out</font> |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | |
|---|
| 156 | |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | </h4> |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | Case 1: the number of points in the longitudinal direction |
|---|
| 163 | Case 2: the number of points in the latitudinal direction |
|---|
| 164 | |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | <a name="#_get_gridparams_keyword_in5"></a> |
|---|
| 168 | <h4>in5 |
|---|
| 169 | |
|---|
| 170 | <font size="-1" color="#006633">out</font> |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | </h4> |
|---|
| 178 | |
|---|
| 179 | |
|---|
| 180 | Case 1: the number of points in the latitudinal direction |
|---|
| 181 | Case 2: 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) |
|---|
| 182 | arrays or 2D arrays (jpi,jpj). Note that of n_dimensions = 1, then the |
|---|
| 183 | grid must be regular (each longitudes must be the same for all latitudes |
|---|
| 184 | and each latitudes should be the same for all longitudes). |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | <a name="#_get_gridparams_keyword_in6"></a> |
|---|
| 189 | <h4>in6 |
|---|
| 190 | |
|---|
| 191 | <font size="-1" color="#006633">out</font> |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | </h4> |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | the variable that will contain the longitudes |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | <a name="#_get_gridparams_keyword_in7"></a> |
|---|
| 206 | <h4>in7 |
|---|
| 207 | |
|---|
| 208 | <font size="-1" color="#006633">out</font> |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | </h4> |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | the variable that will contain the latitudes |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | <a name="#_get_gridparams_keyword_in8"></a> |
|---|
| 223 | <h4>in8 |
|---|
| 224 | |
|---|
| 225 | <font size="-1" color="#006633">out</font> |
|---|
| 226 | |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | </h4> |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | |
|---|
| 241 | <h3>Keywords</h3> |
|---|
| 242 | |
|---|
| 243 | |
|---|
| 244 | <a name="#_get_gridparams_keyword_DOUBLE"></a> |
|---|
| 245 | <h4>DOUBLE |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | |
|---|
| 252 | |
|---|
| 253 | |
|---|
| 254 | </h4> |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | use double precision to perform the computation |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | <h3>Examples</h3> |
|---|
| 263 | |
|---|
| 264 | 1) |
|---|
| 265 | IDL> get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions |
|---|
| 266 | |
|---|
| 267 | or |
|---|
| 268 | |
|---|
| 269 | 2) |
|---|
| 270 | IDL> get_gridparams, lon, lat, jpi, jpj, n_dimensions |
|---|
| 271 | |
|---|
| 272 | 1) |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | 1) IDL> ncdf_get_gridparams, 'coordinates_ORCA_R05.nc', 'glamt', 'gphit' $ |
|---|
| 276 | , olon, olat, jpio, jpjo, 2 |
|---|
| 277 | |
|---|
| 278 | 2) IDL> ncdf_get_gridparams, olon, olat, jpio, jpjo, 2 |
|---|
| 279 | |
|---|
| 280 | <h3>Version history</h3> |
|---|
| 281 | |
|---|
| 282 | <h4>Version</h4> $Id: get_gridparams.pro 163 2006-08-29 12:59:46Z navarro $ |
|---|
| 283 | |
|---|
| 284 | <h4>History</h4> |
|---|
| 285 | November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | |
|---|
| 303 | <font size="-3"><p> </p></font> |
|---|
| 304 | <hr size="1" color="#CCCCCC"/> |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
|---|
| 310 | |
|---|
| 311 | </body> |
|---|
| 312 | </html> |
|---|
