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

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

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments">
+ Rather comparable to depth2level but here, the calculated level is in float. 
+ For example, the level 5.4 correspond to a depth equal 
+ to gdep[5]+.4*(gdep[6]-gdep[5])
+</div>
 
       
@@ -711 +715 @@
         <div class="routine_details" id="_depth2floatlevel">
 
-          <h2><a class="top" href="#container">top</a>depth2floatlevel </h2>
+          <h2><a class="top" href="#container">top</a>depth2floatlevel <span class="categories"> 
+ Without loop.
+</span></h2>
         
           <p class="header">
             <span class="result">result = </span>depth2floatlevel(<span class="result"><a href="#_depth2floatlevel_param_tab">tab</a></span>, <a href="#_depth2floatlevel_keyword_NOMASK">NOMASK</a>=<span class="result">NOMASK</span>)</p>
         
-          <div class="comments">
- NAME:depth2floatlevel
-
- PURPOSE: assez comparable a depth2level mais ici le niveau calcule
- est en float. Par ex le niveau 5.4 correspond a une profondeur egale
- a gdep[5]+.4*(gdep[6]-gdep[5])
-
- CATEGORY: SANS BOUCLE
-
- CALLING SEQUENCE:res=depth2floatlevel(depth2d)
- 
- INPUTS: depth2d tableau 2d de profondeur (ou une structure repondant
- aux criteres de litchamp)
-
- KEYWORD PARAMETERS: 
-       /NOMASK: pour ne pas masquer les points terres
-
- OUTPUTS: un tableau 2d de float contenant les valeurs des niveaux.
-
- COMMON BLOCKS:common.pro
-
- SIDE EFFECTS:accepte les vcaleurs a !values.f_nan et masque les
- points terres a valmask.
-
- RESTRICTIONS:
-
- EXAMPLE:
-
-    IDL> a=(jpk-1)/(1.*jpi*jpj)*findgen(jpi,jpj)
-    IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
-
-  ->champ nul a 1e-6 pres
-</div>
-
-          
+          <div class="comments"></div>
+
+          <h3>Return value</h3><div class="preformat">
+ An 2d array of float containing levels's values.
+</div>
 
           
@@ -757 +733 @@
             
             <h4 id="_depth2floatlevel_param_tab">tab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
+              <span class="attr">in</span>
+              
+              
+              <span class="attr">required</span>
               
               
@@ -767 +743 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments">
+ 2d depth array (or a structure respecting litchamp criterions)
+</div>
             
 
@@ -787 +765 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ To do not mask land points
+</div>
             
           
 
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
-          
-          
-          
-          
+          <h3>Examples</h3><div class="preformat">
+    IDL> a=(jpk-1)/(1.*jpi*jpj)*findgen(jpi,jpj)
+    IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
+
+  ->champ nul a 1e-6 pres
+</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">
+ Accept values at !values.f_nan and mask land points at valmask.
+</div>
+        
+          <h3>Other attributes</h3>
+          
+          
+          <h4>Uses routines</h4><div class="preformat">
+ common.pro
+</div>