source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/norme.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 6.6 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>norme.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="norme.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/CALCULS//norme.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="moyenne.html">&lt;&lt;prev file</a> | <a href="projectondepth.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="norme.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/CALCULS/</a></h1>
82      <h2 class="pro_file">norme.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> 
90 calculate the norm of a field of vectors, then make a possible average.
91   Comment 1: The field of vector can be, 2d:xy, 3d: xyz or xyt,
92 4d: xyzt
93   Comment 2:
94 The calculation of the norm is made before the possible spatial or
95 temporal average because the average of the norm is not equal to the
96 norm of averages
97
98</div>
99
100     
101
102     
103
104     
105
106     
107
108      <div id="routine_details">
109       
110
111        <div class="routine_details" id="_norme">
112
113          <h2><a class="top" href="#container">top</a>norme <span class="categories">
114 Calculation
115</span></h2>
116       
117          <p class="header">
118            <span class="result">result = </span>norme(<span class="result"><a href="#_norme_param_composanteu">composanteu</a>, <a href="#_norme_param_composantev">composantev</a></span>, <a href="#_norme_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_norme_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_norme_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
119       
120          <div class="comments">
121</div>
122
123          <h3>Return value</h3><div class="preformat">
124 Array to trace with plt, pltz or pltt.
125</div>
126
127         
128            <h3>Parameters</h3>
129       
130           
131            <h4 id="_norme_param_composanteu">composanteu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
132              <span class="attr">in</span>
133             
134             
135              <span class="attr">required</span>
136             
137             
138             
139             
140            </h4>
141       
142          <div class="comments">
143 an 2d, 3d or 4d array
144</div>
145           
146            <h4 id="_norme_param_composantev">composantev&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147              <span class="attr">in</span>
148             
149             
150              <span class="attr">required</span>
151             
152             
153             
154             
155            </h4>
156       
157          <div class="comments">
158 an 2d, 3d or 4d array
159</div>
160           
161
162         
163
164         
165
166            <h3>Keywords</h3>
167           
168            <h4 id="_norme_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169             
170             
171             
172             
173             
174             
175             
176             
177            </h4>
178       
179            <div class="comments">
180 boxzoom on which do the average (by default the domain selected
181 by the last domdef done)
182</div>
183           
184            <h4 id="_norme_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
185             
186             
187             
188             
189             
190             
191             
192             
193            </h4>
194       
195            <div class="comments">
196 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
197       'xzt' 'yzt' 'xyzt' Direction on which do averages
198</div>
199           
200            <h4 id="_norme_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201             
202             
203             
204             
205             
206             
207             
208             
209            </h4>
210       
211            <div class="comments"></div>
212           
213         
214
215          <h3>Examples</h3><div class="preformat">
216 To calculate the average of the norme of streams on all the domain
217 between 0 et 50:
218      IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz')
219</div>
220          <h3>Version history</h3>
221         
222          <h4>Version</h4><div class="preformat">
223 $Id: norme.pro 163 2006-08-29 12:59:46Z navarro $
224</div>
225          <h4>History</h4><div class="preformat">
226 Sebastien Masson (smasson@lodyc.jussieu.fr)
227                       9/6/1999
228</div>
229         
230         
231          <h3>Known issues</h3>
232         
233         
234         
235          <h4>Restrictions</h4><div class="preformat"> 
236 The norm is calculated on points TTo do this calculation, we average
237 field U and Von points T before calculate the norme. At the edge of
238 coast and of domain, we can not calculate fields U and V at points T,
239 that is why these points are at value !values.f_nan.
240 
241 When we calculate on a reduce geographic domain, field U and V have not
242 necessarily the same number of point. In this case, we recut U and V to
243 keep only common points. We profit of this to redo a domdef which redefine
244 a geographic domain on which fields U and V are extracted on same points
245
246
247 To know what type of array we work with, we  test its size and dates
248 gave by time[0] and time[jpt-1] to know if thee is a temporal dimension.
249 Before to start norme, make sure that time and jpt are defined how
250 they have to!
251</div>
252       
253          <h3>Other attributes</h3>
254         
255         
256          <h4>Uses routines</h4><div class="preformat">
257 common.pro
258</div>
259         
260         
261         
262       
263          <h3>Statistics</h3>
264          <table class="statistics">
265            <tr><td>McCabe cyclic</td><td>         127</td></tr>
266            <tr><td>McCabe essential</td><td>           1</td></tr>
267            <tr><td>McCabe modular design</td><td>           1</td></tr>
268          </table>
269         
270       
271        </div>
272       
273      </div>
274
275     
276
277      <div id="tagline">Produced by IDLdoc 2.0.</div>
278
279    </div>
280
281  </body>
282</html>
Note: See TracBrowser for help on using the repository browser.