| 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>get_gridparams.pro (IDLdoc API 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="get_gridparams.pro (IDLdoc API documentation)"; |
|---|
| 19 | } |
|---|
| 20 | </script> |
|---|
| 21 | </head> |
|---|
| 22 | |
|---|
| 23 | <body onload="setTitle();"> |
|---|
| 24 | |
|---|
| 25 | <div id="navbar_title"> |
|---|
| 26 | <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td> |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | <td >Directory</td> |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
|---|
| 48 | |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td> |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | <td id="selected">File</td> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <td >Source</td> |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | |
|---|
| 61 | <td><a href="./../idldoc-help.html?format=raw" 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="fromreg.html"><<prev file</a> | <a href="imoms3.html">next file >></a> <a href="get_gridparams.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" 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?format=raw">Interpolation/</a></h1> |
|---|
| 82 | <h2 class="pro_file">get_gridparams.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"></div> |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | <div id="routine_details"> |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | <div class="routine_details" id="_get_gridparams"> |
|---|
| 103 | |
|---|
| 104 | <h2><a class="top" href="#container">top</a>get_gridparams </h2> |
|---|
| 105 | |
|---|
| 106 | <p class="header"> |
|---|
| 107 | get_gridparams<span class="result">, <a href="#_get_gridparams_param_in1">in1</a>, <a href="#_get_gridparams_param_in2">in2</a>, <a href="#_get_gridparams_param_in3">in3</a>, <a href="#_get_gridparams_param_in4">in4</a>, <a href="#_get_gridparams_param_in5">in5</a>, <a href="#_get_gridparams_param_in6">in6</a>, <a href="#_get_gridparams_param_in7">in7</a>, <a href="#_get_gridparams_param_in8">in8</a></span>, <a href="#_get_gridparams_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span></p> |
|---|
| 108 | |
|---|
| 109 | <div class="comments"> |
|---|
| 110 | NAME: get_gridparams |
|---|
| 111 | |
|---|
| 112 | PURPOSE: |
|---|
| 113 | 1) extract from a NetCDF file the longitude, latidude, and their dimensions |
|---|
| 114 | and make sure it is 1D or 2D arrays |
|---|
| 115 | |
|---|
| 116 | or 2) given longitude and latitude arrays get their dimensions and make sure |
|---|
| 117 | they are 1D or 2D arrays |
|---|
| 118 | |
|---|
| 119 | CATEGORY:for interpolations tools |
|---|
| 120 | |
|---|
| 121 | CALLING SEQUENCE: |
|---|
| 122 | |
|---|
| 123 | 1) get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions |
|---|
| 124 | |
|---|
| 125 | or |
|---|
| 126 | |
|---|
| 127 | 2) get_gridparams, lon, lat, jpi, jpj, n_dimensions |
|---|
| 128 | |
|---|
| 129 | INPUTS: |
|---|
| 130 | |
|---|
| 131 | 1) |
|---|
| 132 | file: the name of the netcdf file |
|---|
| 133 | loname: the name of the variable that contains the longitude in the NetCDF file |
|---|
| 134 | latname: the name of the variable that contains the latitude in the NetCDF file |
|---|
| 135 | |
|---|
| 136 | or |
|---|
| 137 | |
|---|
| 138 | 2) lon and lat: 1d or 2D arrays defining longitudes and latitudes. |
|---|
| 139 | Note that these arrays are also outputs and can therefore be modified. |
|---|
| 140 | |
|---|
| 141 | KEYWORD PARAMETERS: none |
|---|
| 142 | |
|---|
| 143 | OUTPUTS: |
|---|
| 144 | lon the variable that will contain the longitudes |
|---|
| 145 | lat the variable that will contain the latitudes |
|---|
| 146 | jpi the number of points in the longitudinal direction |
|---|
| 147 | jpj the number of points in the latitudinal direction |
|---|
| 148 | n_dimensions: 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) |
|---|
| 149 | arrays or 2D arrays (jpi,jpj). Note that of n_dimensions = 1, then the |
|---|
| 150 | grid must be regular (each longitudes must be the same for all latitudes |
|---|
| 151 | and each latitudes should be the sae for all longitudes). |
|---|
| 152 | |
|---|
| 153 | COMMON BLOCKS: none |
|---|
| 154 | |
|---|
| 155 | SIDE EFFECTS: ? |
|---|
| 156 | |
|---|
| 157 | RESTRICTIONS: ? |
|---|
| 158 | |
|---|
| 159 | EXAMPLE: |
|---|
| 160 | |
|---|
| 161 | 1) ncdf_get_gridparams, 'coordinates_ORCA_R05.nc', 'glamt', 'gphit' $ |
|---|
| 162 | , olon, olat, jpio, jpjo, 2 |
|---|
| 163 | |
|---|
| 164 | 2) ncdf_get_gridparams, olon, olat, jpio, jpjo, 2 |
|---|
| 165 | |
|---|
| 166 | MODIFICATION HISTORY:</div> |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | <h3>Parameters</h3> |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | <h4 id="_get_gridparams_param_in1">in1 |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | |
|---|
| 180 | |
|---|
| 181 | |
|---|
| 182 | |
|---|
| 183 | </h4> |
|---|
| 184 | |
|---|
| 185 | <div class="comments"></div> |
|---|
| 186 | |
|---|
| 187 | <h4 id="_get_gridparams_param_in2">in2 |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | |
|---|
| 196 | </h4> |
|---|
| 197 | |
|---|
| 198 | <div class="comments"></div> |
|---|
| 199 | |
|---|
| 200 | <h4 id="_get_gridparams_param_in3">in3 |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | </h4> |
|---|
| 210 | |
|---|
| 211 | <div class="comments"></div> |
|---|
| 212 | |
|---|
| 213 | <h4 id="_get_gridparams_param_in4">in4 |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | </h4> |
|---|
| 223 | |
|---|
| 224 | <div class="comments"></div> |
|---|
| 225 | |
|---|
| 226 | <h4 id="_get_gridparams_param_in5">in5 |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | </h4> |
|---|
| 236 | |
|---|
| 237 | <div class="comments"></div> |
|---|
| 238 | |
|---|
| 239 | <h4 id="_get_gridparams_param_in6">in6 |
|---|
| 240 | |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | </h4> |
|---|
| 249 | |
|---|
| 250 | <div class="comments"></div> |
|---|
| 251 | |
|---|
| 252 | <h4 id="_get_gridparams_param_in7">in7 |
|---|
| 253 | |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | </h4> |
|---|
| 262 | |
|---|
| 263 | <div class="comments"></div> |
|---|
| 264 | |
|---|
| 265 | <h4 id="_get_gridparams_param_in8">in8 |
|---|
| 266 | |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | </h4> |
|---|
| 275 | |
|---|
| 276 | <div class="comments"></div> |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | <h3>Keywords</h3> |
|---|
| 284 | |
|---|
| 285 | <h4 id="_get_gridparams_keyword_DOUBLE">DOUBLE |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | |
|---|
| 294 | </h4> |
|---|
| 295 | |
|---|
| 296 | <div class="comments"></div> |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | |
|---|
| 303 | |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | |
|---|
| 317 | |
|---|
| 318 | |
|---|
| 319 | |
|---|
| 320 | |
|---|
| 321 | |
|---|
| 322 | |
|---|
| 323 | </div> |
|---|
| 324 | |
|---|
| 325 | </div> |
|---|
| 326 | |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 330 | |
|---|
| 331 | </div> |
|---|
| 332 | |
|---|
| 333 | </body> |
|---|
| 334 | </html> |
|---|
