skip to primary navigationskip to content
 

bufframe


Manual Reference Pages  - BUFFRAME (1)

NAME

bufframe - a shifting AIM output frame buffer.

CONTENTS

Syntax
Description
Options
Examples
Copyright

SYNTAX

bufframe [options] [file]

DESCRIPTION

The program reads an AIM header and the output from the genbmm (basilar membrane motion) or gennap (neural activity pattern) programs. This is divided into contiguous time frames using the optional arguments and written on the stdout with an appropriate header as if output from the gensai program. This enables genbmm or gennap output to be divided into time frames and replayed as a time-varying cartoon by gensai using the "useprevious" option.

Certain display parameters have different default values for different applications. The gensai display parameters should be set to the appropriate values, in order to plot the cartoon on the same scale. For example: when the source application is gennap, set gensai top=1000, when the source application is genbmm, set gensai bottom=-100.

OPTIONS

1. width, frstep.

The input is divided into frames according to the width option and the frstep option. The width option sets the width of the output frames. The frstep option sets the step or shift between successive output frames. With no units, the values of width and frstep are in samples. Both width and frstep may take time units (s or ms), in which case the values are converted to samples using the given ‘samplerate’ option.

2. frame.

A range of sequential frames may be selected for output by:

          frame=a[-b]

The upper limit ‘b’ is optional, and when it is missing then the range is a single frame, otherwise ‘a’ and ‘b’ are inclusive range limits. The strings "min" and "max" are recognised as extreme limits constrained by the given width and frstep and the input size, otherwise the values of ‘a’ and ‘b’ are frame numbers: 0,1,2,...

The frame selector may also take time units (s, or ms) to specify frames "closest" to the given time, being the frame number which is the greatest integer multiple of the framestep (frstep) which does not exceed the given time measured from the start of the input file.

3. Transpose.

The option flag:

  Transpose=on

causes a matrix transpose (swap rows and columns) of each output frame. When a frame has a height greater than it’s width then setting "Transpose=on" may provide a preferable display orientation. For example, this enables a very narrow (eg. single column) time-slice to be plotted horizontally, so that a time-slice of filterbank output may be plotted as a spectrum on a horizontal frequency axis.

4. Header.

The option flag:

      Header=off

causes the header to be suppressed from the output.

5. display, animate.

Most options in the input header are copied to the output header. This enables options which are needed for the eventual display to pass straight through. Some options are set so that they can override the input header. For example, the ‘display’ option is set on to enable display even when input has "display=off". The ‘animate’ option can be set on even when the input has "animate=off".

EXAMPLES

1. To convert gennap output to multiple animated frames:

gennap len=16ms display=off output=stdout file1 |
        bufframe width=8ms frstep=0.2ms anim=on > file2.sai
gensai useprev=on top=1000 file2             -(for landscape plot)
genspl useprev=on top=1000 pensize=2 file2   -(for spiral plot)

2. To view the basilar membrane from a cross section, animating the waves on it.

genbmm mincf=220 maxcf=660 len=8ms output=stdout display=off file1 |
        bufframe width=1p frstep=1p Tran=on display=on anim=on > file2.sai
gensai bott=-100 useprev=on mag=.2 file2

or:

genbmm mincf=220 maxcf=660 len=32ms output=stdout display=off file1 |         bufframe width=1p frstep=1p Tran=on Header=off > file2 x11play -n75 -a500 file2

SEE ALSO

options edframe

COPYRIGHT

Copyright (c) Applied Psychology Unit, Medical Research Council, 1995

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.

The MRC makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

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.


SunOS 5.6 BUFFRAME (1) 1 September 1993
Generated by manServer 1.07 from /cbu/cnbh/aim/release/man/man1/bufframe.1 using man macros.