Mercurial > hg > aim92

annotate docs/aimSilentOptions @ 0:5242703e91d3 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial checkin for AIM92 aimR8.2 (last updated May 1997).
author tomwalters
date Fri, 20 May 2011 15:19:45 +0100
parents
children
rev   line source
tomwalters@0 1 SILENT OPTIONS LIST:
tomwalters@0 2
tomwalters@0 3 Silent options are a subset of the AIM options that are occasionally
tomwalters@0 4 useful but not sufficiently important to be included in the options
tomwalters@0 5 lists put out by the gen??? -help instructions. They are listed below
tomwalters@0 6 with simple one line explanations. This is the full extent of the
tomwalters@0 7 documentation for most of these options currently. Those with ***
tomwalters@0 8 prior to the comment have a man-like entry in the second Section of
tomwalters@0 9 this file.
tomwalters@0 10
tomwalters@0 11
tomwalters@0 12 Option Name Default Comment
tomwalters@0 13 ----------- ------- -------------------------------------------
tomwalters@0 14
tomwalters@0 15 test1 0 Dummy option for test and development /* MHA */
tomwalters@0 16 test2 0 Dummy option for test and development /* MHA */
tomwalters@0 17 test3 0 Dummy option for test and development /* MHA */
tomwalters@0 18 test4 0 Dummy option for test and development /* MHA */
tomwalters@0 19
tomwalters@0 20 ******** input/output options **********************************************
tomwalters@0 21 useprevious off *** Use previously stored output
tomwalters@0 22 framenumber off Index of current frame (to stderr)
tomwalters@0 23 review off Wait for keyboard <return> between frames
tomwalters@0 24 pstofile off Send PostScript output to .ps file
tomwalters@0 25 bytemax
tomwalters@0 26 type
tomwalters@0 27
tomwalters@0 28 ******** display options ***************************************************
tomwalters@0 29 overlap
tomwalters@0 30 headroom
tomwalters@0 31 perspective
tomwalters@0 32 mono_ctn on Force monochrome (single plane) cartoons.
tomwalters@0 33 colour_ctn off Force colour (multi-plane) cartoons.
tomwalters@0 34 planemask_ctn 1 Planemask for creating cartoons.
tomwalters@0 35 fg_col black Foreground Colour.
tomwalters@0 36 bg_col white Background Colour.
tomwalters@0 37 rotateaxes off Rotate the axes labels in .ps output
tomwalters@0 38
tomwalters@0 39 ******** options to assist dtp of postscript (_ps) output ******************
tomwalters@0 40 xstart_ps x-axis: start point for ps plots /* MAA */
tomwalters@0 41 xend_ps x-axis: end point for ps plots. /* MAA */
tomwalters@0 42 ystart_ps y-axis: start point for ps plots. /* MAA */
tomwalters@0 43 yend_ps y-axis: end point for ps plots. /* MAA */
tomwalters@0 44 xtitle_ps x-axis: title for ps plots. /* MAA */
tomwalters@0 45 ytitle_ps y-axis: title for ps plots. /* MAA */
tomwalters@0 46 portrait_ps Use 'portrait' page format /* MAA */
tomwalters@0 47 landscape_ps Use 'landscape' page format /* MAA */
tomwalters@0 48 fontname_ps Helvetica Font for ps plots /* MAA */
tomwalters@0 49 fontsize_ps 12 Fontsize for ps plots (points) /* MAA */
tomwalters@0 50 fonttitlesize_ps 0 Fontsize for title (points) /* MAA */
tomwalters@0 51 axislinewidth_ps 1 Linewidth for axes/tick-marks (points) /* MAA */
tomwalters@0 52 figurelinewidth_ps 1 Linewidth for figures (points) /* MAA */
tomwalters@0 53 xticks_ps 6 Size of x-axis (big) ticks (points) /* MAA */
tomwalters@0 54 yticks_ps 6 Size of y-axis (big) ticks' (points) /* MAA */
tomwalters@0 55 outsideticks_ps on Print tick-marks 'outside' figure /* MAA */
tomwalters@0 56 axistop_ps on Print tick-marks on top side /* MAA */
tomwalters@0 57 axisbottom_ps on Print tick-marks on bottom side /* MAA */
tomwalters@0 58 axisleft_ps on Print tick-marks on left side /* MAA */
tomwalters@0 59 axisright_ps on Print tick-marks on right side /* MAA */
tomwalters@0 60 xmajorticks_ps 1 Relative *spacing* of ticks /* MAA */
tomwalters@0 61 xminorticks_ps 1 Relative *spacing* of ticks /* MAA */
tomwalters@0 62 ymajorticks_ps 1 Relative *spacing* of ticks /* MAA */
tomwalters@0 63 yminorticks_ps 1 Relative *spacing* of ticks /* MAA */
tomwalters@0 64
tomwalters@0 65 ******** internal variables for the transmission-line filterbank ***********
tomwalters@0 66 upfactor auto Upsampling factor (off auto int) /* CG */
tomwalters@0 67 cutoff 1.0 LP cutoff as a fraction of Nyquist freq. /* CG */
tomwalters@0 68 downfactor auto Downsampling factor (off auto int) /* CG */
tomwalters@0 69 nconcha_ear 2 Number of segments in concha /* CG */
tomwalters@0 70 lconcha_ear 0.90 Total length of concha (cm) /* CG */
tomwalters@0 71 rconcha_ear 1.00 Radius of concha (cm) /* CG */
tomwalters@0 72 kconcha_ear 0.01 Attn. constant of concha (1/cm) /* CG */
tomwalters@0 73 ncanal_ear 4 Number of segments in ear canal /* CG */
tomwalters@0 74 lcanal_ear 2.85 Length of ear canal (cm) /* CG */
tomwalters@0 75 rcanal_ear 0.35 Radius of ear canal (cm) /* CG */
tomwalters@0 76 kcanal_ear 0.04 Attn. constant of ear canal (1/cm) /* CG */
tomwalters@0 77 interp_afb off Levels of interpolation to apply
tomwalters@0 78 audiogram_afb off Audiogram equalisation parameter /* CG */
tomwalters@0 79
tomwalters@0 80 ********* options for lowpass filter between gt afb and 2D-AT **************
tomwalters@0 81 ltup_lpf 0.5ms Upward time constant in ms /* JH */
tomwalters@0 82 lstages_lpf off Stages of integration /* JH */
tomwalters@0 83
tomwalters@0 84 linear_sgm off Linear frequency axis for spectrograms /* JH */
tomwalters@0 85 power off Power of Compression /* JH */
tomwalters@0 86
tomwalters@0 87 exponential_decay off Exponential strobe Decay [ in gensai] /* AJD */
tomwalters@0 88
tomwalters@0 89 q or Q [Return] Quit animated display mode.
tomwalters@0 90
tomwalters@0 91
tomwalters@0 92
tomwalters@0 93
tomwalters@0 94
tomwalters@0 95 overlap The overlap of transparent windows of the
tomwalters@0 96 individual functions
tomwalters@0 97 Scalar: percentage. Default value: 50%
tomwalters@0 98
tomwalters@0 99 The fact that the output functions are related means that they fit up
tomwalters@0 100 under each other in the display in a way that concentrates the lines
tomwalters@0 101 on the landscape and improves the display.
tomwalters@0 102
tomwalters@0 103 headroom Display with headroom for the uppermost channel
tomwalters@0 104 Scalar: percentage. Default value: 0%
tomwalters@0 105
tomwalters@0 106 Because of the overlap of the transparent windows, part of the upper-
tomwalters@0 107 most transparent window is hidden by the upper edge of the display
tomwalters@0 108 window. This can cause truncation of the waves in the upper channels.
tomwalters@0 109 To avoid truncation, headroom enables the user to specify that the
tomwalters@0 110 highest channel ought to be centred below the upper edge of the win-
tomwalters@0 111 dow. The value specified is taken to be the percentage of the window
tomwalters@0 112 between the zero line of the upper channel and the upper edge of the
tomwalters@0 113 window.
tomwalters@0 114
tomwalters@0 115
tomwalters@0 116
tomwalters@0 117 useprevious
tomwalters@0 118
tomwalters@0 119 Command line options override the non-auditory options in the header
tomwalters@0 120 of a reused file (ie. useprevious=on).
tomwalters@0 121
tomwalters@0 122 Note: length=remainder gets the whole of the reused file. Otherwise you get
tomwalters@0 123 the amount you request (or the default length if no option is given).
tomwalters@0 124
tomwalters@0 125 BUG: AIM will allow you to overwrite of the channels option, but it
tomwalters@0 126 will not act appropriately. It would need it to change the frame size,
tomwalters@0 127 which in turn would require knowledge of the file format which it does
tomwalters@0 128 not currently have.)