annotate man/man1/racf.1 @ 0:5242703e91d3 tip

Initial checkin for AIM92 aimR8.2 (last updated May 1997).
author tomwalters
date Fri, 20 May 2011 15:19:45 +0100
parents
children
rev   line source
tomwalters@0 1 .TH RACF 1 "1 September 1993"
tomwalters@0 2
tomwalters@0 3 .SH NAME
tomwalters@0 4 racf \- recursive autocorrelation function of contiguous frames.
tomwalters@0 5
tomwalters@0 6 .SH SYNTAX
tomwalters@0 7 racf [arguments] [file]
tomwalters@0 8
tomwalters@0 9 .SH DESCRIPTION
tomwalters@0 10 Autocorrelation function using a recursive "leaky integrator" filter.
tomwalters@0 11 For the m'th lag, the n'th recursive update is:
tomwalters@0 12
tomwalters@0 13 .nf
tomwalters@0 14 y[n] = a.y[n-1] + (1-a).f[n].f[n-m]
tomwalters@0 15 .fi
tomwalters@0 16
tomwalters@0 17 where decay constant a = exp(-Ts/T),
tomwalters@0 18 Ts is the sample interval in seconds, and T is the decay time constant in seconds.
tomwalters@0 19
tomwalters@0 20 The recursion computes the mean value of the product f[n].f[n-m]
tomwalters@0 21 within an exponential window which weights past values.
tomwalters@0 22 The window width parameter (eg. corresponding with the width of the
tomwalters@0 23 fft analysis window) is the time constant parameter.
tomwalters@0 24 The half life of the exponential window is given by -T.ln(0.5) = 0.693T
tomwalters@0 25 ie. for a given time constant, T secs, the window decays to half of its
tomwalters@0 26 current value in a period of 0.693T secs.
tomwalters@0 27 Similarly, the window decays by 99% of its initial value in about 4.6T secs.
tomwalters@0 28 So T can be set to accomodate an expected period.
tomwalters@0 29
tomwalters@0 30 The routine generates the autocovariance function.
tomwalters@0 31 An optional normalization (dividing each coefficient by the zeroth
tomwalters@0 32 coefficient) produces the autocorrelation function,
tomwalters@0 33 (and this is then scaled up to the range [0-1000]).
tomwalters@0 34
tomwalters@0 35 The output framewidth is the given maximum acf lag.
tomwalters@0 36
tomwalters@0 37 .SH "SEE ALSO"
tomwalters@0 38 options acf acgram
tomwalters@0 39
tomwalters@0 40 .SH COPYRIGHT
tomwalters@0 41 .LP
tomwalters@0 42 Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
tomwalters@0 43 .LP
tomwalters@0 44 Permission to use, copy, modify, and distribute this software without fee
tomwalters@0 45 is hereby granted for research purposes, provided that this copyright
tomwalters@0 46 notice appears in all copies and in all supporting documentation, and that
tomwalters@0 47 the software is not redistributed for any fee (except for a nominal
tomwalters@0 48 shipping charge). Anyone wanting to incorporate all or part of this
tomwalters@0 49 software in a commercial product must obtain a license from the Medical
tomwalters@0 50 Research Council.
tomwalters@0 51 .LP
tomwalters@0 52 The MRC makes no representations about the suitability of this
tomwalters@0 53 software for any purpose. It is provided "as is" without express or
tomwalters@0 54 implied warranty.
tomwalters@0 55 .LP
tomwalters@0 56 THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
tomwalters@0 57 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
tomwalters@0 58 THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES
tomwalters@0 59 OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
tomwalters@0 60 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
tomwalters@0 61 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
tomwalters@0 62 SOFTWARE.
tomwalters@0 63