Changeset 163 for trunk/SRC/Documentation/idldoc_html_output/Interpolation/fromreg.html

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/Documentation/idldoc_html_output/Interpolation/fromreg.html (modified) (15 diffs)

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

@@ -701 +701 @@
       <div id="file_comments">
  interpolate data from a "regular/rectangular grid" to any grid.
-   2 methods availables: bilinear and imoms3
-   A "regular/rectangular grid" is defined as a grid for which each lontitudes lines have
+   2 methods available: bilinear and imoms3
+   A "regular/rectangular grid" is defined as a grid for which each longitudes lines have
    the same latitude and each latitudes columns have the same longitude.
 </div>
@@ -724 +724 @@
         
           <p class="header">
-            <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>
+            <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">2d array</span>, <a href="#_fromreg_keyword_ADDR">ADDR</a>=<span class="result">2d array</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>
         
           <div class="comments">
@@ -743 +743 @@
               <span class="attr">required</span>
               
-              
+              <span class="attr">type:</span> <span class="value">string</span>
               
               
@@ -759 +759 @@
               <span class="attr">required</span>
               
-              
+              <span class="attr">type:</span> <span class="value">2d array</span>
               
               
@@ -774 +774 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">1d or 2d array</span>
               
               
@@ -789 +789 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">1d or 2d array</span>
               
               
@@ -804 +804 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">1d or 2d array</span>
               
               
@@ -819 +819 @@
               <span class="attr">required</span>
               
-              
+              <span class="attr">type:</span> <span class="value">1d or 2d array</span>
               
               
@@ -841 +841 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">2d array</span>
               
               
             </h4>
         
-            <div class="comments"> (see ADDR)</div>
+            <div class="comments">
+ (see ADDR)
+</div>
             
             <h4 id="_fromreg_keyword_ADDR">ADDR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -854 +856 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">2d array</span>
               
               
             </h4>
         
-            <div class="comments"> 2D arrays, weig and addr are the weight and addresses used to
+            <div class="comments">
+ 2D arrays, weig and addr are the weight and addresses used to
  perform the interpolation:
           dataout = total(weig*datain[addr], 1)
@@ -865 +868 @@
  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 whithout computing again those 2 parameters. In that
+ the interpolation without computing again those 2 parameters. In that
  case, lonin, latin, lonout and latout are not necessary.
 </div>
@@ -880 +883 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ activate if you don't want to take into account the northern line
+ of the input data when performing the interpolation.
+</div>
             
             <h4 id="_fromreg_keyword_NOSOUTHERNLINE">NOSOUTHERNLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -894 +900 @@
         
             <div class="comments">
- activate if you don't want to take into account the northen/southern line
- of the input data when perfoming the interpolation.
+ activate if you don't want to take into account the southern line
+ of the input data when performing the interpolation.
 </div>
             
@@ -912 +918 @@
           <h3>Version history</h3>
           
-          <h4>Version</h4><div class="preformat"> $Id: fromreg.pro 136 2006-07-10 15:20:19Z pinsard $
+          <h4>Version</h4><div class="preformat"> $Id: fromreg.pro 157 2006-08-21 09:01:50Z navarro $
 </div>
           <h4>History</h4><div class="preformat">
@@ -936 +942 @@
           
         
+          <h3>Statistics</h3>
+          <table class="statistics">
+            <tr><td>McCabe cyclic</td><td>           5</td></tr>
+            <tr><td>McCabe essential</td><td>           1</td></tr>
+            <tr><td>McCabe modular design</td><td>           1</td></tr>
+          </table>