source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STATISTICS/a_timecorrelate.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 6.4 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>a_timecorrelate.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="a_timecorrelate.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/STATISTICS//a_timecorrelate.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="a_correlate2d.html">&lt;&lt;prev file</a> | <a href="c_timecorrelate.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="a_timecorrelate.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/STATISTICS/</a></h1>
82      <h2 class="pro_file">a_timecorrelate.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90
91
92 Same function as <a href="/Applications/itt/idl64/help/online_help/A_CORRELATE.html">A_CORRELATE</a> but accept array (until 4
93 dimension) for input and do the autocorrelation or the
94 autocovariance along the time dimension which must be the last
95 one of the input array.
96
97 This function computes the autocorrelation Px(L) or autocovariance
98 Rx(L) of a sample population X as a function of the lag (L).
99</div>
100
101     
102
103     
104
105     
106
107     
108
109      <div id="routine_details">
110       
111
112        <div class="routine_details" id="_a_timecorrelate">
113
114          <h2><a class="top" href="#container">top</a>a_timecorrelate <span class="categories">
115 Statistics
116</span></h2>
117       
118          <p class="header">
119            <span class="result">result = </span>a_timecorrelate(<span class="result"><a href="#_a_timecorrelate_param_x">x</a>, <a href="#_a_timecorrelate_param_lag">lag</a></span>, <a href="#_a_timecorrelate_keyword_COVARIANCE">COVARIANCE</a>=<span class="result">COVARIANCE</span>, <a href="#_a_timecorrelate_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>, <a href="#_a_timecorrelate_keyword_NVAL">NVAL</a>=<span class="result">NVAL</span>)</p>
120       
121          <div class="comments">
122</div>
123
124         
125
126         
127            <h3>Parameters</h3>
128       
129           
130            <h4 id="_a_timecorrelate_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131              <span class="attr">in</span>
132             
133             
134              <span class="attr">required</span>
135             
136              <span class="attr">type:</span> <span class="value">array</span>
137             
138             
139            </h4>
140       
141          <div class="comments">
142 An array which last dimension is the time dimension so
143 size n.
144</div>
145           
146            <h4 id="_a_timecorrelate_param_lag">lag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147              <span class="attr">in</span>
148             
149             
150              <span class="attr">required</span>
151             
152              <span class="attr">type:</span> <span class="value">scalar or vector</span>
153             
154             
155            </h4>
156       
157          <div class="comments">
158 A scalar or n-element vector, in the interval [-(n-2), (n-2)],
159 of type integer that specifies the absolute distance(s) between
160 indexed elements of X.
161</div>
162           
163
164         
165
166         
167
168            <h3>Keywords</h3>
169           
170            <h4 id="_a_timecorrelate_keyword_COVARIANCE">COVARIANCE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
171             
172             
173             
174             
175             
176             
177             
178             
179            </h4>
180       
181            <div class="comments">
182 If set to a non-zero value, the sample autocovariance
183 is computed.
184</div>
185           
186            <h4 id="_a_timecorrelate_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
187             
188             
189             
190             
191             
192             
193             
194             
195            </h4>
196       
197            <div class="comments">
198 If set to a non-zero value, computations are done in
199 double precision arithmetic.
200</div>
201           
202            <h4 id="_a_timecorrelate_keyword_NVAL">NVAL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
203             
204             
205             
206             
207             
208             
209             
210             
211            </h4>
212       
213            <div class="comments">
214 A named variable that, on exit, contains the number of valid
215 observations (not NAN)
216</div>
217           
218         
219
220          <h3>Examples</h3><div class="preformat">
221 Define an n-element sample population.
222 IDL> x = [3.73, 3.67, 3.77, 3.83, 4.67, 5.87, 6.70, 6.97, 6.40, 5.57]
223
224 Compute the autocorrelation of X for LAG = -3, 0, 1, 3, 4, 8
225 IDL> lag = [-3, 0, 1, 3, 4, 8]
226 IDL> result = a_correlate(x, lag)
227
228 The result should be:
229 [0.0146185, 1.00000, 0.810879, 0.0146185, -0.325279, -0.151684]
230</div>
231          <h3>Version history</h3>
232         
233          <h4>Version</h4><div class="preformat">
234 $Id: a_timecorrelate.pro 335 2008-03-07 15:09:25Z smasson $
235</div>
236          <h4>History</h4><div class="preformat">
237 24/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr)
238
239 Based on the A_CORRELATE procedure of IDL
240 INTRODUCTION TO STATISTICAL TIME SERIES
241 Wayne A. Fuller
242 ISBN 0-471-28715-6
243</div>
244         
245         
246         
247         
248         
249         
250         
251       
252         
253         
254         
255         
256         
257         
258         
259       
260          <h3>Statistics</h3>
261          <table class="statistics">
262            <tr><td>McCabe cyclic</td><td>          14</td></tr>
263            <tr><td>McCabe essential</td><td>           1</td></tr>
264            <tr><td>McCabe modular design</td><td>           1</td></tr>
265          </table>
266         
267       
268        </div>
269       
270      </div>
271
272     
273
274      <div id="tagline">Produced by IDLdoc 2.0.</div>
275
276    </div>
277
278  </body>
279</html>
Note: See TracBrowser for help on using the repository browser.