annotate man/man1/audim.1 @ 0:5242703e91d3 tip

Initial checkin for AIM92 aimR8.2 (last updated May 1997).

.TH AUDIM 1 "1 September 1993"

.SH NAME
audim  \- Auditory images.

.SH SYNTAX 
audim [options] [file]

.SH DESCRIPTION

This program provides
methods of constructing time-varying auditory images from the output of the
cochlear model which are alternatives to the gensai (stabilized auditory
image) program. Correlograms (ie. row-wise autocorrelation) and row-wise
Fourier transform are provided.

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 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.

Additional processing to each frame is optionally available to compute
alternative forms of auditory image according to the "image" option.

.SH OPTIONS

The options "start" and "length" specify the size of the input.
The options "width" and "frstep"  specify the frames which are output.
The input is divided into frames according to the width option and the
frstep option.

Special option values are:

.nf
  length=max      Read all the input from the given start to its end.
  width=max       Output framewidth is set equal to the given input
		  length, and if this is also "max", then the
		  framewidth is the remainder of the input.
  frames=1-max    Select the 1st to the last frame inclusively.
  frame=4         Select the 4th frame only.

  image=off       Divide the input into frames for replay as a cartoon.
  image=acgram    Compute correlogram of each frame.
  image=ftgram    Compute power spectrum of each channel of each frame.
  image=phgram    Compute phase spectrum of each channel of each frame.
.fi

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.
Parts of the header are changed for the new sai format:
(frames, frameshift, framewidth, frameheight, framebytes).

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.


.SH EXAMPLES

.nf

1. To convert gennap output to multiple animated frames:

gennap len=16ms display=off output=stdout file | \
    audim image=off width=8ms frstep=0.2ms anim=on > file.sai
gensai useprev=on file             -(for landscape plot)
genspl useprev=on pensize=2 file   -(for spiral plot)

(Note: spirals look better in a square box, so you might use options:
    dencf=1 width=500 height=500 )

2. An animated normalized correlogram from gennap output:

gennap len=64ms output=stdout display=off file | \
    audim norm=on anim=on > file.sai
gensai useprev=on top=1000 file             -(for landscape plot)
genspl useprev=on top=1000 pensize=2 file   -(for spiral plot)

.fi

.SH "SEE ALSO"

acgram ftgram edframe naptosai

.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.