source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/norme.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 5.2 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>norme.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="moyenne.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="projectondepth.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/CALCULS/</font></h1>
58    <h2>norme.pro</h2>
59
60    <dl>
61    </dl>
62
63     
64 calculate the norm of a field of vectors, then make a possible average.
65   Comment 1: The field of vector can be, 2d:xy, 3d: xyz or xyt,
66 4d: xyzt
67   Comment 2:
68 The calculation of the norm is made before the possible spatial or
69 temporal average because the average of the norm is not equal to the
70 norm of averages
71
72
73
74   
75
76     
77      <a name="#_norme"></a>
78
79      <h2>norme  <font size="-1" color="#006633">
80 Calculation
81</font></h2>
82
83      <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>
84
85   
86
87
88    <h3>Return value</h3>
89 Array to trace with plt, pltz or pltt.
90
91
92   
93    <h3>Parameters</h3>
94   
95
96    <a name="#_norme_keyword_composanteu"></a>
97    <h4>composanteu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
98      <font size="-1" color="#006633">in</font>
99     
100     
101      <font size="-1" color="#006633">required</font>
102     
103     
104     
105     
106    </h4>
107
108   
109 an 2d, 3d or 4d array
110
111   
112
113    <a name="#_norme_keyword_composantev"></a>
114    <h4>composantev&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
115      <font size="-1" color="#006633">in</font>
116     
117     
118      <font size="-1" color="#006633">required</font>
119     
120     
121     
122     
123    </h4>
124
125   
126 an 2d, 3d or 4d array
127
128   
129   
130
131   
132    <h3>Keywords</h3>
133
134   
135    <a name="#_norme_keyword_BOXZOOM"></a>
136    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
137     
138     
139     
140     
141     
142     
143     
144     
145    </h4>
146
147   
148 boxzoom on which do the average (by default the domain selected
149 by the last domdef done)
150
151   
152    <a name="#_norme_keyword_DIREC"></a>
153    <h4>DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
154     
155     
156     
157     
158     
159     
160     
161     
162    </h4>
163
164   
165 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
166       'xzt' 'yzt' 'xyzt' Direction on which do averages
167
168   
169    <a name="#_norme_keyword__extra"></a>
170    <h4>_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
171     
172     
173     
174     
175     
176     
177     
178     
179    </h4>
180
181   
182   
183   
184
185    <h3>Examples</h3>
186 To calculate the average of the norme of streams on all the domain
187 between 0 et 50:
188      IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz')
189
190    <h3>Version history</h3>
191   
192    <h4>Version</h4>
193 $Id: norme.pro 157 2006-08-21 09:01:50Z navarro $
194
195    <h4>History</h4>
196 Sebastien Masson (smasson@lodyc.jussieu.fr)
197                       9/6/1999
198
199   
200
201    <h3>Known issues</h3>
202   
203   
204   
205    <h4>Restrictions</h4> 
206 The norm is calculated on points TTo do this calculation, we average
207 field U and Von points T before calculate the norme. At the edge of
208 coast and of domain, we can not calculate fields U and V at points T,
209 that is why these points are at value !values.f_nan.
210 
211 When we calculate on a reduce geographic domain, field U and V have not
212 necessarily the same number of point. In this case, we recut U and V to
213 keep only common points. We profit of this to redo a domdef which redefine
214 a geographic domain on which fields U and V are extracted on same points
215
216
217 To know what type of array we work with, we  test its size and dates
218 gave by time[0] and time[jpt-1] to know if thee is a temporal dimension.
219 Before to start norme, make sure that time and jpt are defined how
220 they have to!
221
222
223    <h3>Other attributes</h3>
224   
225   
226    <h4>Uses routines</h4>
227 common.pro
228
229   
230   
231   
232
233    <font size="-3"><p>&nbsp;</p></font>
234    <hr size="1" color="#CCCCCC"/>
235     
236
237   
238
239    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:52 2006.</font></p>
240
241  </body>
242</html>
Note: See TracBrowser for help on using the repository browser.