Changeset 338 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STATISTICS/a_timecorrelate.html
- Timestamp:
- 03/20/08 23:06:02 (16 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STATISTICS/a_timecorrelate.html
r290 r338 72 72 <div id="secondary_navbar"> 73 73 74 <a href="a_correlate2d.html"><<prev file</a> | <a href="c_timecorrelate.html">next file >></a> <a href="a_timecorrelate.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>74 <a href="a_correlate2d.html"><<prev file</a> | <a href="c_timecorrelate.html">next file >></a> <a href="a_timecorrelate.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a> summary: fields | routine details: <a href="#routine_details">routine</a> 75 75 76 76 </div> … … 90 90 91 91 92 Same function as A_CORRELATEbut accept array (until 492 Same function as <a href="/Applications/itt/idl64/help/online_help/A_CORRELATE.html">A_CORRELATE</a> but accept array (until 4 93 93 dimension) for input and do the autocorrelation or the 94 94 autocovariance along the time dimension which must be the last … … 106 106 107 107 108 <div id="routine_summary">109 <h2>Routine summary</h2>110 111 <dl>112 113 <dt><p><a href="#_timeauto_cov"><span class="result">result = </span>timeauto_cov(<span class="result">x, m, nt</span>, DOUBLE=<span class="result">DOUBLE</span>, ZERO2NAN=<span class="result">ZERO2NAN</span>)</a></p><dt>114 <dd> </dd>115 116 <dt><p><a href="#_a_timecorrelate"><span class="result">result = </span>a_timecorrelate(<span class="result">x, lag</span>, COVARIANCE=<span class="result">COVARIANCE</span>, DOUBLE=<span class="result">DOUBLE</span>)</a></p><dt>117 <dd> </dd>118 119 </dl>120 </div>121 122 108 123 109 <div id="routine_details"> 124 110 125 111 126 <div class="routine_details" id="_ timeauto_cov">127 128 <h2><a class="top" href="#container">top</a> timeauto_cov<span class="categories">112 <div class="routine_details" id="_a_timecorrelate"> 113 114 <h2><a class="top" href="#container">top</a>a_timecorrelate <span class="categories"> 129 115 Statistics 130 116 </span></h2> 131 117 132 118 <p class="header"> 133 <span class="result">result = </span> timeauto_cov(<span class="result"><a href="#_timeauto_cov_param_x">x</a>, <a href="#_timeauto_cov_param_m">m</a>, <a href="#_timeauto_cov_param_nt">nt</a></span>, <a href="#_timeauto_cov_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>, <a href="#_timeauto_cov_keyword_ZERO2NAN">ZERO2NAN</a>=<span class="result">ZERO2NAN</span>)</p>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> 134 120 135 121 <div class="comments"> … … 142 128 143 129 144 <h4 id="_ timeauto_cov_param_x">x 130 <h4 id="_a_timecorrelate_param_x">x 145 131 <span class="attr">in</span> 146 132 … … 158 144 </div> 159 145 160 <h4 id="_ timeauto_cov_param_m">m 161 162 163 164 165 166 146 <h4 id="_a_timecorrelate_param_lag">lag 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> 167 153 168 154 … … 170 156 171 157 <div class="comments"> 172 </div> 173 174 <h4 id="_timeauto_cov_param_nt">nt 175 176 177 178 179 180 181 182 183 </h4> 184 185 <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. 186 161 </div> 187 162 … … 193 168 <h3>Keywords</h3> 194 169 195 <h4 id="_timeauto_cov_keyword_DOUBLE">DOUBLE 170 <h4 id="_a_timecorrelate_keyword_COVARIANCE">COVARIANCE 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 196 187 197 188 … … 209 200 </div> 210 201 211 <h4 id="_ timeauto_cov_keyword_ZERO2NAN">ZERO2NAN 202 <h4 id="_a_timecorrelate_keyword_NVAL">NVAL 212 203 213 204 … … 221 212 222 213 <div class="comments"> 214 A named variable that, on exit, contains the number of valid 215 observations (not NAN) 223 216 </div> 224 217 … … 226 219 227 220 <h3>Examples</h3><div class="preformat"> 228 </div> 229 <h3>Version history</h3> 230 231 <h4>Version</h4><div class="preformat"> 232 $Id: a_timecorrelate.pro 262 2007-08-21 14:19:32Z pinsard $ 233 </div> 234 <h4>History</h4><div class="preformat"> 235 </div> 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 <h3>Statistics</h3> 253 <table class="statistics"> 254 <tr><td>McCabe cyclic</td><td> 8</td></tr> 255 <tr><td>McCabe essential</td><td> 1</td></tr> 256 <tr><td>McCabe modular design</td><td> 1</td></tr> 257 </table> 258 259 260 </div> 261 262 263 <div class="routine_details" id="_a_timecorrelate"> 264 265 <h2><a class="top" href="#container">top</a>a_timecorrelate <span class="categories"> 266 Statistics 267 </span></h2> 268 269 <p class="header"> 270 <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>)</p> 271 272 <div class="comments"> 273 </div> 274 275 276 277 278 <h3>Parameters</h3> 279 280 281 <h4 id="_a_timecorrelate_param_x">x 282 <span class="attr">in</span> 283 284 285 <span class="attr">required</span> 286 287 <span class="attr">type:</span> <span class="value">array</span> 288 289 290 </h4> 291 292 <div class="comments"> 293 An array which last dimension is the time dimension so 294 size n. 295 </div> 296 297 <h4 id="_a_timecorrelate_param_lag">lag 298 <span class="attr">in</span> 299 300 301 <span class="attr">required</span> 302 303 <span class="attr">type:</span> <span class="value">scalar or vector</span> 304 305 306 </h4> 307 308 <div class="comments"> 309 A scalar or n-elements vector, in the interval [-(n-2),(n-2)], 310 of type integer that specifies the absolute distance(s) between 311 indexed elements of X. 312 </div> 313 314 315 316 317 318 319 <h3>Keywords</h3> 320 321 <h4 id="_a_timecorrelate_keyword_COVARIANCE">COVARIANCE 322 323 324 325 326 327 328 329 330 </h4> 331 332 <div class="comments"> 333 If set to a non-zero value, the sample autocovariance 334 is computed. 335 </div> 336 337 <h4 id="_a_timecorrelate_keyword_DOUBLE">DOUBLE 338 339 340 341 342 343 344 345 346 </h4> 347 348 <div class="comments"> 349 If set to a non-zero value, computations are done in 350 double precision arithmetic. 351 </div> 352 353 354 355 <h3>Examples</h3><div class="preformat"> 356 Define an n-elements sample population. 221 Define an n-element sample population. 357 222 IDL> x = [3.73, 3.67, 3.77, 3.83, 4.67, 5.87, 6.70, 6.97, 6.40, 5.57] 358 223 … … 367 232 368 233 <h4>Version</h4><div class="preformat"> 369 $Id: a_timecorrelate.pro 262 2007-08-21 14:19:32Z pinsard$234 $Id: a_timecorrelate.pro 335 2008-03-07 15:09:25Z smasson $ 370 235 </div> 371 236 <h4>History</h4><div class="preformat"> … … 395 260 <h3>Statistics</h3> 396 261 <table class="statistics"> 397 <tr><td>McCabe cyclic</td><td> 1 3</td></tr>262 <tr><td>McCabe cyclic</td><td> 14</td></tr> 398 263 <tr><td>McCabe essential</td><td> 1</td></tr> 399 264 <tr><td>McCabe modular design</td><td> 1</td></tr>
Note: See TracChangeset
for help on using the changeset viewer.
