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

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

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments"> 
+ Rather comparable to level2depth. It is the invert funcion of depth2floatlevel
+</div>
 
       
@@ -711 +713 @@
         <div class="routine_details" id="_floatlevel2depth">
 
-          <h2><a class="top" href="#container">top</a>floatlevel2depth </h2>
+          <h2><a class="top" href="#container">top</a>floatlevel2depth <span class="categories">
+ Without loop
+</span></h2>
         
           <p class="header">
@@ -717 +721 @@
         
           <div class="comments">
- NAME:floatlevel2depth
-
- PURPOSE: assez comparable a level2depth. C'est la fonction inverse
- de depth2floatlevel
-
- CATEGORY:SANS BOUCLE
-
- CALLING SEQUENCE:res=floatlevel2depth(niveau)
- 
- INPUTS: tableau 2d de niveaux seuil (ou une structure repondant aux
- criteres de litchamp)
-
- KEYWORD PARAMETERS:
-       /NOMASK: pour ne pas masquer les points terres
-
- OUTPUTS: un tableau 2d contenant des profondeurs
-
- COMMON BLOCKS:common.pro
-
- SIDE EFFECTS:
-
- RESTRICTIONS:
-
- EXAMPLE:
-
-    IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj)
-    IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
-
-  ->champ nul a 1e-6 pres
-</div>
-
-          
+</div>
+
+          <h3>Return value</h3><div class="preformat">
+ 2d array containing depthes
+</div>
 
           
@@ -765 +742 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments">
+ 2d array of sill levels (or a structure respecting litchamp criterions)
+</div>
             
 
@@ -785 +764 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ To do not mask land points
+</div>
             
           
 
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
-          
-          
-          
-          
+          <h3>Examples</h3><div class="preformat">
+    IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj)
+    IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
+
+  ->null field at 1e-6 pres
+</div>
+          <h3>Version history</h3>
+          
+          <h4>Version</h4><div class="preformat">
+ $Id$
+</div>
+          <h4>History</h4><div class="preformat"></div>
+          
+          
+          
+          
+          
+          
+          
+        
+          <h3>Other attributes</h3>
+          
+          
+          <h4>Uses routines</h4><div class="preformat">
+ common.pro
+</div>