| 1 | |
|---|
| 2 | |
|---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 4 | <head> |
|---|
| 5 | <title>a_timecorrelate.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="a_correlate2d.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="c_timecorrelate.html"><img src="./../../next.gif" border="0" alt="Next"></a></td> |
|---|
| 53 | </tr> |
|---|
| 54 | </table> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <h1><font size="-2">ToBeReviewed/STATISTICS/</font></h1> |
|---|
| 58 | <h2>a_timecorrelate.pro</h2> |
|---|
| 59 | |
|---|
| 60 | <dl> |
|---|
| 61 | </dl> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | Same function as A_CORRELATE but accept array (until 4 |
|---|
| 67 | dimension) for input and do the autocorrelation or the |
|---|
| 68 | autocovariance along the time dimension which must be the last |
|---|
| 69 | one of the input array. |
|---|
| 70 | |
|---|
| 71 | This function computes the autocorrelation Px(L) or autocovariance |
|---|
| 72 | Rx(L) of a sample population X as a function of the lag (L). |
|---|
| 73 | |
|---|
| 74 | |
|---|
| 75 | |
|---|
| 76 | <h2>Routine summary</h2> |
|---|
| 77 | |
|---|
| 78 | <dl> |
|---|
| 79 | |
|---|
| 80 | <dt><a href="#_timeauto_cov"><i>result = </i>timeauto_cov(<i>X, M, nT</i>, Double=<i>Double</i>, zero2nan=<i>zero2nan</i>)</a><dt> |
|---|
| 81 | <dd><font size="-1"> </font></dd> |
|---|
| 82 | |
|---|
| 83 | <dt><a href="#_a_timecorrelate"><i>result = </i>a_timecorrelate(<i>X, Lag</i>, COVARIANCE=<i>COVARIANCE</i>, DOUBLE=<i>DOUBLE</i>)</a><dt> |
|---|
| 84 | <dd><font size="-1"> </font></dd> |
|---|
| 85 | |
|---|
| 86 | </dl> |
|---|
| 87 | |
|---|
| 88 | <p> </p> |
|---|
| 89 | |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | <a name="#_timeauto_cov"></a> |
|---|
| 93 | |
|---|
| 94 | <h2>timeauto_cov <font size="-1" color="#006633"> |
|---|
| 95 | Statistics |
|---|
| 96 | </font></h2> |
|---|
| 97 | |
|---|
| 98 | <p><font face="Courier"><i>result = </i>timeauto_cov(<i><a href="#_timeauto_cov_keyword_X">X</a>, <a href="#_timeauto_cov_keyword_M">M</a>, <a href="#_timeauto_cov_keyword_nT">nT</a></i>, <a href="#_timeauto_cov_keyword_Double">Double</a>=<i>Double</i>, <a href="#_timeauto_cov_keyword_zero2nan">zero2nan</a>=<i>zero2nan</i>)</font></p> |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | |
|---|
| 106 | <h3>Parameters</h3> |
|---|
| 107 | |
|---|
| 108 | |
|---|
| 109 | <a name="#_timeauto_cov_keyword_X"></a> |
|---|
| 110 | <h4>X |
|---|
| 111 | <font size="-1" color="#006633">in</font> |
|---|
| 112 | |
|---|
| 113 | |
|---|
| 114 | <font size="-1" color="#006633">required</font> |
|---|
| 115 | |
|---|
| 116 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array</i></font> |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | </h4> |
|---|
| 120 | |
|---|
| 121 | |
|---|
| 122 | An array which last dimension is the time dimension so |
|---|
| 123 | size n. |
|---|
| 124 | |
|---|
| 125 | |
|---|
| 126 | |
|---|
| 127 | <a name="#_timeauto_cov_keyword_M"></a> |
|---|
| 128 | <h4>M |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | |
|---|
| 133 | |
|---|
| 134 | |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | </h4> |
|---|
| 138 | |
|---|
| 139 | |
|---|
| 140 | |
|---|
| 141 | |
|---|
| 142 | |
|---|
| 143 | <a name="#_timeauto_cov_keyword_nT"></a> |
|---|
| 144 | <h4>nT |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | </h4> |
|---|
| 154 | |
|---|
| 155 | |
|---|
| 156 | |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | <h3>Keywords</h3> |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | <a name="#_timeauto_cov_keyword_Double"></a> |
|---|
| 165 | <h4>Double |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | </h4> |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | If set to a non-zero value, computations are done in |
|---|
| 178 | double precision arithmetic. |
|---|
| 179 | |
|---|
| 180 | |
|---|
| 181 | <a name="#_timeauto_cov_keyword_zero2nan"></a> |
|---|
| 182 | <h4>zero2nan |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | </h4> |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | <h3>Examples</h3><pre> |
|---|
| 199 | |
|---|
| 200 | </pre><h3>Version history</h3> |
|---|
| 201 | |
|---|
| 202 | <h4>Version</h4> |
|---|
| 203 | $Id: a_timecorrelate.pro 242 2007-04-06 08:35:17Z pinsard $ |
|---|
| 204 | |
|---|
| 205 | <h4>History</h4> |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | <font size="-3"><p> </p></font> |
|---|
| 224 | <hr size="1" color="#CCCCCC"/> |
|---|
| 225 | |
|---|
| 226 | <a name="#_a_timecorrelate"></a> |
|---|
| 227 | |
|---|
| 228 | <h2>a_timecorrelate <font size="-1" color="#006633"> |
|---|
| 229 | Statistics |
|---|
| 230 | </font></h2> |
|---|
| 231 | |
|---|
| 232 | <p><font face="Courier"><i>result = </i>a_timecorrelate(<i><a href="#_a_timecorrelate_keyword_X">X</a>, <a href="#_a_timecorrelate_keyword_Lag">Lag</a></i>, <a href="#_a_timecorrelate_keyword_COVARIANCE">COVARIANCE</a>=<i>COVARIANCE</i>, <a href="#_a_timecorrelate_keyword_DOUBLE">DOUBLE</a>=<i>DOUBLE</i>)</font></p> |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | <h3>Parameters</h3> |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | <a name="#_a_timecorrelate_keyword_X"></a> |
|---|
| 244 | <h4>X |
|---|
| 245 | <font size="-1" color="#006633">in</font> |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | <font size="-1" color="#006633">required</font> |
|---|
| 249 | |
|---|
| 250 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array</i></font> |
|---|
| 251 | |
|---|
| 252 | |
|---|
| 253 | </h4> |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | An array which last dimension is the time dimension so |
|---|
| 257 | size n. |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | <a name="#_a_timecorrelate_keyword_Lag"></a> |
|---|
| 262 | <h4>Lag |
|---|
| 263 | <font size="-1" color="#006633">in</font> |
|---|
| 264 | |
|---|
| 265 | |
|---|
| 266 | <font size="-1" color="#006633">required</font> |
|---|
| 267 | |
|---|
| 268 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar or vector</i></font> |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | </h4> |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | A scalar or n-elements vector, in the interval [-(n-2),(n-2)], |
|---|
| 275 | of type integer that specifies the absolute distance(s) between |
|---|
| 276 | indexed elements of X. |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | <h3>Keywords</h3> |
|---|
| 283 | |
|---|
| 284 | |
|---|
| 285 | <a name="#_a_timecorrelate_keyword_COVARIANCE"></a> |
|---|
| 286 | <h4>COVARIANCE |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | </h4> |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | If set to a non-zero value, the sample autocovariance |
|---|
| 299 | is computed. |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | <a name="#_a_timecorrelate_keyword_DOUBLE"></a> |
|---|
| 303 | <h4>DOUBLE |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | </h4> |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | If set to a non-zero value, computations are done in |
|---|
| 316 | double precision arithmetic. |
|---|
| 317 | |
|---|
| 318 | |
|---|
| 319 | |
|---|
| 320 | |
|---|
| 321 | <h3>Examples</h3><pre> |
|---|
| 322 | Define an n-elements sample population. |
|---|
| 323 | IDL> x = [3.73, 3.67, 3.77, 3.83, 4.67, 5.87, 6.70, 6.97, 6.40, 5.57] |
|---|
| 324 | |
|---|
| 325 | Compute the autocorrelation of X for LAG = -3, 0, 1, 3, 4, 8 |
|---|
| 326 | IDL> lag = [-3, 0, 1, 3, 4, 8] |
|---|
| 327 | IDL> result = a_correlate(x, lag) |
|---|
| 328 | |
|---|
| 329 | The result should be: |
|---|
| 330 | [0.0146185, 1.00000, 0.810879, 0.0146185, -0.325279, -0.151684] |
|---|
| 331 | |
|---|
| 332 | </pre><h3>Version history</h3> |
|---|
| 333 | |
|---|
| 334 | <h4>Version</h4> |
|---|
| 335 | $Id: a_timecorrelate.pro 242 2007-04-06 08:35:17Z pinsard $ |
|---|
| 336 | |
|---|
| 337 | <h4>History</h4> |
|---|
| 338 | 24/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 339 | |
|---|
| 340 | Based on the A_CORRELATE procedure of IDL |
|---|
| 341 | INTRODUCTION TO STATISTICAL TIME SERIES |
|---|
| 342 | Wayne A. Fuller |
|---|
| 343 | ISBN 0-471-28715-6 |
|---|
| 344 | |
|---|
| 345 | |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | |
|---|
| 349 | |
|---|
| 350 | |
|---|
| 351 | |
|---|
| 352 | |
|---|
| 353 | |
|---|
| 354 | |
|---|
| 355 | |
|---|
| 356 | |
|---|
| 357 | |
|---|
| 358 | |
|---|
| 359 | |
|---|
| 360 | |
|---|
| 361 | <font size="-3"><p> </p></font> |
|---|
| 362 | <hr size="1" color="#CCCCCC"/> |
|---|
| 363 | |
|---|
| 364 | |
|---|
| 365 | |
|---|
| 366 | |
|---|
| 367 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
|---|
| 368 | |
|---|
| 369 | </body> |
|---|
| 370 | </html> |
|---|
