Changeset 234 for trunk/SRC/Documentation/idldoc_html_output/Interpolation/fromirr.html

Timestamp:

03/21/07 10:14:37 (17 years ago)

Author:

pinsard

Message:

new idldoc html and assistant outputs

File:

• trunk/SRC/Documentation/idldoc_html_output/Interpolation/fromirr.html (modified) (3 diffs)

trunk/SRC/Documentation/idldoc_html_output/Interpolation/fromirr.html

@@ -105 +105 @@
         <div class="routine_details" id="_fromirr">
 
-          <h2><a class="top" href="#container">top</a>fromirr <span class="categories"> 
+          <h2><a class="top" href="#container">top</a>fromirr <span class="categories">
  Interpolation
 </span></h2>
@@ -279 +279 @@
         
             <div class="comments">
- 2D arrays, weig and addr are the weight and addresses used to
- perform the interpolation:
+ 1) at the first call of fromirr:
+ This keyword can be set to a named variable (undefined or equal to 0) into which the
+ addresses used to perform the interpolation will be copied when the current routine exits.
+ 2) Next, once this keyword is set to a defined 2d array, it is used to bypass the computation
+ of the weights and addresses used to perform the interpolation. In this case, fromirr simply
+ compute the interpolated field as:
           dataout = total(weig*datain[addr], 1)
           dataout = reform(dataout, jpio, jpjo, /over)
- Those keywords can be set to named variables (that are undefined or equal to 0) into which the
- values will be copied when the current routine exits. Next, they can be used to perform
- the interpolation without computing again those 2 parameters. This greatly
- speed-up the interpolation! In that case, lonin, latin, lonout and latout are not necessary.
+ In that case, method, lonin, latin, are not used (but are necessary).
+ lonout, latout are used only to know the output domain size
 </div>
             
@@ -293 +295 @@
           <h3>Examples</h3><div class="preformat">
 
+  To interpolate 1 field:
+
  IDL> tncep = fromirr('bilinear', topa, glamt, gphit, tmask[*,*,0], lonout, latout, mskout)
 
-  or
+  or if you have several fields to interpolate from the same source and target grids
+
+ 1) get back the weights and addresses in variables a and b
+   (that must be undefined or equal to 0 before calling fromirr)
 
  IDL> t1ncep = fromirr('bilinear', topa, glamt, gphit, tmask[*,*,0], lonout, latout, mskout $
                             , WEIG = a, ADDR = b)
  IDL> help, a, b
+
+ 2) use a and b that are now defined to bypass the computation of the weights and addresses 
+ and speed-up the computation!
+
  IDL> t2ncep = fromirr('bilinear', topa, WEIG = a, ADDR = b)
 </div>
           <h3>Version history</h3>
           
-          <h4>Version</h4><div class="preformat"> $Id: fromirr.pro 205 2007-01-22 07:55:49Z smasson $
+          <h4>Version</h4><div class="preformat">
+ $Id: fromirr.pro 231 2007-03-19 17:15:51Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">