Mercurial > hg > aim92

annotate docs/aimDocumentation @ 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 docs/aimDocumentation
tomwalters@0 2
tomwalters@0 3
tomwalters@0 4 OVERVIEW OF AIM DOCUMENTATION
tomwalters@0 5
tomwalters@0 6
tomwalters@0 7 An introduction to the Documentation for the Auditory Image Model of
tomwalters@0 8 Peripheral Auditory Processing
tomwalters@0 9
tomwalters@0 10
tomwalters@0 11 A. Initial Contact Points and Aquisition of the Software Package
tomwalters@0 12
tomwalters@0 13
tomwalters@0 14 1. WWW Page.
tomwalters@0 15
tomwalters@0 16 Address: http://www.mrc-apu.cam.ac.uk/aim/
tomwalters@0 17
tomwalters@0 18 An overview of AIM on the internet with facilities for acquiring
tomwalters@0 19 the software package. The text is stored in aim_html/index.html.
tomwalters@0 20
tomwalters@0 21
tomwalters@0 22 2. Journal reference.
tomwalters@0 23
tomwalters@0 24 The software package is described in a recent article entitled
tomwalters@0 25
tomwalters@0 26 "Time-domain modelling of peripheral auditory processing:
tomwalters@0 27 A modular architecture and a software platform"
tomwalters@0 28
tomwalters@0 29 by Roy D. Patterson and Mike H. Allerhand and Christian Giguere,
tomwalters@0 30 Journal of the Acoustical Society of America, 98, 1995 (in press).
tomwalters@0 31
tomwalters@0 32 The text of the article is stored in aim/docs/PAG95.doc
tomwalters@0 33
tomwalters@0 34
tomwalters@0 35 3. ftp instructions:
tomwalters@0 36
tomwalters@0 37 The instructions for obtaining AIM by ftp are stored in
tomwalters@0 38 aim/docs/ftp.doc
tomwalters@0 39
tomwalters@0 40
tomwalters@0 41
tomwalters@0 42 B. Installation and Test
tomwalters@0 43
tomwalters@0 44 1. ReadMe.First
tomwalters@0 45
tomwalters@0 46 This document is in top directory of aim when the aim.tar file is
tomwalters@0 47 unpacked. It contains the instructions for compiling AIM, testing
tomwalters@0 48 the installation, and setting up paths to the instructions, the
tomwalters@0 49 aimtools, and the online documentation (manual pages accessed
tomwalters@0 50 through 'manaim').
tomwalters@0 51
tomwalters@0 52
tomwalters@0 53
tomwalters@0 54 C. Introduction to the Operation of AIM
tomwalters@0 55
tomwalters@0 56
tomwalters@0 57 1. bin/ReadMe
tomwalters@0 58
tomwalters@0 59 This is the initial ReadMe file for those wanting to use AIM once it
tomwalters@0 60 has been installed and tested. It begins with a guided tour of AIM and
tomwalters@0 61 then describes the user documentation and where to find it.
tomwalters@0 62
tomwalters@0 63
tomwalters@0 64 2. Introduction to AIM instructions: docs/aimInstructions
tomwalters@0 65
tomwalters@0 66 An introduction to the instructions and command-line options used to
tomwalters@0 67 control the auditory model is stored in docs/aimInstructions.
tomwalters@0 68 The instructions have the form gen???. The command 'gen -help | more'
tomwalters@0 69 lists the three letter combinations that may replace ??? and
tomwalters@0 70 briefly describes the operations they invoke.
tomwalters@0 71
tomwalters@0 72
tomwalters@0 73 3. AIM on-line help: gen??? -help
tomwalters@0 74
tomwalters@0 75 The instruction 'gen -help | more' lists the AIM instructions.
tomwalters@0 76
tomwalters@0 77 The instructions have the form 'gen??? -options <file_name>'.
tomwalters@0 78
tomwalters@0 79 The final three letters of the AIM instruction specify the point
tomwalters@0 80 in the system where the user chooses to observe the output.
tomwalters@0 81 Instructions of the form 'gen??? -help' cause AIM to list the
tomwalters@0 82 options that control AIM up to that output point along with a brief
tomwalters@0 83 description of the option and its current and default value.
tomwalters@0 84
tomwalters@0 85
tomwalters@0 86 4. Manual pages for AIM instructions: manaim gen???
tomwalters@0 87
tomwalters@0 88 The documentation for each instruction and its options is
tomwalters@0 89 provided in standard manual pages accessed by instructions of the
tomwalters@0 90 form 'manaim gen???'. Begin with 'manaim genwav' which describes
tomwalters@0 91 non-auditory options such as those for the AIM display and for
tomwalters@0 92 the input and output files.
tomwalters@0 93
tomwalters@0 94 A complete listing of the AIM instructions is included in the listing
tomwalters@0 95 produced by the instruction 'manaim -k all | more'.
tomwalters@0 96
tomwalters@0 97 Manual pages can be printed with commands of the form
tomwalters@0 98 'manaim gen??? | lpr'.
tomwalters@0 99
tomwalters@0 100
tomwalters@0 101 5. Manual pages for AIM tools: manaim <aimtool_name>
tomwalters@0 102
tomwalters@0 103 The software package includes a set of 'aimtools' for generating
tomwalters@0 104 and manipulating input waves, and for processing the multi-channel,
tomwalters@0 105 multi-frame output of AIM.
tomwalters@0 106
tomwalters@0 107 There are manual pages for the aimtools accessed by instructions of
tomwalters@0 108 the form 'manaim <aimtool_name>'.
tomwalters@0 109
tomwalters@0 110 A complete listing of the aimtools is included in the listing
tomwalters@0 111 produced by the instruction 'manaim -k all | more'.
tomwalters@0 112
tomwalters@0 113
tomwalters@0 114
tomwalters@0 115 D. Additional Facilities
tomwalters@0 116
tomwalters@0 117
tomwalters@0 118 1. Silent Options: docs/aimSilentOptions
tomwalters@0 119
tomwalters@0 120 AIM includes a number of 'silent options' that are occassionally
tomwalters@0 121 useful but not sufficiently important to warrant positions on the
tomwalters@0 122 options lists produced by the on-line help (gen??? -help).
tomwalters@0 123
tomwalters@0 124 A list of the silent options is provided in docs/aimSilentOptions
tomwalters@0 125
tomwalters@0 126
tomwalters@0 127 2. File Formats: docs/aimFileFormats
tomwalters@0 128
tomwalters@0 129 A description of the layout of information in the output files
tomwalters@0 130 produced by AIM is presented in docs/aimFileFormats
tomwalters@0 131
tomwalters@0 132
tomwalters@0 133
tomwalters@0 134 3. AIM list: mail aim@mrc-apu.cam.ac.uk
tomwalters@0 135
tomwalters@0 136 An email list for AIM users has been set up. The instructions for
tomwalters@0 137 joining and retiring from the mail list are presented in
tomwalters@0 138 docs/aimMailList.
tomwalters@0 139
tomwalters@0 140 Note that the list is not moderated. It is a facility whereby users
tomwalters@0 141 can communicate for their mutual benefit rather than a question
tomwalters@0 142 answering facility provided by the software developers.
tomwalters@0 143
tomwalters@0 144