Mercurial > hg > aim92

.TH INTEGFRAME 1 "1 September 1993"

.SH NAME
integframe \-   Integrate gensai frames over time or frequency.

.SH SYNTAX
integframe [options] [file]

.SH DESCRIPTION
Read a gensai output file which must have a header.
Integrate the whole of every input frame in either time or frequency
by averaging the frame across the appropriate dimension.
The integration limits for particular frame sequences can be set by limiting
the size of input frames using the `edframe' program prior to `integframe'.
Write each integrated frame on the stdout as an array in the given output
data type. The output does not have a header.

.SH OPTIONS

1. variable

The `variable' option sets the variable of integration. The strings "time"
and "frequency" are recognised, (which may be abbreviated back to the first letter
if required).

2. average

When average=on then the average integrated frame is calculated over all input
frames, and this average integrated frame only is written on the stdout as an
array in the given output data type.

3. type

The output data type. Recognised types include: char, short, int, double,
float, ascii. The ascii type means one number string per line of output.
The input data type is binary shorts, preceded by a gensai header.

4. info

When info=on print the input frame size on the stderr.

.SH  EXAMPLES

1. Integrate the 2nd gensai frame over time from 10ms to 20ms.

.nf
    gensai output=stdout ... | edframe frame=1 time=10ms-20ms  |  integframe var=time  >  ...
.fi

2. Integrate the 2nd gensai frame over frequency from channels 5 to 8 inclusive.

.nf
    gensai output=stdout ... | edframe frame=1 freq=5-8  |  integframe var=freq  >  ...
.fi

3. Calculating the average summary gensai frame.

.nf
    gensai output=stdout ... | integframe var=freq av=on  >  ...
.fi


.SH "SEE ALSO"
options edframe

.SH COPYRIGHT
.LP
Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
.LP
Permission to use, copy, modify, and distribute this software without fee
is hereby granted for research purposes, provided that this copyright
notice appears in all copies and in all supporting documentation, and that
the software is not redistributed for any fee (except for a nominal
shipping charge). Anyone wanting to incorporate all or part of this
software in a commercial product must obtain a license from the Medical
Research Council.
.LP
The MRC makes no representations about the suitability of this
software for any purpose.  It is provided "as is" without express or
implied warranty.
.LP
THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.
author	tomwalters
date	Fri, 20 May 2011 15:19:45 +0100
parents
children