source: trunk/SRC/Documentation/idldoc_html_output/Obsolete/norme.html

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

update documentation
File size: 7.1 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="../../../Obsolete//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="nlecserie.html">&lt;&lt;prev file</a> | <a href="strrepl.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">Obsolete/</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 vectors field located on Arakawa C-grid
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_norme">
105
106          <h2><a class="top" href="#container">top</a>norme <span class="warning">obsolete</span> </h2>
107       
108          <p class="header">
109            <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>
110       
111          <div class="comments">
112</div>
113
114          <h3>Return value</h3><div class="preformat">
115 A 2D (xy), 3D (xyz or yt), 4D (xyzt) Array
116</div>
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_norme_param_composanteu">composanteu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125             
126              <span class="attr">required</span>
127             
128             
129             
130             
131            </h4>
132       
133          <div class="comments">
134 Matrix representing the zonal coordinates (at U/V point) of a field of vectors
135 A 2D (xy), 3D (xyz or yt), 4D (xyzt) or a structure readable by
136 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt), 4D (xyzt) array.
137 Note that the dimension of the array must suit the domain dimension.
138</div>
139           
140            <h4 id="_norme_param_composantev">composantev&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142             
143             
144              <span class="attr">required</span>
145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments">
152 Matrix representing the meridional coordinates (at V/U point) of a field of vectors
153 A 2D (xy), 3D (xyz or yt), 4D (xyzt) or a structure readable by
154 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt), 4D (xyzt) array.
155 Note that the dimension of the array must suit the domain dimension.
156</div>
157           
158
159         
160
161         
162
163            <h3>Keywords</h3>
164           
165            <h4 id="_norme_keyword_BOXZOOM">BOXZOOM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166             
167             
168             
169             
170             
171             
172             
173             
174            </h4>
175       
176            <div class="comments">
177 boxzoom on which do the average (by default the domain selected
178 by the last <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a> done)
179</div>
180           
181            <h4 id="_norme_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182             
183             
184             
185             
186             
187             
188             
189             
190            </h4>
191       
192            <div class="comments">
193 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
194       'xzt' 'yzt' 'xyzt' Direction on which do averages
195</div>
196           
197            <h4 id="_norme_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198             
199             
200             
201             
202             
203             
204             
205             
206            </h4>
207       
208            <div class="comments"></div>
209           
210         
211
212          <h3>Examples</h3><div class="preformat">
213 To calculate the average of the norme of streams on all the domain
214 between 0 and 50:
215   IDL> res=norme(un,vn,boxzoom=[0,50],dir='xyz')
216</div>
217          <h3>Version history</h3>
218         
219          <h4>Version</h4><div class="preformat">
220 $Id: norme.pro 371 2008-08-07 09:32:02Z pinsard $
221</div>
222          <h4>History</h4><div class="preformat">
223 9/6/1999 Sebastien Masson (smasson@lodyc.jussieu.fr)
224 December 2007: Sebastien Masson, move to obsolete
225                       
226</div>
227         
228         
229          <h3>Known issues</h3>
230          <h4>Obsolete</h4><div class="preformat">
231</div>
232         
233         
234          <h4>Restrictions</h4><div class="preformat">
235 The norm is calculated on points T. To do this calculation, we average
236 field U and V on points T before calculate the norme. At the edge of
237 coast and of domain, we can not calculate fields U and V at points T,
238 that is why these points are at value !values.f_nan.
239
240 When we calculate on a reduce geographic domain, field U and V have not
241 necessarily the same number of point. In this case, we recut U and V to
242 keep only common points. We profit of this to redo a <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a> which redefine
243 a geographic domain on which fields U and V are extracted on same points
244
245 To know what type of array we work with, we  test its size and dates
246 gave by time[0] and time[jpt-1] to know if thee is a temporal dimension.
247 Before to start norme, make sure that time and jpt are defined how
248 they have to!
249</div>
250       
251          <h3>Other attributes</h3>
252         
253         
254          <h4>Uses routines</h4><div class="preformat">
255 <a href="..//Obsolete/common.html">common</a>
256</div>
257         
258         
259         
260       
261          <h3>Statistics</h3>
262          <table class="statistics">
263            <tr><td>McCabe cyclic</td><td>           9</td></tr>
264            <tr><td>McCabe essential</td><td>           1</td></tr>
265            <tr><td>McCabe modular design</td><td>           1</td></tr>
266          </table>
267         
268       
269        </div>
270       
271      </div>
272
273     
274
275      <div id="tagline">Produced by IDLdoc 2.0.</div>
276
277    </div>
278
279  </body>
280</html>
Note: See TracBrowser for help on using the repository browser.