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