- Timestamp:
- 06/12/06 10:29:56 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/Interpolation/get_gridparams.html
r89 r101 87 87 </div> 88 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: 89 <div id="file_comments"> 113 90 1) extract from a NetCDF file the longitude, latidude, and their dimensions 114 91 and make sure it is 1D or 2D arrays … … 116 93 or 2) given longitude and latitude arrays get their dimensions and make sure 117 94 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) 95 </div> 96 97 98 99 100 101 102 103 104 105 <div id="routine_details"> 106 107 108 <div class="routine_details" id="_get_gridparams"> 109 110 <h2><a class="top" href="#container">top</a>get_gridparams <span class="categories"> interpolation 111 </span></h2> 112 113 <p class="header"> 114 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> 115 116 <div class="comments"> 117 </div> 118 119 120 121 122 <h3>Parameters</h3> 123 124 125 <h4 id="_get_gridparams_param_in1">in1 126 <span class="attr">in</span> 127 <span class="attr">out</span> 128 129 <span class="attr">required</span> 130 131 132 133 134 </h4> 135 136 <div class="comments"> the name of the netcdf file 137 the variable that will contain the longitudes</div> 138 139 <h4 id="_get_gridparams_param_in2">in2 140 <span class="attr">in</span> 141 <span class="attr">out</span> 142 143 <span class="attr">required</span> 144 145 146 147 148 </h4> 149 150 <div class="comments"> the name of the variable that contains the longitude in the NetCDF file 151 the variable that will contain the latitudes</div> 152 153 <h4 id="_get_gridparams_param_in3">in3 154 <span class="attr">in</span> 155 <span class="attr">out</span> 156 157 <span class="attr">required</span> 158 159 160 161 162 </h4> 163 164 <div class="comments"> the name of the variable that contains the latitude in the NetCDF file 165 the number of points in the longitudinal direction</div> 166 167 <h4 id="_get_gridparams_param_in4">in4 168 169 <span class="attr">out</span> 170 171 172 173 174 175 176 </h4> 177 178 <div class="comments"> the number of points in the longitudinal direction 179 the number of points in the latitudinal direction</div> 180 181 <h4 id="_get_gridparams_param_in5">in5 182 183 <span class="attr">out</span> 184 185 186 187 188 189 190 </h4> 191 192 <div class="comments"> the number of points in the latitudinal direction 193 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 149 194 arrays or 2D arrays (jpi,jpj). Note that of n_dimensions = 1, then the 150 195 grid must be regular (each longitudes must be the same for all latitudes 151 196 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: 197 </div> 198 199 <h4 id="_get_gridparams_param_in6">in6 200 201 <span class="attr">out</span> 202 203 204 205 206 207 208 </h4> 209 210 <div class="comments"> the variable that will contain the longitudes</div> 211 212 <h4 id="_get_gridparams_param_in7">in7 213 214 <span class="attr">out</span> 215 216 217 218 219 220 221 </h4> 222 223 <div class="comments"> the variable that will contain the latitudes</div> 224 225 <h4 id="_get_gridparams_param_in8">in8 226 227 <span class="attr">out</span> 228 229 230 231 232 233 234 </h4> 235 236 <div class="comments"> 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 237 238 or 239 240 2) </div> 241 242 243 244 245 246 247 <h3>Keywords</h3> 248 249 <h4 id="_get_gridparams_keyword_DOUBLE">DOUBLE 250 251 252 253 254 255 256 257 258 </h4> 259 260 <div class="comments"></div> 261 262 263 264 <h3>Examples</h3><div class="value"> 265 266 1) get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions 267 268 or 269 270 2) get_gridparams, lon, lat, jpi, jpj, n_dimensions 271 272 1) 273 160 274 161 275 1) ncdf_get_gridparams, 'coordinates_ORCA_R05.nc', 'glamt', 'gphit' $ … … 163 277 164 278 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 279 </div> 280 <h3>Version history</h3> 281 282 283 <h4>History</h4><div class="value"> 284 November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr) 285 </div> 305 286 306 287
Note: See TracChangeset
for help on using the changeset viewer.
