1 | |
---|
2 | |
---|
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
4 | <head> |
---|
5 | <title>a_correlate2d.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=""><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="a_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_correlate2d.pro</h2> |
---|
59 | |
---|
60 | <dl> |
---|
61 | </dl> |
---|
62 | |
---|
63 | |
---|
64 | |
---|
65 | |
---|
66 | |
---|
67 | This function computes the autocorrelation Px(K,L) or |
---|
68 | autocovariance Rx(K,L) of a sample population X[nx,ny] as a |
---|
69 | function of the lag (K,L). |
---|
70 | |
---|
71 | |
---|
72 | |
---|
73 | <h2>Routine summary</h2> |
---|
74 | |
---|
75 | <dl> |
---|
76 | |
---|
77 | <dt><a href="#_auto_cov2d"><i>result = </i>auto_cov2d(<i>X, Lag</i>, Double=<i>Double</i>, zero2nan=<i>zero2nan</i>)</a><dt> |
---|
78 | <dd><font size="-1"> </font></dd> |
---|
79 | |
---|
80 | <dt><a href="#_a_correlate2d"><i>result = </i>a_correlate2d(<i>X, Lag</i>, Covariance=<i>Covariance</i>, Double=<i>Double</i>)</a><dt> |
---|
81 | <dd><font size="-1"> </font></dd> |
---|
82 | |
---|
83 | </dl> |
---|
84 | |
---|
85 | <p> </p> |
---|
86 | |
---|
87 | |
---|
88 | |
---|
89 | <a name="#_auto_cov2d"></a> |
---|
90 | |
---|
91 | <h2>auto_cov2d <font size="-1" color="#006633"> |
---|
92 | Statistics |
---|
93 | </font></h2> |
---|
94 | |
---|
95 | <p><font face="Courier"><i>result = </i>auto_cov2d(<i><a href="#_auto_cov2d_keyword_X">X</a>, <a href="#_auto_cov2d_keyword_Lag">Lag</a></i>, <a href="#_auto_cov2d_keyword_Double">Double</a>=<i>Double</i>, <a href="#_auto_cov2d_keyword_zero2nan">zero2nan</a>=<i>zero2nan</i>)</font></p> |
---|
96 | |
---|
97 | |
---|
98 | |
---|
99 | |
---|
100 | |
---|
101 | |
---|
102 | |
---|
103 | <h3>Parameters</h3> |
---|
104 | |
---|
105 | |
---|
106 | <a name="#_auto_cov2d_keyword_X"></a> |
---|
107 | <h4>X |
---|
108 | <font size="-1" color="#006633">in</font> |
---|
109 | |
---|
110 | |
---|
111 | <font size="-1" color="#006633">required</font> |
---|
112 | |
---|
113 | |
---|
114 | |
---|
115 | |
---|
116 | </h4> |
---|
117 | |
---|
118 | |
---|
119 | An 2 dimension Array [nx,ny] |
---|
120 | |
---|
121 | |
---|
122 | |
---|
123 | <a name="#_auto_cov2d_keyword_Lag"></a> |
---|
124 | <h4>Lag |
---|
125 | <font size="-1" color="#006633">in</font> |
---|
126 | |
---|
127 | |
---|
128 | <font size="-1" color="#006633">required</font> |
---|
129 | |
---|
130 | |
---|
131 | |
---|
132 | |
---|
133 | </h4> |
---|
134 | |
---|
135 | |
---|
136 | 2-element vector, in the intervals [-(nx-2), (nx-2)],[-(ny-2), (ny-2)], |
---|
137 | of type integer that specifies the absolute distance(s) between |
---|
138 | indexed elements of X. |
---|
139 | |
---|
140 | |
---|
141 | |
---|
142 | |
---|
143 | |
---|
144 | <h3>Keywords</h3> |
---|
145 | |
---|
146 | |
---|
147 | <a name="#_auto_cov2d_keyword_Double"></a> |
---|
148 | <h4>Double |
---|
149 | |
---|
150 | |
---|
151 | |
---|
152 | |
---|
153 | |
---|
154 | |
---|
155 | |
---|
156 | |
---|
157 | </h4> |
---|
158 | |
---|
159 | |
---|
160 | If set to a non-zero value, computations are done in double precision arithmetic. |
---|
161 | |
---|
162 | |
---|
163 | <a name="#_auto_cov2d_keyword_zero2nan"></a> |
---|
164 | <h4>zero2nan |
---|
165 | |
---|
166 | |
---|
167 | |
---|
168 | |
---|
169 | |
---|
170 | |
---|
171 | |
---|
172 | |
---|
173 | </h4> |
---|
174 | |
---|
175 | |
---|
176 | |
---|
177 | |
---|
178 | |
---|
179 | |
---|
180 | |
---|
181 | </pre><h3>Version history</h3> |
---|
182 | |
---|
183 | <h4>Version</h4> |
---|
184 | $Id: a_correlate2d.pro 163 2006-08-29 12:59:46Z navarro $ |
---|
185 | |
---|
186 | <h4>History</h4> |
---|
187 | 28/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
188 | Based on the A_CORRELATE procedure of IDL |
---|
189 | |
---|
190 | |
---|
191 | |
---|
192 | |
---|
193 | |
---|
194 | |
---|
195 | |
---|
196 | |
---|
197 | |
---|
198 | |
---|
199 | |
---|
200 | |
---|
201 | |
---|
202 | |
---|
203 | |
---|
204 | |
---|
205 | |
---|
206 | <font size="-3"><p> </p></font> |
---|
207 | <hr size="1" color="#CCCCCC"/> |
---|
208 | |
---|
209 | <a name="#_a_correlate2d"></a> |
---|
210 | |
---|
211 | <h2>a_correlate2d <font size="-1" color="#006633"> |
---|
212 | Statistics |
---|
213 | </font></h2> |
---|
214 | |
---|
215 | <p><font face="Courier"><i>result = </i>a_correlate2d(<i><a href="#_a_correlate2d_keyword_X">X</a>, <a href="#_a_correlate2d_keyword_Lag">Lag</a></i>, <a href="#_a_correlate2d_keyword_Covariance">Covariance</a>=<i>Covariance</i>, <a href="#_a_correlate2d_keyword_Double">Double</a>=<i>Double</i>)</font></p> |
---|
216 | |
---|
217 | |
---|
218 | |
---|
219 | |
---|
220 | |
---|
221 | |
---|
222 | |
---|
223 | <h3>Parameters</h3> |
---|
224 | |
---|
225 | |
---|
226 | <a name="#_a_correlate2d_keyword_X"></a> |
---|
227 | <h4>X |
---|
228 | <font size="-1" color="#006633">in</font> |
---|
229 | |
---|
230 | |
---|
231 | <font size="-1" color="#006633">required</font> |
---|
232 | |
---|
233 | |
---|
234 | |
---|
235 | |
---|
236 | </h4> |
---|
237 | |
---|
238 | |
---|
239 | An 2 dimension Array [nx,ny] |
---|
240 | |
---|
241 | |
---|
242 | |
---|
243 | <a name="#_a_correlate2d_keyword_Lag"></a> |
---|
244 | <h4>Lag |
---|
245 | <font size="-1" color="#006633">in</font> |
---|
246 | |
---|
247 | |
---|
248 | <font size="-1" color="#006633">required</font> |
---|
249 | |
---|
250 | |
---|
251 | |
---|
252 | |
---|
253 | </h4> |
---|
254 | |
---|
255 | |
---|
256 | 2-element vector, in the intervals [-(nx-2), (nx-2)],[-(ny-2), (ny-2)], |
---|
257 | of type integer that specifies the absolute distance(s) between |
---|
258 | indexed elements of X. |
---|
259 | |
---|
260 | |
---|
261 | |
---|
262 | |
---|
263 | |
---|
264 | <h3>Keywords</h3> |
---|
265 | |
---|
266 | |
---|
267 | <a name="#_a_correlate2d_keyword_Covariance"></a> |
---|
268 | <h4>Covariance |
---|
269 | |
---|
270 | |
---|
271 | |
---|
272 | |
---|
273 | |
---|
274 | |
---|
275 | |
---|
276 | |
---|
277 | </h4> |
---|
278 | |
---|
279 | |
---|
280 | If set to a non-zero value, the sample autocovariance is computed. |
---|
281 | |
---|
282 | |
---|
283 | <a name="#_a_correlate2d_keyword_Double"></a> |
---|
284 | <h4>Double |
---|
285 | |
---|
286 | |
---|
287 | |
---|
288 | |
---|
289 | |
---|
290 | |
---|
291 | |
---|
292 | |
---|
293 | </h4> |
---|
294 | |
---|
295 | |
---|
296 | If set to a non-zero value, computations are done in double precision arithmetic. |
---|
297 | |
---|
298 | |
---|
299 | |
---|
300 | |
---|
301 | |
---|
302 | </pre><h3>Version history</h3> |
---|
303 | |
---|
304 | <h4>Version</h4> |
---|
305 | $Id: a_correlate2d.pro 163 2006-08-29 12:59:46Z navarro $ |
---|
306 | |
---|
307 | <h4>History</h4> |
---|
308 | 28/2/2000 Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
309 | Based on the A_CORRELATE procedure of IDL |
---|
310 | |
---|
311 | |
---|
312 | |
---|
313 | |
---|
314 | |
---|
315 | |
---|
316 | |
---|
317 | |
---|
318 | |
---|
319 | |
---|
320 | |
---|
321 | |
---|
322 | |
---|
323 | |
---|
324 | |
---|
325 | |
---|
326 | |
---|
327 | <font size="-3"><p> </p></font> |
---|
328 | <hr size="1" color="#CCCCCC"/> |
---|
329 | |
---|
330 | |
---|
331 | |
---|
332 | |
---|
333 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
---|
334 | |
---|
335 | </body> |
---|
336 | </html> |
---|