tom@439: #summary Format for aimcconfig files
tom@439: 
tom@439: The AIM-C configuration file is a simple text file in the format parsed by [http://code.jellycan.com/simpleini/ simpleini]. 
tom@439: 
tom@439: The file describes a tree of modules, with the output of each module feeding into zero, one or more other modules. Each node of the tree is an _instance_ of an AIM-C module. Each node can have a different set of parameters.
tom@439: 
tom@439: == Example ==
tom@439: 
tom@439: {{{
tom@439: module1.name = FileInput
tom@439: module1.id = file_input
tom@439: module1.child1 = PZFCFilterbank
tom@439: 
tom@439: module2.name = PZFCFilterbank
tom@439: module2.id = pzfc
tom@439: module2.child1 = NAP
tom@439: 
tom@439: module3.name = NAP
tom@439: module3.id = hcl
tom@439: module3.child1 = Strobes
tom@439: 
tom@439: module4.name = Strobes
tom@439: module4.id = local_max
tom@439: module4.parameters = <<<ENDPARAMS
tom@439: ENDPARAMS
tom@439: module4.child1 = SAI
tom@439: 
tom@439: module5.name = SAI
tom@439: module5.id = weighted_sai
tom@439: module5.child1 = SAIMovie
tom@439: 
tom@439: module6.name = SAIMovie
tom@439: module6.id = graphics_time
tom@439: module6.parameters = <<<ENDPARAMS
tom@439: graph.y.min=0
tom@439: graph.y.max=0.5
tom@439: graph.freq.label=Cochlear Channel
tom@439: graph.x.label=Time Interval
tom@439: graph.type=line
tom@439: ENDPARAMS
tom@439: }}}
tom@439: 
tom@439: Each module has a number. The varaibles {{{module<n>.name and module<n>.id}}} are required for each module. If {{{module<n>.parameters and module<n>.child<m>}}} are specified they will be used. If no parameters are specified for a given module, the defaults are used. Any parameters given for a module override the defaults built in to the module.
tom@439: 
tom@439: === Module names and identifiers ===
tom@439: Each module specified in the tree is an instance of an AIM-C module with a specific set of parameters. By convention each instance of a module is identified by a [http://en.wikipedia.org/wiki/CamelCase camel case] name, and each module is identified by a lowercase name with underscores.
tom@439: 
tom@439: === Module parameters ===
tom@439: 
tom@439: All AIM-C modules can have a default set of parameters. These can be overridden by parameters in the {{{module<n>.parameters}}} section of the configuration file. 
tom@439: 
tom@439: