source: trunk/SRC/Documentation/idldoc_assistant_output/Obsolete/norme.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 5.8 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="nlecserie.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="strrepl.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Obsolete/</font></h1>
58    <h2>norme.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 calculate the norm of vectors field located on Arakawa C-grid
65
66
67   
68
69     
70      <a name="#_norme"></a>
71
72      <h2>norme <font size="-1" color="#FF6633">obsolete</font> </h2>
73
74      <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>
75
76   
77
78
79    <h3>Return value</h3>
80 A 2D (xy), 3D (xyz or yt), 4D (xyzt) Array
81
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_norme_keyword_composanteu"></a>
88    <h4>composanteu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89      <font size="-1" color="#006633">in</font>
90     
91     
92      <font size="-1" color="#006633">required</font>
93     
94     
95     
96     
97    </h4>
98
99   
100 Matrix representing the zonal coordinates (at U/V point) of a field of vectors
101 A 2D (xy), 3D (xyz or yt), 4D (xyzt) or a structure readable by
102 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt), 4D (xyzt) array.
103 Note that the dimension of the array must suit the domain dimension.
104
105   
106
107    <a name="#_norme_keyword_composantev"></a>
108    <h4>composantev&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109      <font size="-1" color="#006633">in</font>
110     
111     
112      <font size="-1" color="#006633">required</font>
113     
114     
115     
116     
117    </h4>
118
119   
120 Matrix representing the meridional coordinates (at V/U point) of a field of vectors
121 A 2D (xy), 3D (xyz or yt), 4D (xyzt) or a structure readable by
122 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt), 4D (xyzt) array.
123 Note that the dimension of the array must suit the domain dimension.
124
125   
126   
127
128   
129    <h3>Keywords</h3>
130
131   
132    <a name="#_norme_keyword_BOXZOOM"></a>
133    <h4>BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134     
135     
136     
137     
138     
139     
140     
141     
142    </h4>
143
144   
145 boxzoom on which do the average (by default the domain selected
146 by the last <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a> done)
147
148   
149    <a name="#_norme_keyword_DIREC"></a>
150    <h4>DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
151     
152     
153     
154     
155     
156     
157     
158     
159    </h4>
160
161   
162 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
163       'xzt' 'yzt' 'xyzt' Direction on which do averages
164
165   
166    <a name="#_norme_keyword__EXTRA"></a>
167    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168     
169     
170     
171     
172     
173     
174     
175     
176    </h4>
177
178   
179   
180   
181
182    <h3>Examples</h3><pre>
183 To calculate the average of the norme of streams on all the domain
184 between 0 and 50:
185   IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz')
186
187    </pre><h3>Version history</h3>
188   
189    <h4>Version</h4>
190 $Id: norme.pro 371 2008-08-07 09:32:02Z pinsard $
191
192    <h4>History</h4>
193 9/6/1999 Sebastien Masson (smasson@lodyc.jussieu.fr)
194 December 2007: Sebastien Masson, move to obsolete
195                       
196
197   
198
199    <h3>Known issues</h3>
200    <h4>Obsolete</h4>
201
202   
203   
204    <h4>Restrictions</h4>
205 The norm is calculated on points T. To do this calculation, we average
206 field U and V on 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 <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a> 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 <a href="..//Obsolete/common.html">common</a>
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.