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

Last change on this file since 249 was 249, checked in by smasson, 17 years ago

update documentation
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      <a name="#_norme"></a>
77
78      <h2>norme  <font size="-1" color="#006633">
79 Calculation
80</font></h2>
81
82      <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>
83
84   
85
86
87    <h3>Return value</h3>
88 Array to trace with plt, pltz or pltt.
89
90
91   
92    <h3>Parameters</h3>
93   
94
95    <a name="#_norme_keyword_composanteu"></a>
96    <h4>composanteu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
97      <font size="-1" color="#006633">in</font>
98     
99     
100      <font size="-1" color="#006633">required</font>
101     
102     
103     
104     
105    </h4>
106
107   
108 an 2d, 3d or 4d array
109
110   
111
112    <a name="#_norme_keyword_composantev"></a>
113    <h4>composantev&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
114      <font size="-1" color="#006633">in</font>
115     
116     
117      <font size="-1" color="#006633">required</font>
118     
119     
120     
121     
122    </h4>
123
124   
125 an 2d, 3d or 4d array
126
127   
128   
129
130   
131    <h3>Keywords</h3>
132
133   
134    <a name="#_norme_keyword_BOXZOOM"></a>
135    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
136     
137     
138     
139     
140     
141     
142     
143     
144    </h4>
145
146   
147 boxzoom on which do the average (by default the domain selected
148 by the last domdef done)
149
150   
151    <a name="#_norme_keyword_DIREC"></a>
152    <h4>DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153     
154     
155     
156     
157     
158     
159     
160     
161    </h4>
162
163   
164 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
165       'xzt' 'yzt' 'xyzt' Direction on which do averages
166
167   
168    <a name="#_norme_keyword__EXTRA"></a>
169    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
170     
171     
172     
173     
174     
175     
176     
177     
178    </h4>
179
180   
181   
182   
183
184    <h3>Examples</h3><pre>
185 To calculate the average of the norme of streams on all the domain
186 between 0 et 50:
187      IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz')
188
189    </pre><h3>Version history</h3>
190   
191    <h4>Version</h4>
192 $Id: norme.pro 232 2007-03-20 16:59:36Z pinsard $
193
194    <h4>History</h4>
195 Sebastien Masson (smasson@lodyc.jussieu.fr)
196                       9/6/1999
197
198   
199
200    <h3>Known issues</h3>
201   
202   
203   
204    <h4>Restrictions</h4>
205 The norm is calculated on points TTo do this calculation, we average
206 field U and Von points T before calculate the norme. At the edge of
207 coast and of domain, we can not calculate fields U and V at points T,
208 that is why these points are at value !values.f_nan.
209
210 When we calculate on a reduce geographic domain, field U and V have not
211 necessarily the same number of point. In this case, we recut U and V to
212 keep only common points. We profit of this to redo a domdef which redefine
213 a geographic domain on which fields U and V are extracted on same points
214
215 To know what type of array we work with, we  test its size and dates
216 gave by time[0] and time[jpt-1] to know if thee is a temporal dimension.
217 Before to start norme, make sure that time and jpt are defined how
218 they have to!
219
220
221    <h3>Other attributes</h3>
222   
223   
224    <h4>Uses routines</h4>
225 common.pro
226
227   
228   
229   
230
231    <font size="-3"><p>&nbsp;</p></font>
232    <hr size="1" color="#CCCCCC"/>
233     
234
235   
236
237    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
238
239  </body>
240</html>
Note: See TracBrowser for help on using the repository browser.