Changeset 142 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/level2index.html

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/level2index.html (modified) (6 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/level2index.html

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments"> 
+ We want, from a 3d matrix, to extract a 2d (x,y) array whose each element 
+ has been extract from a level specified by the 2d level array (typically, 
+ we want to obtain the salinity along an isopycn we have repered by its level).
+ level2index is a function who give, in function of level, a 2d indexes array 
+ which will allow to extract the 2d array from the 3d array...
+</div>
 
       
@@ -711 +717 @@
         <div class="routine_details" id="_level2index">
 
-          <h2><a class="top" href="#container">top</a>level2index </h2>
+          <h2><a class="top" href="#container">top</a>level2index <span class="categories">
+ without loop
+</span></h2>
         
           <p class="header">
@@ -717 +725 @@
         
           <div class="comments">
- NAME:level2index
-
- PURPOSE: on veut ds une matrice 3d extraire un tableau 2d (x,y) dont
- chacun des elements a ete extrait a un niveau specifie par le
- tableau 2d level (typiquement, on veut obtenir la salinite le long
- d''une isopycne que l''on a reperee par son niveau).
- level2index est une fonction qui donne en fonction de level un
- tableau 2d d'indice qui permettra d''extraire le tableau 2d du
- tableau 3d...
-
- CATEGORY: SANS BOUCLE
-
- CALLING SEQUENCE: index=level2index(level)
- 
- INPUTS:level: un tableau 2d de niveaux
-
- KEYWORD PARAMETERS:
-
- OUTPUTS: untableau 2d d''indices
-
- COMMON BLOCKS:
-
- SIDE EFFECTS:
-
- RESTRICTIONS:
-
- EXAMPLE:
 </div>
 
-          
+          <h3>Return value</h3><div class="preformat">
+ a 2d indexes array
+</div>
 
           
@@ -753 +736 @@
             
             <h4 id="_level2index_param_level">level&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
               
               
-              
-              
+              <span class="attr">required</span>
               
               
@@ -763 +746 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments">
+ A 2d level array
+</div>
             
 
@@ -771 +756 @@
 
           
-          
-          
-          
-          
+          <h3>Version history</h3>
+          
+          <h4>Version</h4><div class="preformat">
+ $Id$
+</div>
+          <h4>History</h4><div class="preformat"></div>