tomwalters@0: .TH BUFFRAME 1 "1 September 1993" tomwalters@0: tomwalters@0: .SH NAME tomwalters@0: bufframe \- a shifting AIM output frame buffer. tomwalters@0: tomwalters@0: .SH SYNTAX tomwalters@0: bufframe [options] [file] tomwalters@0: tomwalters@0: .SH DESCRIPTION tomwalters@0: tomwalters@0: The program reads an AIM header and the output from the genbmm (basilar tomwalters@0: membrane motion) or gennap (neural activity pattern) programs. This is tomwalters@0: divided into contiguous time frames using the optional arguments and written tomwalters@0: on the stdout with an tomwalters@0: appropriate header as if output from the gensai program. This enables tomwalters@0: genbmm or gennap output to be divided into time frames and replayed as a tomwalters@0: time-varying cartoon by gensai using the "useprevious" option. tomwalters@0: tomwalters@0: Certain display parameters have different default values for different tomwalters@0: applications. The gensai display parameters should be set to the tomwalters@0: appropriate values, in order to plot the cartoon on the same scale. For tomwalters@0: example: when the source application is gennap, set gensai top=1000, tomwalters@0: when the source application is genbmm, set gensai bottom=-100. tomwalters@0: tomwalters@0: tomwalters@0: .SH OPTIONS tomwalters@0: tomwalters@0: 1. width, frstep. tomwalters@0: tomwalters@0: The input is divided into frames according to the width option and the tomwalters@0: frstep option. The width option sets the width of the output frames. tomwalters@0: The frstep option sets the step or shift between successive output frames. tomwalters@0: With no units, the values of width and frstep are in samples. tomwalters@0: Both width and frstep may take time units (s or ms), in which case the values tomwalters@0: are converted to samples using the given `samplerate' option. tomwalters@0: tomwalters@0: 2. frame. tomwalters@0: tomwalters@0: A range of sequential frames may be selected for output by: tomwalters@0: tomwalters@0: .nf tomwalters@0: frame=a[-b] tomwalters@0: .fi tomwalters@0: tomwalters@0: The upper limit `b' is optional, and when it is missing then the range tomwalters@0: is a single frame, otherwise `a' and `b' are inclusive range limits. tomwalters@0: The strings "min" and "max" are recognised as extreme limits constrained tomwalters@0: by the given width and frstep and the input size, tomwalters@0: otherwise the values of `a' and `b' are frame numbers: 0,1,2,... tomwalters@0: tomwalters@0: The frame selector may also take time units (s, or ms) to specify frames tomwalters@0: "closest" to the given time, being the frame number which is the tomwalters@0: greatest integer multiple of the framestep (frstep) which does not tomwalters@0: exceed the given time measured from the tomwalters@0: start of the input file. tomwalters@0: tomwalters@0: 3. Transpose. tomwalters@0: tomwalters@0: The option flag: tomwalters@0: tomwalters@0: .nf tomwalters@0: Transpose=on tomwalters@0: .fi tomwalters@0: tomwalters@0: causes a matrix transpose (swap rows and columns) of each output frame. tomwalters@0: When a frame has a height greater tomwalters@0: than it's width then setting "Transpose=on" may provide tomwalters@0: a preferable display orientation. For example, this enables a very narrow tomwalters@0: (eg. single column) time-slice to be plotted horizontally, so that a tomwalters@0: time-slice of filterbank output may be plotted as a spectrum on a horizontal tomwalters@0: frequency axis. tomwalters@0: tomwalters@0: 4. Header. tomwalters@0: tomwalters@0: The option flag: tomwalters@0: tomwalters@0: .nf tomwalters@0: Header=off tomwalters@0: .fi tomwalters@0: tomwalters@0: causes the header to be suppressed from the output. tomwalters@0: tomwalters@0: 5. display, animate. tomwalters@0: tomwalters@0: Most options in the input header are copied to the output header. This tomwalters@0: enables options which are needed for the eventual display to pass tomwalters@0: straight through. Some options are set so that they can override the tomwalters@0: input header. For example, the `display' option is set on to enable tomwalters@0: display even when input has "display=off". The `animate' option can be set tomwalters@0: on even when the input has "animate=off". tomwalters@0: tomwalters@0: tomwalters@0: .SH EXAMPLES tomwalters@0: tomwalters@0: 1. To convert gennap output to multiple animated frames: tomwalters@0: tomwalters@0: .nf tomwalters@0: gennap len=16ms display=off output=stdout file1 | tomwalters@0: bufframe width=8ms frstep=0.2ms anim=on > file2.sai tomwalters@0: gensai useprev=on top=1000 file2 -(for landscape plot) tomwalters@0: genspl useprev=on top=1000 pensize=2 file2 -(for spiral plot) tomwalters@0: .fi tomwalters@0: tomwalters@0: tomwalters@0: 2. To view the basilar membrane from a cross section, animating the waves on it. tomwalters@0: tomwalters@0: .nf tomwalters@0: genbmm mincf=220 maxcf=660 len=8ms output=stdout display=off file1 | tomwalters@0: bufframe width=1p frstep=1p Tran=on display=on anim=on > file2.sai tomwalters@0: gensai bott=-100 useprev=on mag=.2 file2 tomwalters@0: tomwalters@0: or: tomwalters@0: tomwalters@0: genbmm mincf=220 maxcf=660 len=32ms output=stdout display=off file1 | tomwalters@0: bufframe width=1p frstep=1p Tran=on Header=off > file2 tomwalters@0: x11play -n75 -a500 file2 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: