view docs/aimSilentOptions @ 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
line wrap: on
line source
SILENT OPTIONS LIST:

Silent options are a subset of the AIM options that are occasionally
useful but not sufficiently important to be included in the options
lists put out by the gen??? -help instructions. They are listed below
with simple one line explanations. This is the full extent of the
documentation for most of these options currently. Those with ***
prior to the comment have a man-like entry in the second Section of
this file.


Option Name    Default    Comment
-----------    -------    -------------------------------------------       

test1          0          Dummy option for test and development    /* MHA */
test2          0          Dummy option for test and development    /* MHA */
test3          0          Dummy option for test and development    /* MHA */
test4          0          Dummy option for test and development    /* MHA */

******** input/output options **********************************************
useprevious    off    *** Use previously stored output
framenumber    off        Index of current frame (to stderr)
review         off        Wait for keyboard <return> between frames
pstofile       off        Send PostScript output to .ps file
bytemax
type

******** display options ***************************************************
overlap
headroom
perspective
mono_ctn       on         Force monochrome (single plane) cartoons. 
colour_ctn     off        Force colour (multi-plane) cartoons.      
planemask_ctn  1          Planemask for creating cartoons.        
fg_col         black      Foreground Colour.                   
bg_col         white      Background Colour.                    
rotateaxes     off        Rotate the axes labels in .ps output  

******** options to assist dtp of postscript (_ps) output ******************
xstart_ps                 x-axis: start point for ps plots         /* MAA */
xend_ps                   x-axis: end point for ps plots.          /* MAA */
ystart_ps                 y-axis: start point for ps plots.        /* MAA */
yend_ps                   y-axis: end point for ps plots.          /* MAA */
xtitle_ps                 x-axis: title for ps plots.              /* MAA */
ytitle_ps                 y-axis: title for ps plots.              /* MAA */
portrait_ps               Use 'portrait' page format               /* MAA */
landscape_ps              Use 'landscape' page format              /* MAA */
fontname_ps    Helvetica  Font for ps plots                        /* MAA */
fontsize_ps        12     Fontsize for ps plots (points)           /* MAA */  
fonttitlesize_ps    0     Fontsize for title (points)              /* MAA */
axislinewidth_ps    1     Linewidth for axes/tick-marks (points)   /* MAA */
figurelinewidth_ps  1     Linewidth for figures (points)           /* MAA */ 
xticks_ps           6     Size of x-axis (big) ticks (points)      /* MAA */
yticks_ps           6     Size of y-axis (big) ticks' (points)     /* MAA */
outsideticks_ps    on     Print tick-marks 'outside' figure        /* MAA */ 
axistop_ps         on     Print tick-marks on top side             /* MAA */
axisbottom_ps      on     Print tick-marks on bottom side          /* MAA */
axisleft_ps        on     Print tick-marks on left side            /* MAA */
axisright_ps       on     Print tick-marks on right side           /* MAA */
xmajorticks_ps      1     Relative *spacing* of ticks              /* MAA */
xminorticks_ps      1     Relative *spacing* of ticks              /* MAA */
ymajorticks_ps      1     Relative *spacing* of ticks              /* MAA */
yminorticks_ps      1     Relative *spacing* of ticks              /* MAA */

******** internal variables for the transmission-line filterbank ***********
upfactor       auto       Upsampling factor (off auto int)          /* CG */
cutoff         1.0        LP cutoff as a fraction of Nyquist freq.  /* CG */
downfactor     auto       Downsampling factor (off auto int)        /* CG */
nconcha_ear    2          Number of segments in concha              /* CG */
lconcha_ear    0.90       Total length of concha (cm)               /* CG */
rconcha_ear    1.00       Radius of concha (cm)                     /* CG */
kconcha_ear    0.01       Attn. constant of concha (1/cm)           /* CG */
ncanal_ear     4          Number of segments in ear canal           /* CG */
lcanal_ear     2.85       Length of ear canal (cm)                  /* CG */
rcanal_ear     0.35       Radius of ear canal (cm)                  /* CG */
kcanal_ear     0.04       Attn. constant of ear canal (1/cm)        /* CG */
interp_afb     off        Levels of interpolation to apply          
audiogram_afb  off        Audiogram equalisation parameter          /* CG */ 

********* options for lowpass filter between gt afb and 2D-AT **************
ltup_lpf       0.5ms      Upward time constant in ms                /* JH */ 
lstages_lpf    off        Stages of integration                     /* JH */ 

linear_sgm     off        Linear frequency axis for spectrograms    /* JH */ 
power          off        Power of Compression                      /* JH */ 

exponential_decay off     Exponential strobe Decay [ in gensai]    /* AJD */
    
q or Q [Return]           Quit animated display mode.





	overlap   The overlap of transparent windows of the
                  individual functions
                  Scalar: percentage. Default value: 50%

        The fact that the output functions are related means that they fit up
        under each other in the display in a way that concentrates the lines
        on the landscape and improves the display.

        headroom  Display with headroom for the uppermost channel
                  Scalar: percentage. Default value: 0%

        Because of the overlap of the transparent windows, part of the upper-
        most transparent window is hidden by the upper edge of the display
        window. This can cause truncation of the waves in the upper channels.
        To avoid truncation, headroom enables the user to specify that the
        highest channel ought to be centred below the upper edge of the win-
        dow.  The value specified is taken to be the percentage of the window
        between the zero line of the upper channel and the upper edge of the
        window.


                   
useprevious

Command line options override the non-auditory options in the header
of a reused file (ie. useprevious=on). 

Note: length=remainder gets the whole of the reused file. Otherwise you get
the amount you request (or the default length if no option is given).

BUG: AIM will allow you to overwrite of the channels option, but it
will not act appropriately. It would need it to change the frame size,
which in turn would require knowledge of the file format which it does
not currently have.)