- Timestamp:
- 06/12/06 10:29:56 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/Interpolation/fromreg.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="_fromreg"> 103 104 <h2><a class="top" href="#container">top</a>fromreg </h2> 105 106 <p class="header"> 107 <span class="result">result = </span>fromreg(<span class="result"><a href="#_fromreg_param_method">method</a>, <a href="#_fromreg_param_datain">datain</a>, <a href="#_fromreg_param_lonin">lonin</a>, <a href="#_fromreg_param_latin">latin</a>, <a href="#_fromreg_param_lonout">lonout</a>, <a href="#_fromreg_param_latout">latout</a></span>, <a href="#_fromreg_keyword_WEIG">WEIG</a>=<span class="result">WEIG</span>, <a href="#_fromreg_keyword_ADDR">ADDR</a>=<span class="result">ADDR</span>, <a href="#_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span>)</p> 108 109 <div class="comments"> 110 NAME: fromreg 111 112 PURPOSE: interpolate data from a "regular/rectangular grid" to any grid. 89 <div id="file_comments"> interpolate data from a "regular/rectangular grid" to any grid. 113 90 2 metods availables: bilinear and imoms3 114 91 A "regular/rectangular grid" is defined as a grid for which each lontitudes lines have 115 92 the same latitude and each latitudes columns have the same longitude. 116 117 CATEGORY:interpolation 118 119 CALLING SEQUENCE: dataout = fromreg(method, datain [, lonin, latin, lonout, latout]) 120 121 INPUTS: 122 method: a string defining the interpolation method. 123 must be 'bilinear' or 'imoms3' 124 datain: a 2D array the input data to interpolate 125 lonin and latin: longitude/latitude of the input data. optionals if 93 </div> 94 95 96 97 98 99 100 101 102 103 <div id="routine_details"> 104 105 106 <div class="routine_details" id="_fromreg"> 107 108 <h2><a class="top" href="#container">top</a>fromreg <span class="categories"> interpolation 109 </span></h2> 110 111 <p class="header"> 112 <span class="result">result = </span>fromreg(<span class="result"><a href="#_fromreg_param_method">method</a>, <a href="#_fromreg_param_datain">datain</a>, <a href="#_fromreg_param_lonin">lonin</a>, <a href="#_fromreg_param_latin">latin</a>, <a href="#_fromreg_param_lonout">lonout</a>, <a href="#_fromreg_param_latout">latout</a></span>, <a href="#_fromreg_keyword_WEIG">WEIG</a>=<span class="result">WEIG</span>, <a href="#_fromreg_keyword_ADDR">ADDR</a>=<span class="result">ADDR</span>, <a href="#_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE</a>=<span class="result">NONORTHERNLINE</span>, <a href="#_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE</a>=<span class="result">NOSOUTHERNLINE</span>)</p> 113 114 <div class="comments"> 115 </div> 116 117 <h3>Return value</h3><div class="value"> 2D array: the interpolated data 118 </div> 119 120 121 <h3>Parameters</h3> 122 123 124 <h4 id="_fromreg_param_method">method 125 <span class="attr">in</span> 126 127 128 <span class="attr">required</span> 129 130 131 132 133 </h4> 134 135 <div class="comments"> a string defining the interpolation method. 136 must be 'bilinear' or 'imoms3'</div> 137 138 <h4 id="_fromreg_param_datain">datain 139 <span class="attr">in</span> 140 141 142 <span class="attr">required</span> 143 144 145 146 147 </h4> 148 149 <div class="comments"> a 2D array the input data to interpolate</div> 150 151 <h4 id="_fromreg_param_lonin">lonin 152 <span class="attr">in</span> 153 154 155 <span class="attr">required</span> 156 157 158 159 160 </h4> 161 162 <div class="comments"> longitude/latitude of the input data. optionals if 163 WEIG and ADDR keywords used.</div> 164 165 <h4 id="_fromreg_param_latin">latin 166 167 168 169 170 171 172 173 174 </h4> 175 176 <div class="comments"></div> 177 178 <h4 id="_fromreg_param_lonout">lonout 179 <span class="attr">in</span> 180 181 182 <span class="attr">required</span> 183 184 185 186 187 </h4> 188 189 <div class="comments"> longitude/latitude of the output data. optionals if 126 190 WEIG and ADDR keywords used. 127 lonout and latout: longitude/latitude of the output data. optionals if 128 WEIG and ADDR keywords used. 129 130 KEYWORD PARAMETERS: 131 132 WEIG, ADDR: 2D arrays, weig and addr are the weight and addresses used to 191 </div> 192 193 <h4 id="_fromreg_param_latout">latout 194 195 196 197 198 199 200 201 202 </h4> 203 204 <div class="comments"></div> 205 206 207 208 209 210 211 <h3>Keywords</h3> 212 213 <h4 id="_fromreg_keyword_WEIG">WEIG 214 215 216 217 218 219 220 221 222 </h4> 223 224 <div class="comments">, ADDR 2D arrays, weig and addr are the weight and addresses used to 133 225 perform the interpolation: 134 226 dataout = total(weig*datain[addr], 1) … … 138 230 the interpolation whithout computing again those 2 parameters. In that 139 231 case, lonin, latin, lonout and latout are not necessary. 140 141 /NONORTHERNLINE and /NOSOUTHERNLINE: activate if you don't whant to take into 232 </div> 233 234 <h4 id="_fromreg_keyword_ADDR">ADDR 235 236 237 238 239 240 241 242 243 </h4> 244 245 <div class="comments"></div> 246 247 <h4 id="_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE 248 249 250 251 252 253 254 255 256 </h4> 257 258 <div class="comments"> and /NOSOUTHERNLINE activate if you don't whant to take into 142 259 account the northen/southern line of the input data when perfoming the 143 260 interpolation. 144 145 OUTPUTS: 2D array: the interpolated data 146 147 COMMON BLOCKS: none 148 149 SIDE EFFECTS: ? 150 151 RESTRICTIONS:We supposed the data are located on a sphere, with a periodicity along 152 the longitude. 153 154 EXAMPLE: 261 </div> 262 263 <h4 id="_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE 264 265 266 267 268 269 270 271 272 </h4> 273 274 <div class="comments"></div> 275 276 277 278 <h3>Examples</h3><div class="value"> 279 dataout = fromreg(method, datain [, lonin, latin, lonout, latout]) 280 281 155 282 156 283 topa = fromreg('bilinear', tncep, xncep, yncep, glamt, gphit) … … 161 288 help, a, b 162 289 t2opa = fromreg('bilinear', t2ncep, xncep, WEIG = a, ADDR = b) 163 164 MODIFICATION HISTORY:</div> 165 166 167 168 169 <h3>Parameters</h3> 170 171 172 <h4 id="_fromreg_param_method">method 173 174 175 176 177 178 179 180 181 </h4> 182 183 <div class="comments"></div> 184 185 <h4 id="_fromreg_param_datain">datain 186 187 188 189 190 191 192 193 194 </h4> 195 196 <div class="comments"></div> 197 198 <h4 id="_fromreg_param_lonin">lonin 199 200 201 202 203 204 205 206 207 </h4> 208 209 <div class="comments"></div> 210 211 <h4 id="_fromreg_param_latin">latin 212 213 214 215 216 217 218 219 220 </h4> 221 222 <div class="comments"></div> 223 224 <h4 id="_fromreg_param_lonout">lonout 225 226 227 228 229 230 231 232 233 </h4> 234 235 <div class="comments"></div> 236 237 <h4 id="_fromreg_param_latout">latout 238 239 240 241 242 243 244 245 246 </h4> 247 248 <div class="comments"></div> 249 250 251 252 253 254 255 <h3>Keywords</h3> 256 257 <h4 id="_fromreg_keyword_WEIG">WEIG 258 259 260 261 262 263 264 265 266 </h4> 267 268 <div class="comments"></div> 269 270 <h4 id="_fromreg_keyword_ADDR">ADDR 271 272 273 274 275 276 277 278 279 </h4> 280 281 <div class="comments"></div> 282 283 <h4 id="_fromreg_keyword_NONORTHERNLINE">NONORTHERNLINE 284 285 286 287 288 289 290 291 292 </h4> 293 294 <div class="comments"></div> 295 296 <h4 id="_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE 297 298 299 300 301 302 303 304 305 </h4> 306 307 <div class="comments"></div> 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 290 </div> 291 <h3>Version history</h3> 292 293 294 <h4>History</h4><div class="value"> 295 November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr) 296 </div> 297 298 299 <h3>Known issues</h3> 300 301 302 303 <h4>Restrictions</h4><div class="value"> We supposed the data are located on a sphere, with a 304 periodicity along the longitude. 305 </div> 323 306 324 307
Note: See TracChangeset
for help on using the changeset viewer.
