Changeset 142 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/depth2level.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/depth2level.html (modified) (5 diffs)

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

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments"> 
+ Allows to pass from a 2d depth array to a corresponding 2d level array.
+</div>
 
       
@@ -711 +713 @@
         <div class="routine_details" id="_depth2level">
 
-          <h2><a class="top" href="#container">top</a>depth2level </h2>
+          <h2><a class="top" href="#container">top</a>depth2level <span class="categories">
+ Without loop
+</span></h2>
         
           <p class="header">
@@ -717 +721 @@
         
           <div class="comments">
- NAME: depth2level
-
- PURPOSE: permet de passer d''un tableau 2d de profondeur au tableau
- 2d correspondant de niveaux.
-
- CATEGORY: SANS BOUCLE
-
- CALLING SEQUENCE: res=depth2level(depth2d)
-
- INPUTS: depth2d tableau 2d de profondeur (ou une structure repondant
- aux criteres de litchamp)
-
- KEYWORD PARAMETERS:
-
-      /UPPER: (active par defaut) on selectionne le niveau
-      directement au dessus de la profondeur
-
-      /LOWER: on selectionne le niveau directement au dessous de la
-      profondeur 
-
-      /CLOSER: on selectionne le niveau le plus proche de la
-      profondeur 
-
-      /NOMASK: pour ne pas masquer les points terres
-
- OUTPUTS: un tableau 2d contenant les valeurs des niveaux.
-
- COMMON BLOCKS:common.pro
-
- SIDE EFFECTS:pour les profondeurs hors des valeurs de gdep, la
- valeur !values.f_nan est retournee.
- Si la profondeur est superieur a celle du fond, on retourne
- jpk-1dans le cas upper, et !values.f_nan ds le cas lower.
-
- RESTRICTIONS:
-
- EXAMPLE:
-</div>
-
-          
+</div>
+
+          <h3>Return value</h3><div class="preformat"> 
+ It is a 2d array containing level's values.
+</div>
 
           
@@ -773 +742 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments"> 
+ 2d depth array (or a structure respecting litchamp critrions)
+</div>
             
 
@@ -793 +764 @@
             </h4>
         
+            <div class="comments">
+ We select the level just below the depth 
+</div>
+            
+            <h4 id="_depth2level_keyword_UPPER">UPPER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments">
+ (activated by default) We select the level just above the depth
+</div>
+            
+            <h4 id="_depth2level_keyword_CLOSER">CLOSER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments"> 
+ We select the depth's closer level 
+</div>
+            
+            <h4 id="_depth2level_keyword_NOMASK">NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments"> 
+ To do not mask land points
+</div>
+            
+            <h4 id="_depth2level_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
             <div class="comments"></div>
             
-            <h4 id="_depth2level_keyword_UPPER">UPPER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
-            
-            <h4 id="_depth2level_keyword_CLOSER">CLOSER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
-            
-            <h4 id="_depth2level_keyword_NOMASK">NOMASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
-            
-            <h4 id="_depth2level_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
-            
-          
-
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
-          
-          
-          
-          
+          
+
+          
+          <h3>Version history</h3>
+          
+          <h4>Version</h4><div class="preformat">
+ $Id$</div>
+          <h4>History</h4><div class="preformat"></div>
+          
+          
+          <h3>Known issues</h3>
+          
+          
+          
+          <h4>Restrictions</h4><div class="preformat"> 
+ For depthes out of gdep's values, the value !values.f_nan is sent back.
+ if the depth is superior to this one of the bottom, we send back jpk-1 in 
+ the upper case, and !values.f_nan in the lower case.
+</div>
+        
+          <h3>Other attributes</h3>
+          
+          
+          <h4>Uses routines</h4><div class="preformat">
+ common.pro
+</div>