tomwalters@0: .TH INTEGFRAME 1 "1 September 1993"
tomwalters@0: 
tomwalters@0: .SH NAME
tomwalters@0: integframe \-   Integrate gensai frames over time or frequency.
tomwalters@0: 
tomwalters@0: .SH SYNTAX 
tomwalters@0: integframe [options] [file]
tomwalters@0: 
tomwalters@0: .SH DESCRIPTION
tomwalters@0: Read a gensai output file which must have a header.
tomwalters@0: Integrate the whole of every input frame in either time or frequency
tomwalters@0: by averaging the frame across the appropriate dimension.
tomwalters@0: The integration limits for particular frame sequences can be set by limiting
tomwalters@0: the size of input frames using the `edframe' program prior to `integframe'.
tomwalters@0: Write each integrated frame on the stdout as an array in the given output
tomwalters@0: data type. The output does not have a header.
tomwalters@0: 
tomwalters@0: .SH OPTIONS
tomwalters@0: 
tomwalters@0: 1. variable
tomwalters@0: 
tomwalters@0: The `variable' option sets the variable of integration. The strings "time"
tomwalters@0: and "frequency" are recognised, (which may be abbreviated back to the first letter
tomwalters@0: if required).
tomwalters@0: 
tomwalters@0: 2. average
tomwalters@0: 
tomwalters@0: When average=on then the average integrated frame is calculated over all input
tomwalters@0: frames, and this average integrated frame only is written on the stdout as an
tomwalters@0: array in the given output data type.
tomwalters@0: 
tomwalters@0: 3. type
tomwalters@0: 
tomwalters@0: The output data type. Recognised types include: char, short, int, double,
tomwalters@0: float, ascii. The ascii type means one number string per line of output.
tomwalters@0: The input data type is binary shorts, preceded by a gensai header.
tomwalters@0: 
tomwalters@0: 4. info
tomwalters@0: 
tomwalters@0: When info=on print the input frame size on the stderr.
tomwalters@0: 
tomwalters@0: .SH  EXAMPLES
tomwalters@0: 
tomwalters@0: 1. Integrate the 2nd gensai frame over time from 10ms to 20ms.
tomwalters@0: 
tomwalters@0: .nf
tomwalters@0:     gensai output=stdout ... | edframe frame=1 time=10ms-20ms  |  integframe var=time  >  ...
tomwalters@0: .fi
tomwalters@0: 
tomwalters@0: 2. Integrate the 2nd gensai frame over frequency from channels 5 to 8 inclusive.
tomwalters@0: 
tomwalters@0: .nf
tomwalters@0:     gensai output=stdout ... | edframe frame=1 freq=5-8  |  integframe var=freq  >  ...
tomwalters@0: .fi
tomwalters@0: 
tomwalters@0: 3. Calculating the average summary gensai frame.
tomwalters@0: 
tomwalters@0: .nf
tomwalters@0:     gensai output=stdout ... | integframe var=freq av=on  >  ...
tomwalters@0: .fi
tomwalters@0: 
tomwalters@0: 
tomwalters@0: .SH "SEE ALSO"
tomwalters@0: options edframe
tomwalters@0: 
tomwalters@0: .SH COPYRIGHT
tomwalters@0: .LP
tomwalters@0: Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
tomwalters@0: .LP
tomwalters@0: Permission to use, copy, modify, and distribute this software without fee 
tomwalters@0: is hereby granted for research purposes, provided that this copyright 
tomwalters@0: notice appears in all copies and in all supporting documentation, and that 
tomwalters@0: the software is not redistributed for any fee (except for a nominal 
tomwalters@0: shipping charge). Anyone wanting to incorporate all or part of this 
tomwalters@0: software in a commercial product must obtain a license from the Medical 
tomwalters@0: Research Council.
tomwalters@0: .LP
tomwalters@0: The MRC makes no representations about the suitability of this 
tomwalters@0: software for any purpose.  It is provided "as is" without express or 
tomwalters@0: implied warranty.
tomwalters@0: .LP
tomwalters@0: THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING 
tomwalters@0: ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL 
tomwalters@0: THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES 
tomwalters@0: OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, 
tomwalters@0: WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, 
tomwalters@0: ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 
tomwalters@0: SOFTWARE.
tomwalters@0: