[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>a_correlate2d.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="a_correlate2d.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//a_correlate2d.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 documentation</td> |
---|
| 67 | </tr> |
---|
| 68 | </table> |
---|
| 69 | |
---|
| 70 | </div> |
---|
| 71 | |
---|
| 72 | <div id="secondary_navbar"> |
---|
| 73 | |
---|
[189] | 74 | << prev file | <a href="a_timecorrelate.html">next file >></a> <a href="a_correlate2d.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a> summary: fields | <a href="#routine_summary">routine</a> 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">a_correlate2d.pro</h2> |
---|
| 83 | |
---|
| 84 | <div id="file_attr"> |
---|
| 85 | <dl> |
---|
| 86 | </dl> |
---|
| 87 | </div> |
---|
| 88 | |
---|
[151] | 89 | <div id="file_comments"> |
---|
[157] | 90 | |
---|
| 91 | |
---|
| 92 | |
---|
[151] | 93 | This function computes the autocorrelation Px(K,L) or |
---|
| 94 | autocovariance Rx(K,L) of a sample population X[nx,ny] as a |
---|
| 95 | function of the lag (K,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="#_auto_cov2d"><span class="result">result = </span>auto_cov2d(<span class="result">x, lag</span>, DOUBLE=<span class="result">DOUBLE</span>, ZERO2NAN=<span class="result">ZERO2NAN</span>)</a></p><dt> |
---|
[157] | 111 | <dd> </dd> |
---|
[89] | 112 | |
---|
[290] | 113 | <dt><p><a href="#_a_correlate2d"><span class="result">result = </span>a_correlate2d(<span class="result">x, lag</span>, COVARIANCE=<span class="result">COVARIANCE</span>, DOUBLE=<span class="result">DOUBLE</span>)</a></p><dt> |
---|
[151] | 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="_auto_cov2d"> |
---|
[89] | 124 | |
---|
[163] | 125 | <h2><a class="top" href="#container">top</a>auto_cov2d <span class="categories"> |
---|
[157] | 126 | Statistics |
---|
| 127 | </span></h2> |
---|
[89] | 128 | |
---|
| 129 | <p class="header"> |
---|
[290] | 130 | <span class="result">result = </span>auto_cov2d(<span class="result"><a href="#_auto_cov2d_param_x">x</a>, <a href="#_auto_cov2d_param_lag">lag</a></span>, <a href="#_auto_cov2d_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>, <a href="#_auto_cov2d_keyword_ZERO2NAN">ZERO2NAN</a>=<span class="result">ZERO2NAN</span>)</p> |
---|
[89] | 131 | |
---|
[157] | 132 | <div class="comments"> |
---|
| 133 | </div> |
---|
[89] | 134 | |
---|
| 135 | |
---|
| 136 | |
---|
| 137 | |
---|
| 138 | <h3>Parameters</h3> |
---|
| 139 | |
---|
| 140 | |
---|
[290] | 141 | <h4 id="_auto_cov2d_param_x">x |
---|
[157] | 142 | <span class="attr">in</span> |
---|
[89] | 143 | |
---|
| 144 | |
---|
[157] | 145 | <span class="attr">required</span> |
---|
[89] | 146 | |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | </h4> |
---|
| 151 | |
---|
[157] | 152 | <div class="comments"> |
---|
| 153 | An 2 dimension Array [nx,ny] |
---|
| 154 | </div> |
---|
[89] | 155 | |
---|
[290] | 156 | <h4 id="_auto_cov2d_param_lag">lag |
---|
[157] | 157 | <span class="attr">in</span> |
---|
[89] | 158 | |
---|
| 159 | |
---|
[157] | 160 | <span class="attr">required</span> |
---|
[89] | 161 | |
---|
| 162 | |
---|
| 163 | |
---|
| 164 | |
---|
| 165 | </h4> |
---|
| 166 | |
---|
[157] | 167 | <div class="comments"> |
---|
| 168 | 2-element vector, in the intervals [-(nx-2), (nx-2)],[-(ny-2), (ny-2)], |
---|
| 169 | of type integer that specifies the absolute distance(s) between |
---|
| 170 | indexed elements of X. |
---|
| 171 | </div> |
---|
[89] | 172 | |
---|
| 173 | |
---|
| 174 | |
---|
| 175 | |
---|
| 176 | |
---|
| 177 | |
---|
| 178 | <h3>Keywords</h3> |
---|
| 179 | |
---|
[242] | 180 | <h4 id="_auto_cov2d_keyword_DOUBLE">DOUBLE |
---|
[89] | 181 | |
---|
| 182 | |
---|
| 183 | |
---|
| 184 | |
---|
| 185 | |
---|
| 186 | |
---|
| 187 | |
---|
| 188 | |
---|
| 189 | </h4> |
---|
| 190 | |
---|
[157] | 191 | <div class="comments"> |
---|
| 192 | If set to a non-zero value, computations are done in double precision arithmetic. |
---|
| 193 | </div> |
---|
[89] | 194 | |
---|
[242] | 195 | <h4 id="_auto_cov2d_keyword_ZERO2NAN">ZERO2NAN |
---|
[89] | 196 | |
---|
| 197 | |
---|
| 198 | |
---|
| 199 | |
---|
| 200 | |
---|
| 201 | |
---|
| 202 | |
---|
| 203 | |
---|
| 204 | </h4> |
---|
| 205 | |
---|
[157] | 206 | <div class="comments"> |
---|
| 207 | </div> |
---|
[89] | 208 | |
---|
| 209 | |
---|
| 210 | |
---|
| 211 | |
---|
[157] | 212 | <h3>Version history</h3> |
---|
[89] | 213 | |
---|
[157] | 214 | <h4>Version</h4><div class="preformat"> |
---|
[290] | 215 | $Id: a_correlate2d.pro 262 2007-08-21 14:19:32Z pinsard $ |
---|
[157] | 216 | </div> |
---|
| 217 | <h4>History</h4><div class="preformat"> |
---|
| 218 | 28/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
| 219 | Based on the A_CORRELATE procedure of IDL |
---|
| 220 | </div> |
---|
[89] | 221 | |
---|
| 222 | |
---|
| 223 | |
---|
| 224 | |
---|
| 225 | |
---|
| 226 | |
---|
| 227 | |
---|
| 228 | |
---|
| 229 | |
---|
| 230 | |
---|
| 231 | |
---|
| 232 | |
---|
| 233 | |
---|
| 234 | |
---|
| 235 | |
---|
| 236 | |
---|
[163] | 237 | <h3>Statistics</h3> |
---|
| 238 | <table class="statistics"> |
---|
| 239 | <tr><td>McCabe cyclic</td><td> 2</td></tr> |
---|
| 240 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
| 241 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
| 242 | </table> |
---|
[89] | 243 | |
---|
| 244 | |
---|
| 245 | </div> |
---|
| 246 | |
---|
| 247 | |
---|
[163] | 248 | <div class="routine_details" id="_a_correlate2d"> |
---|
[89] | 249 | |
---|
[163] | 250 | <h2><a class="top" href="#container">top</a>a_correlate2d <span class="categories"> |
---|
[157] | 251 | Statistics |
---|
[151] | 252 | </span></h2> |
---|
[89] | 253 | |
---|
| 254 | <p class="header"> |
---|
[290] | 255 | <span class="result">result = </span>a_correlate2d(<span class="result"><a href="#_a_correlate2d_param_x">x</a>, <a href="#_a_correlate2d_param_lag">lag</a></span>, <a href="#_a_correlate2d_keyword_COVARIANCE">COVARIANCE</a>=<span class="result">COVARIANCE</span>, <a href="#_a_correlate2d_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>)</p> |
---|
[89] | 256 | |
---|
[151] | 257 | <div class="comments"> |
---|
| 258 | </div> |
---|
[89] | 259 | |
---|
| 260 | |
---|
| 261 | |
---|
| 262 | |
---|
| 263 | <h3>Parameters</h3> |
---|
| 264 | |
---|
| 265 | |
---|
[290] | 266 | <h4 id="_a_correlate2d_param_x">x |
---|
[151] | 267 | <span class="attr">in</span> |
---|
[89] | 268 | |
---|
| 269 | |
---|
[151] | 270 | <span class="attr">required</span> |
---|
[89] | 271 | |
---|
| 272 | |
---|
| 273 | |
---|
| 274 | |
---|
| 275 | </h4> |
---|
| 276 | |
---|
[151] | 277 | <div class="comments"> |
---|
| 278 | An 2 dimension Array [nx,ny] |
---|
| 279 | </div> |
---|
[89] | 280 | |
---|
[290] | 281 | <h4 id="_a_correlate2d_param_lag">lag |
---|
[151] | 282 | <span class="attr">in</span> |
---|
[89] | 283 | |
---|
| 284 | |
---|
[151] | 285 | <span class="attr">required</span> |
---|
[89] | 286 | |
---|
| 287 | |
---|
| 288 | |
---|
| 289 | |
---|
| 290 | </h4> |
---|
| 291 | |
---|
[151] | 292 | <div class="comments"> |
---|
| 293 | 2-element vector, in the intervals [-(nx-2), (nx-2)],[-(ny-2), (ny-2)], |
---|
| 294 | of type integer that specifies the absolute distance(s) between |
---|
| 295 | indexed elements of X. |
---|
| 296 | </div> |
---|
[89] | 297 | |
---|
| 298 | |
---|
| 299 | |
---|
| 300 | |
---|
| 301 | |
---|
| 302 | |
---|
| 303 | <h3>Keywords</h3> |
---|
| 304 | |
---|
[290] | 305 | <h4 id="_a_correlate2d_keyword_COVARIANCE">COVARIANCE |
---|
[89] | 306 | |
---|
| 307 | |
---|
| 308 | |
---|
| 309 | |
---|
| 310 | |
---|
| 311 | |
---|
| 312 | |
---|
| 313 | |
---|
| 314 | </h4> |
---|
| 315 | |
---|
[151] | 316 | <div class="comments"> |
---|
| 317 | If set to a non-zero value, the sample autocovariance is computed. |
---|
| 318 | </div> |
---|
[89] | 319 | |
---|
[290] | 320 | <h4 id="_a_correlate2d_keyword_DOUBLE">DOUBLE |
---|
[89] | 321 | |
---|
| 322 | |
---|
| 323 | |
---|
| 324 | |
---|
| 325 | |
---|
| 326 | |
---|
| 327 | |
---|
| 328 | |
---|
| 329 | </h4> |
---|
| 330 | |
---|
[151] | 331 | <div class="comments"> |
---|
| 332 | If set to a non-zero value, computations are done in double precision arithmetic. |
---|
| 333 | </div> |
---|
[89] | 334 | |
---|
| 335 | |
---|
| 336 | |
---|
| 337 | |
---|
[151] | 338 | <h3>Version history</h3> |
---|
[89] | 339 | |
---|
[151] | 340 | <h4>Version</h4><div class="preformat"> |
---|
[290] | 341 | $Id: a_correlate2d.pro 262 2007-08-21 14:19:32Z pinsard $ |
---|
[151] | 342 | </div> |
---|
[157] | 343 | <h4>History</h4><div class="preformat"> |
---|
| 344 | 28/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
| 345 | Based on the A_CORRELATE procedure of IDL |
---|
| 346 | </div> |
---|
[89] | 347 | |
---|
| 348 | |
---|
| 349 | |
---|
| 350 | |
---|
| 351 | |
---|
| 352 | |
---|
| 353 | |
---|
| 354 | |
---|
| 355 | |
---|
| 356 | |
---|
| 357 | |
---|
| 358 | |
---|
| 359 | |
---|
| 360 | |
---|
| 361 | |
---|
| 362 | |
---|
[163] | 363 | <h3>Statistics</h3> |
---|
| 364 | <table class="statistics"> |
---|
| 365 | <tr><td>McCabe cyclic</td><td> 8</td></tr> |
---|
| 366 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
| 367 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
| 368 | </table> |
---|
[89] | 369 | |
---|
| 370 | |
---|
| 371 | </div> |
---|
| 372 | |
---|
| 373 | </div> |
---|
| 374 | |
---|
| 375 | |
---|
| 376 | |
---|
| 377 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 378 | |
---|
| 379 | </div> |
---|
| 380 | |
---|
| 381 | </body> |
---|
[249] | 382 | </html> |
---|