annotate man/man1/integframe.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 INTEGFRAME 1 "1 September 1993"
tomwalters@0 2
tomwalters@0 3 .SH NAME
tomwalters@0 4 integframe \- Integrate gensai frames over time or frequency.
tomwalters@0 5
tomwalters@0 6 .SH SYNTAX
tomwalters@0 7 integframe [options] [file]
tomwalters@0 8
tomwalters@0 9 .SH DESCRIPTION
tomwalters@0 10 Read a gensai output file which must have a header.
tomwalters@0 11 Integrate the whole of every input frame in either time or frequency
tomwalters@0 12 by averaging the frame across the appropriate dimension.
tomwalters@0 13 The integration limits for particular frame sequences can be set by limiting
tomwalters@0 14 the size of input frames using the `edframe' program prior to `integframe'.
tomwalters@0 15 Write each integrated frame on the stdout as an array in the given output
tomwalters@0 16 data type. The output does not have a header.
tomwalters@0 17
tomwalters@0 18 .SH OPTIONS
tomwalters@0 19
tomwalters@0 20 1. variable
tomwalters@0 21
tomwalters@0 22 The `variable' option sets the variable of integration. The strings "time"
tomwalters@0 23 and "frequency" are recognised, (which may be abbreviated back to the first letter
tomwalters@0 24 if required).
tomwalters@0 25
tomwalters@0 26 2. average
tomwalters@0 27
tomwalters@0 28 When average=on then the average integrated frame is calculated over all input
tomwalters@0 29 frames, and this average integrated frame only is written on the stdout as an
tomwalters@0 30 array in the given output data type.
tomwalters@0 31
tomwalters@0 32 3. type
tomwalters@0 33
tomwalters@0 34 The output data type. Recognised types include: char, short, int, double,
tomwalters@0 35 float, ascii. The ascii type means one number string per line of output.
tomwalters@0 36 The input data type is binary shorts, preceded by a gensai header.
tomwalters@0 37
tomwalters@0 38 4. info
tomwalters@0 39
tomwalters@0 40 When info=on print the input frame size on the stderr.
tomwalters@0 41
tomwalters@0 42 .SH EXAMPLES
tomwalters@0 43
tomwalters@0 44 1. Integrate the 2nd gensai frame over time from 10ms to 20ms.
tomwalters@0 45
tomwalters@0 46 .nf
tomwalters@0 47 gensai output=stdout ... | edframe frame=1 time=10ms-20ms | integframe var=time > ...
tomwalters@0 48 .fi
tomwalters@0 49
tomwalters@0 50 2. Integrate the 2nd gensai frame over frequency from channels 5 to 8 inclusive.
tomwalters@0 51
tomwalters@0 52 .nf
tomwalters@0 53 gensai output=stdout ... | edframe frame=1 freq=5-8 | integframe var=freq > ...
tomwalters@0 54 .fi
tomwalters@0 55
tomwalters@0 56 3. Calculating the average summary gensai frame.
tomwalters@0 57
tomwalters@0 58 .nf
tomwalters@0 59 gensai output=stdout ... | integframe var=freq av=on > ...
tomwalters@0 60 .fi
tomwalters@0 61
tomwalters@0 62
tomwalters@0 63 .SH "SEE ALSO"
tomwalters@0 64 options edframe
tomwalters@0 65
tomwalters@0 66 .SH COPYRIGHT
tomwalters@0 67 .LP
tomwalters@0 68 Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
tomwalters@0 69 .LP
tomwalters@0 70 Permission to use, copy, modify, and distribute this software without fee
tomwalters@0 71 is hereby granted for research purposes, provided that this copyright
tomwalters@0 72 notice appears in all copies and in all supporting documentation, and that
tomwalters@0 73 the software is not redistributed for any fee (except for a nominal
tomwalters@0 74 shipping charge). Anyone wanting to incorporate all or part of this
tomwalters@0 75 software in a commercial product must obtain a license from the Medical
tomwalters@0 76 Research Council.
tomwalters@0 77 .LP
tomwalters@0 78 The MRC makes no representations about the suitability of this
tomwalters@0 79 software for any purpose. It is provided "as is" without express or
tomwalters@0 80 implied warranty.
tomwalters@0 81 .LP
tomwalters@0 82 THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
tomwalters@0 83 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
tomwalters@0 84 THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES
tomwalters@0 85 OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
tomwalters@0 86 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
tomwalters@0 87 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
tomwalters@0 88 SOFTWARE.
tomwalters@0 89