Changeset 249 for trunk/SRC/Documentation/idldoc_html_output/Interpolation

Timestamp:

05/29/07 11:22:20 (17 years ago)

Author:

smasson

Message:

update documentation

Location:

trunk/SRC/Documentation/idldoc_html_output/Interpolation

Files:

• angle.html (modified) (8 diffs)
• clickincell.html (modified) (1 diff)
• cutpar.html (modified) (1 diff)
• cutsegment.html (modified) (1 diff)
• dir-files.html (modified) (2 diffs)
• directory-overview.html (modified) (1 diff)
• extrapolate.html (modified) (1 diff)
• extrapsmooth.html (modified) (1 diff)
• get_gridparams.html (modified) (1 diff)
• imoms3.html (modified) (1 diff)
• inquad.html (modified) (1 diff)
• inrecgrid.html (modified) (1 diff)
• lbcorca.html (added)
• ll_narcs_distances.html (modified) (2 diffs)
• map_npoints.html (modified) (1 diff)
• neighbor.html (modified) (1 diff)
• quadrilateral2square.html (modified) (1 diff)
• spl_fstdrv.html (modified) (1 diff)
• spl_incr.html (modified) (1 diff)
• spl_keep_mean.html (modified) (1 diff)
• square2quadrilateral.html (modified) (1 diff)

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

@@ -113 +113 @@
         
           <p class="header">
-            angle<span class="result">, <a href="#_angle_param_fileocemesh">fileocemesh</a>, <a href="#_angle_param_gcosu">gcosu</a>, <a href="#_angle_param_gsinu">gsinu</a>, <a href="#_angle_param_gcosv">gcosv</a>, <a href="#_angle_param_gsinv">gsinv</a>, <a href="#_angle_param_gcost">gcost</a>, <a href="#_angle_param_gsint">gsint</a></span>, <a href="#_angle_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">scalar string</span>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<span class="result">1 ou 2</span></p>
+            angle<span class="result">, <a href="#_angle_param_fileocemesh">fileocemesh</a>, <a href="#_angle_param_gcosu">gcosu</a>, <a href="#_angle_param_gsinu">gsinu</a>, <a href="#_angle_param_gcosv">gcosv</a>, <a href="#_angle_param_gsinv">gsinv</a>, <a href="#_angle_param_gcost">gcost</a>, <a href="#_angle_param_gsint">gsint</a>, <a href="#_angle_param_gcosf">gcosf</a>, <a href="#_angle_param_gsinf">gsinf</a></span>, <a href="#_angle_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">scalar string</span>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<span class="result">1 or 0</span></p>
         
           <div class="comments">
@@ -137 +137 @@
           <div class="comments">
  a netcdf file that contains (at least) the following variables:
+        glamt, gphit: longitudes and latitudes at T-points
         glamu, gphiu: longitudes and latitudes at U-points
         glamv, gphiv: longitudes and latitudes at V-points
@@ -232 +233 @@
 </div>
             
+            <h4 id="_angle_param_gcosf">gcosf&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              <span class="attr">out</span>
+              
+              
+              
+              <span class="attr">type:</span> <span class="value">2d array</span>
+              
+              
+            </h4>
+        
+          <div class="comments">
+ cosinus of the angle between grid lines at F points and direction of the North pole
+</div>
+            
+            <h4 id="_angle_param_gsinf">gsinf&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              <span class="attr">out</span>
+              
+              
+              
+              <span class="attr">type:</span> <span class="value">2d array</span>
+              
+              
+            </h4>
+        
+          <div class="comments">
+ sinus of the angle between grid lines at F points and direction of the North pole
+</div>
+            
 
           
@@ -260 +291 @@
               
               
-              <span class="attr">type:</span> <span class="value">1 ou 2</span>
+              <span class="attr">type:</span> <span class="value">1 or 0</span>
               <span class="attr">default:</span> <span class="value">0</span>
               
@@ -275 +306 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: angle.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: angle.pro 247 2007-05-29 08:58:52Z smasson $
 </div>
           <h4>History</h4><div class="preformat">
@@ -281 +312 @@
                    98-06 (G. Madec)
        Feb 2005: IDL adaptation S. Masson
+       May 2007: F points + call to <pro>lbcorca.pro</pro>
 </div>
           
@@ -293 +325 @@
        =>    gcosu[*, 0] = gcosu[*, 1]
        =>    gsinu[*, 0] = gsinu[*, 1]
-     (2) the grid follows OPA x periodicity rule, first column is
-     equal to the next to last column
-       =>    gcosv[0, *] = gcosv[jpj-2, *]
-       =>    gsinv[0, *] = gsinv[jpj-2, *]
+     (2) the grid follows OPA x and north pole periodicity rule (see <pro>lbcorca.pro</pro>)
 </div>
         
@@ -309 +338 @@
           <h3>Statistics</h3>
           <table class="statistics">
-            <tr><td>McCabe cyclic</td><td>           7</td></tr>
+            <tr><td>McCabe cyclic</td><td>           9</td></tr>
             <tr><td>McCabe essential</td><td>           1</td></tr>
             <tr><td>McCabe modular design</td><td>           1</td></tr>

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

@@ -239 +239 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: clickincell.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: clickincell.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -308 +308 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: cutpar.pro 231 2007-03-19 17:15:51Z pinsard $
+ $Id: cutpar.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -249 +249 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: cutsegment.pro 231 2007-03-19 17:15:51Z pinsard $
+ $Id: cutsegment.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

trunk/SRC/Documentation/idldoc_html_output/Interpolation/dir-files.html

@@ -36 +36 @@
         <li><a href="inquad.html" target="file_frame">inquad.pro</a></li>
         <li><a href="inrecgrid.html" target="file_frame">inrecgrid.pro</a></li>
+        <li><a href="lbcorca.html" target="file_frame">lbcorca.pro</a></li>
         <li><a href="ll_narcs_distances.html" target="file_frame">ll_narcs_distances.pro</a></li>
         <li><a href="map_npoints.html" target="file_frame">map_npoints.pro</a></li>
@@ -46 +47 @@
       </ul>
 
-      <div id="tagline">23 files</div>
+      <div id="tagline">24 files</div>
       
 

trunk/SRC/Documentation/idldoc_html_output/Interpolation/directory-overview.html

@@ -134 +134 @@
         <dd>  given - a list of points, (x,y) position        - the x and y limits of a rectangular grid  find in which cell is located each given point.</dd>
       
+        <dt><a href="lbcorca.html">lbcorca.pro</a></dt>
+        <dd>  check the lateral boundaries condition (east-west and north) of a 2D/3D/4D array  located on a grif of the orca grid familly.</dd>
+      
         <dt><a href="ll_narcs_distances.html">ll_narcs_distances.pro</a></dt>
         <dd>  This function returns the longitude and latitude [lon, lat] of  a point a given arc distance (-pi <= Arc_Dist <= pi), and azimuth (Az),  from a specified location Lon0, Lat0.</dd>

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

@@ -252 +252 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: extrapolate.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: extrapolate.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -234 +234 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: extrapsmooth.pro 238 2007-03-27 13:43:18Z pinsard $</div>
+ $Id: extrapsmooth.pro 242 2007-04-06 08:35:17Z pinsard $</div>
           <h4>History</h4><div class="preformat">
   January 2007: Sebastien Masson (smasson@lodyc.jussieu.fr)

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

@@ -300 +300 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: get_gridparams.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: get_gridparams.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -139 +139 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: imoms3.pro 231 2007-03-19 17:15:51Z pinsard $
+ $Id: imoms3.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           

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

@@ -375 +375 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: inquad.pro 240 2007-03-28 12:17:24Z pinsard $
+ $Id: inquad.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -72 +72 @@
 <div id="secondary_navbar">
 
-<a href="inquad.html">&lt;&lt;prev file</a> | <a href="ll_narcs_distances.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="inrecgrid.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
+<a href="inquad.html">&lt;&lt;prev file</a> | <a href="lbcorca.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="inrecgrid.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
 
 </div>

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

@@ -72 +72 @@
 <div id="secondary_navbar">
 
-<a href="inrecgrid.html">&lt;&lt;prev file</a> | <a href="map_npoints.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="ll_narcs_distances.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
+<a href="lbcorca.html">&lt;&lt;prev file</a> | <a href="map_npoints.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="ll_narcs_distances.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
 
 </div>
@@ -243 +243 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: ll_narcs_distances.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: ll_narcs_distances.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -325 +325 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: map_npoints.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: map_npoints.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -246 +246 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: neighbor.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: neighbor.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -314 +314 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: quadrilateral2square.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: quadrilateral2square.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -201 +201 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: spl_fstdrv.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: spl_fstdrv.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -260 +260 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: spl_incr.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: spl_incr.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -260 +260 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: spl_keep_mean.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: spl_keep_mean.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">

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

@@ -290 +290 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: square2quadrilateral.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: square2quadrilateral.pro 242 2007-04-06 08:35:17Z pinsard $
 </div>
           <h4>History</h4><div class="preformat">