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

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

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments">
+ Allows to project a 3d field following a depth array.
+</div>
 
       
@@ -711 +713 @@
         <div class="routine_details" id="_projectondepth">
 
-          <h2><a class="top" href="#container">top</a>projectondepth </h2>
+          <h2><a class="top" href="#container">top</a>projectondepth <span class="categories">
+ without loop
+</span></h2>
         
           <p class="header">
@@ -717 +721 @@
         
           <div class="comments">
- NAME:projectondepth
-
- PURPOSE: routine permettant de projeter un champ 3d suivant un
- tableau de profondeurs.
-
- CATEGORY: sans boucles
-
- CALLING SEQUENCE:res=projectondepth(arrayin, depthin)
- 
- INPUTS:
-       arrayin: un tableau 3d dont la 3eme dimension doit etre egale
-       a jpk
-       depthin: un tableau 2d indiquant n chaque point a quel
-       profondeur projeter
-       
- KEYWORD PARAMETERS:none
-
- OUTPUTS:res: un tableau 2d projection du tableau 3d suivant les
- profondeurs indiquees par depthin
-
- COMMON BLOCKS:common.pro
-
- SIDE EFFECTS: points a !values.f_nan qd calcul impossible. points
- terres masques a Valmask.
-
- RESTRICTIONS:
-
- EXAMPLE:
-
- on contruit un tableau de profondeurs possibles
+</div>
+
+          <h3>Return value</h3><div class="preformat">
+ A 2d array which is the projection of the 3d array following depthes indicated by depthin
+</div>
+
+          
+            <h3>Parameters</h3>
+        
+            
+            <h4 id="_projectondepth_param_arrayin">arrayin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+          <div class="comments"> 
+ It is a 3d array whose 3rd dimension must be equal to jpk
+ </div>
+            
+            <h4 id="_projectondepth_param_depthin">depthin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+          <div class="comments"> 
+ It is a 2d array indicating for each point n, at which depth to project
+       </div>
+            
+
+          
+
+          
+
+          <h3>Examples</h3><div class="preformat">
+ we build a possible depthes array
    IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj)
- on contruit un tableau a projeter sur ces profondeurs. pour le test
- on construit un tableau 3d dont chaque vecteur suivant z est la
- profondeur. 
+ We build an array to project on these depthes. For the test,
+ we build a 3d array whose each vector following z is the depth. 
    IDL> arraytest=replicate(1,jpi*jpj)#gdept
    IDL> arraytest=reform(arraytest,jpi,jpj,jpk, /over)
- on test la projection du tabeau profondeur sur la profondeur...
+ We test the projection of the depth array on the depth...
    IDL> plt, 1e6*(a-projectondepth(arraytest,a)),/nocontour
-   ->champ nul a 1e-6 pres
+   ->null field at 1e-6 pres
  
-  verifcation en projettant la temperature sur la profondeur de la 20
-  degres par exemple...
-</div>
-
-          
-
-          
-            <h3>Parameters</h3>
-        
-            
-            <h4 id="_projectondepth_param_arrayin">arrayin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-          <div class="comments"></div>
-            
-            <h4 id="_projectondepth_param_depthin">depthin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-          <div class="comments"></div>
-            
-
-          
-
-          
-
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
-          
-          
-          
-          
+  verifcation projecting the temperature of 20°C for example...
+</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"> 
+ points at !values.f_nan impossible calculation. Land points masked at valmask.
+</div>
+        
+          <h3>Other attributes</h3>
+          
+          
+          <h4>Uses routines</h4><div class="preformat">
+ common.pro
+</div>