source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STATISTICS/c_timecorrelate.html @ 402

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

update documentation
File size: 10.1 KB
RevLine 
[89]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>
[104]9    <title>c_timecorrelate.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="c_timecorrelate.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../../ToBeReviewed/STATISTICS//c_timecorrelate.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[338]74<a href="a_timecorrelate.html">&lt;&lt;prev file</a> | <a href="skewness_4d.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="c_timecorrelate.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/STATISTICS/</a></h1>
[89]82      <h2 class="pro_file">c_timecorrelate.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[151]89      <div id="file_comments">
[157]90
91
[151]92 This function computes the "time cross correlation" Pxy(L) or
93 the "time cross covariance" between 2 arrays (this is some
[338]94 kind of <a href="/Applications/itt/idl64/help/online_help/C_CORRELATE.html">C_CORRELATE</a> but for multidimensional arrays) as a
[151]95 function of the lag (L).
96</div>
[89]97
98     
99
100     
101
102     
103
104     
105      <div id="routine_summary">               
106        <h2>Routine summary</h2>
107       
108        <dl>
109         
[290]110          <dt><p><a href="#_timecross_cov"><span class="result">result = </span>timecross_cov(<span class="result">xd, yd, m, nt, ndim</span>, DOUBLE=<span class="result">DOUBLE</span>, ZERO2NAN=<span class="result">ZERO2NAN</span>)</a></p><dt>
[234]111          <dd> </dd>   
[89]112         
[290]113          <dt><p><a href="#_c_timecorrelate"><span class="result">result = </span>c_timecorrelate(<span class="result">x, y, lag</span>, COVARIANCE=<span class="result">COVARIANCE</span>, DOUBLE=<span class="result">DOUBLE</span>)</a></p><dt>
[242]114          <dd> </dd>   
[89]115               
116        </dl>
117      </div>
118     
119
120      <div id="routine_details">
121       
122
[163]123        <div class="routine_details" id="_timecross_cov">
[89]124
[163]125          <h2><a class="top" href="#container">top</a>timecross_cov <span class="categories">
[157]126 Statistics
127</span></h2>
[89]128       
129          <p class="header">
[290]130            <span class="result">result = </span>timecross_cov(<span class="result"><a href="#_timecross_cov_param_xd">xd</a>, <a href="#_timecross_cov_param_yd">yd</a>, <a href="#_timecross_cov_param_m">m</a>, <a href="#_timecross_cov_param_nt">nt</a>, <a href="#_timecross_cov_param_ndim">ndim</a></span>, <a href="#_timecross_cov_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>, <a href="#_timecross_cov_keyword_ZERO2NAN">ZERO2NAN</a>=<span class="result">ZERO2NAN</span>)</p>
[89]131       
[234]132          <div class="comments">
133</div>
[89]134
135         
136
137         
138            <h3>Parameters</h3>
139       
140           
[290]141            <h4 id="_timecross_cov_param_xd">xd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]142             
143             
144             
145             
146             
147             
148             
149             
150            </h4>
151       
[157]152          <div class="comments">
153</div>
[89]154           
[290]155            <h4 id="_timecross_cov_param_yd">yd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]156             
157             
158             
159             
160             
161             
162             
163             
164            </h4>
165       
[157]166          <div class="comments">
167</div>
[89]168           
[290]169            <h4 id="_timecross_cov_param_m">m&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]170             
171             
172             
173             
174             
175             
176             
177             
178            </h4>
179       
[157]180          <div class="comments">
181</div>
[89]182           
[290]183            <h4 id="_timecross_cov_param_nt">nt&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]184             
185             
186             
187             
188             
189             
190             
191             
192            </h4>
193       
[157]194          <div class="comments">
195</div>
[89]196           
[290]197            <h4 id="_timecross_cov_param_ndim">ndim&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]198             
199             
200             
201             
202             
203             
204             
205             
206            </h4>
207       
[157]208          <div class="comments">
209</div>
[89]210           
211
212         
213
214         
215
216            <h3>Keywords</h3>
217           
[290]218            <h4 id="_timecross_cov_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]219             
220             
221             
222             
223             
224             
225             
226             
227            </h4>
228       
[157]229            <div class="comments">
230 If set to a non-zero value, computations are done in
231 double precision arithmetic.
232</div>
[89]233           
[163]234            <h4 id="_timecross_cov_keyword_ZERO2NAN">ZERO2NAN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]235             
236             
237             
238             
239             
240             
241             
242             
243            </h4>
244       
[157]245            <div class="comments">
246</div>
[89]247           
248         
249
[157]250          <h3>Examples</h3><div class="preformat">
251</div>
252          <h3>Version history</h3>
[89]253         
[157]254          <h4>Version</h4><div class="preformat">
[402]255 $Id: c_timecorrelate.pro 371 2008-08-07 09:32:02Z pinsard $
[157]256</div>
257          <h4>History</h4><div class="preformat">
258</div>
[89]259         
260         
261         
262         
263         
264         
265         
266       
267         
268         
269         
270         
271         
272         
273         
274       
[163]275          <h3>Statistics</h3>
276          <table class="statistics">
277            <tr><td>McCabe cyclic</td><td>           7</td></tr>
278            <tr><td>McCabe essential</td><td>           1</td></tr>
279            <tr><td>McCabe modular design</td><td>           1</td></tr>
280          </table>
[89]281         
282       
283        </div>
284       
285
[163]286        <div class="routine_details" id="_c_timecorrelate">
[89]287
[163]288          <h2><a class="top" href="#container">top</a>c_timecorrelate <span class="categories">
[157]289 Statistics
[151]290</span></h2>
[89]291       
292          <p class="header">
[290]293            <span class="result">result = </span>c_timecorrelate(<span class="result"><a href="#_c_timecorrelate_param_x">x</a>, <a href="#_c_timecorrelate_param_y">y</a>, <a href="#_c_timecorrelate_param_lag">lag</a></span>, <a href="#_c_timecorrelate_keyword_COVARIANCE">COVARIANCE</a>=<span class="result">COVARIANCE</span>, <a href="#_c_timecorrelate_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>)</p>
[89]294       
[242]295          <div class="comments">
296</div>
[89]297
298         
299
300         
301            <h3>Parameters</h3>
302       
303           
[290]304            <h4 id="_c_timecorrelate_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[151]305              <span class="attr">in</span>
[89]306             
307             
[151]308              <span class="attr">required</span>
[89]309             
[163]310              <span class="attr">type:</span> <span class="value">array</span>
[89]311             
312             
313            </h4>
314       
[151]315          <div class="comments">
[242]316 An array which last dimension is the time dimension of
[151]317 size n, float or double.
318</div>
[89]319           
[290]320            <h4 id="_c_timecorrelate_param_y">y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[151]321              <span class="attr">in</span>
[89]322             
323             
[151]324              <span class="attr">required</span>
[89]325             
[163]326              <span class="attr">type:</span> <span class="value">array</span>
[89]327             
328             
329            </h4>
330       
[151]331          <div class="comments">
[242]332 An array which last dimension is the time dimension of
[151]333 size n, float or double.
334</div>
[89]335           
[290]336            <h4 id="_c_timecorrelate_param_lag">lag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[151]337              <span class="attr">in</span>
[89]338             
339             
[151]340              <span class="attr">required</span>
[89]341             
[163]342              <span class="attr">type:</span> <span class="value">scalar or vector</span>
[89]343             
344             
345            </h4>
346       
[151]347          <div class="comments">
[242]348 A scalar or n-elements vector, in the interval [-(n-2),(n-2)],
[151]349 of type integer that specifies the absolute distance(s) between
350 indexed elements of X.
351</div>
[89]352           
353
354         
355
356         
357
358            <h3>Keywords</h3>
359           
[290]360            <h4 id="_c_timecorrelate_keyword_COVARIANCE">COVARIANCE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]361             
362             
363             
364             
365             
366             
367             
368             
369            </h4>
370       
[151]371            <div class="comments">
[234]372 If set to a non-zero value, the sample cross
[151]373 covariance is computed.
374</div>
[89]375           
[290]376            <h4 id="_c_timecorrelate_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]377             
378             
379             
380             
381             
382             
383             
384             
385            </h4>
386       
[151]387            <div class="comments">
388 If set to a non-zero value, computations are done in
389 double precision arithmetic.
390</div>
[89]391           
392         
393
[151]394          <h3>Examples</h3><div class="preformat">
[234]395
[242]396 Define two n-elements sample populations.
[402]397   IDL> x = [3.73, 3.67, 3.77, 3.83, 4.67, 5.87, 6.70, 6.97, 6.40, 5.57]
398   IDL> y = [2.31, 2.76, 3.02, 3.13, 3.72, 3.88, 3.97, 4.39, 4.34, 3.95]
[151]399
[242]400 Compute the cross correlation of X and Y for LAG = -5, 0, 1, 5, 6, 7
[402]401   IDL> lag = [-5, 0, 1, 5, 6, 7]
402   IDL> result = c_timecorrelate(x, y, lag)
[151]403
[242]404 The result should be:
405 [-0.428246, 0.914755, 0.674547, -0.405140, -0.403100, -0.339685]
[151]406</div>
407          <h3>Version history</h3>
[89]408         
[151]409          <h4>Version</h4><div class="preformat">
[402]410 $Id: c_timecorrelate.pro 371 2008-08-07 09:32:02Z pinsard $
[151]411</div>
[157]412          <h4>History</h4><div class="preformat">
413       - 01/03/2000 Sebastien Masson (smasson@lodyc.jussieu.fr)
414       Based on the C_CORRELATE procedure of IDL
[234]415       - August 2003 Sebastien Masson
[157]416       update according to the update made in C_CORRELATE by
417       W. Biagiotti and available in IDL 5.5
418
419       INTRODUCTION TO STATISTICAL TIME SERIES
420       Wayne A. Fuller
421       ISBN 0-471-28715-6
422</div>
[89]423         
424         
425         
426         
427         
428         
429         
430       
431         
432         
433         
434         
435         
436         
437         
438       
[163]439          <h3>Statistics</h3>
440          <table class="statistics">
441            <tr><td>McCabe cyclic</td><td>          33</td></tr>
442            <tr><td>McCabe essential</td><td>           1</td></tr>
443            <tr><td>McCabe modular design</td><td>           1</td></tr>
444          </table>
[89]445         
446       
447        </div>
448       
449      </div>
450
451     
452
453      <div id="tagline">Produced by IDLdoc 2.0.</div>
454
455    </div>
456
457  </body>
[249]458</html>
Note: See TracBrowser for help on using the repository browser.