Changeset 234 for trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/norme.html

Timestamp:

03/21/07 10:14:37 (17 years ago)

Author:

pinsard

Message:

new idldoc html and assistant outputs

File:

• trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/norme.html (modified) (5 diffs)

trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/norme.html

@@ -61 +61 @@
     </dl>
 
-     
+    
  calculate the norm of a field of vectors, then make a possible average.
    Comment 1: The field of vector can be, 2d:xy, 3d: xyz or xyt,
  4d: xyzt
    Comment 2:
- The calculation of the norm is made before the possible spatial or 
- temporal average because the average of the norm is not equal to the 
+ The calculation of the norm is made before the possible spatial or
+ temporal average because the average of the norm is not equal to the
  norm of averages
-
 
 
@@ -81 +80 @@
 </font></h2>
 
-      <p><font face="Courier"><i>result = </i>norme(<i><a href="#_norme_keyword_composanteu">composanteu</a>, <a href="#_norme_keyword_composantev">composantev</a></i>, <a href="#_norme_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_norme_keyword_DIREC">DIREC</a>=<i>DIREC</i>, <a href="#_norme_keyword__extra">_extra</a>=<i>_extra</i>)</font></p>
+      <p><font face="Courier"><i>result = </i>norme(<i><a href="#_norme_keyword_composanteu">composanteu</a>, <a href="#_norme_keyword_composantev">composantev</a></i>, <a href="#_norme_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_norme_keyword_DIREC">DIREC</a>=<i>DIREC</i>, <a href="#_norme_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
 
     
@@ -146 +145 @@
 
     
- boxzoom on which do the average (by default the domain selected 
+ boxzoom on which do the average (by default the domain selected
  by the last domdef done)
 
@@ -164 +163 @@
     
  't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
-       'xzt' 'yzt' 'xyzt' Direction on which do averages 
-
-    
-    <a name="#_norme_keyword__extra"></a>
-    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-      
-      
-      
-      
-      
-      
-      
-      
-    </h4>
-
-    
-    
-    
-
-    <h3>Examples</h3>
- To calculate the average of the norme of streams on all the domain 
+       'xzt' 'yzt' 'xyzt' Direction on which do averages
+
+    
+    <a name="#_norme_keyword__EXTRA"></a>
+    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+      
+      
+      
+      
+      
+      
+      
+      
+    </h4>
+
+    
+    
+    
+
+    <h3>Examples</h3><pre>
+ To calculate the average of the norme of streams on all the domain
  between 0 et 50:
       IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz')
 
-    <h3>Version history</h3>
+    </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: norme.pro 163 2006-08-29 12:59:46Z navarro $
+ $Id: norme.pro 232 2007-03-20 16:59:36Z pinsard $
 
     <h4>History</h4>
@@ -203 +202 @@
     
     
-    <h4>Restrictions</h4> 
- The norm is calculated on points TTo do this calculation, we average 
- field U and Von points T before calculate the norme. At the edge of 
- coast and of domain, we can not calculate fields U and V at points T, 
- that is why these points are at value !values.f_nan. 
- 
- When we calculate on a reduce geographic domain, field U and V have not 
- necessarily the same number of point. In this case, we recut U and V to 
- keep only common points. We profit of this to redo a domdef which redefine 
+    <h4>Restrictions</h4>
+ The norm is calculated on points TTo do this calculation, we average
+ field U and Von points T before calculate the norme. At the edge of
+ coast and of domain, we can not calculate fields U and V at points T,
+ that is why these points are at value !values.f_nan.
+
+ When we calculate on a reduce geographic domain, field U and V have not
+ necessarily the same number of point. In this case, we recut U and V to
+ keep only common points. We profit of this to redo a domdef which redefine
  a geographic domain on which fields U and V are extracted on same points
 
-
- To know what type of array we work with, we  test its size and dates 
- gave by time[0] and time[jpt-1] to know if thee is a temporal dimension. 
- Before to start norme, make sure that time and jpt are defined how 
- they have to! 
+ To know what type of array we work with, we  test its size and dates
+ gave by time[0] and time[jpt-1] to know if thee is a temporal dimension.
+ Before to start norme, make sure that time and jpt are defined how
+ they have to!