Changeset 338 for trunk/SRC/Documentation/idldoc_assistant_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_assistant_output/ToBeReviewed/STATISTICS/a_timecorrelate.html
r290 r338 64 64 65 65 66 Same function as A_CORRELATEbut accept array (until 466 Same function as <a href="/Applications/itt/idl64/help/online_help/A_CORRELATE.html">A_CORRELATE</a> but accept array (until 4 67 67 dimension) for input and do the autocorrelation or the 68 68 autocovariance along the time dimension which must be the last … … 74 74 75 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 262 2007-08-21 14:19:32Z 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"/> 76 225 77 226 78 <a name="#_a_timecorrelate"></a> … … 230 82 </font></h2> 231 83 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>84 <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>, <a href="#_a_timecorrelate_keyword_NVAL">NVAL</a>=<i>NVAL</i>)</font></p> 233 85 234 86 … … 272 124 273 125 274 A scalar or n-element s vector, in the interval [-(n-2),(n-2)],275 of type integer that specifies the absolute distance(s) between 126 A scalar or n-element vector, in the interval [-(n-2), (n-2)], 127 of type integer that specifies the absolute distance(s) between 276 128 indexed elements of X. 277 129 … … 317 169 318 170 171 <a name="#_a_timecorrelate_keyword_NVAL"></a> 172 <h4>NVAL 173 174 175 176 177 178 179 180 181 </h4> 182 183 184 A named variable that, on exit, contains the number of valid 185 observations (not NAN) 186 187 319 188 320 189 321 190 <h3>Examples</h3><pre> 322 Define an n-element ssample population.191 Define an n-element sample population. 323 192 IDL> x = [3.73, 3.67, 3.77, 3.83, 4.67, 5.87, 6.70, 6.97, 6.40, 5.57] 324 193 … … 333 202 334 203 <h4>Version</h4> 335 $Id: a_timecorrelate.pro 262 2007-08-21 14:19:32Z pinsard$204 $Id: a_timecorrelate.pro 335 2008-03-07 15:09:25Z smasson $ 336 205 337 206 <h4>History</h4>
Note: See TracChangeset
for help on using the changeset viewer.
