annotate README @ 7:e2242b4b0b3d

Allow instructions file to be passed as a command line argument. Ignore-this: 60e440775e698898e485f8f0dfbd3db
author Marcus Pearce <m.pearce@gold.ac.uk>
date Fri, 15 Jul 2011 16:36:53 +0100
parents ac0d14c9c9ab
children 235484b93707
rev   line source
m@0 1 AUTHOR
m@0 2
m@0 3 Marcus Pearce <m.pearce@gold.ac.uk>
m@0 4
m@0 5
m@0 6 USAGE
m@0 7
m@7 8 java Experiment <show clock?> <multiple> <n> <midi device> <scale length> <low anchor> <high anchor> <midi file directory> <instructions file>
m@0 9
m@3 10 where <show clock?> specifies whether to show the clock (0 = no; 1 =
m@3 11 yes) and <multiple> and <n> are integers: the clock runs for <n> time
m@0 12 units before a probed event where the time unit is a multiple of the
m@3 13 tatum as specified by <multiple>.
m@1 14
m@1 15 <midi device> is an integer specifying the midi device to use (usually 0).
m@1 16
m@1 17 <scale length> is the number of levels of the rating scale and <low
m@1 18 anchor> and <high anchor> are its high and low anchors respectively
m@1 19 (e.g., "highly unexpected", "highly expected" with a scale length of
m@1 20 7).
m@1 21
m@4 22 <midi file directory> is the directory where the midi files are stored
m@4 23
m@7 24 <instructions file> is an html file containing the instructions for
m@7 25 the participant which will be displayed at the beginning of the
m@7 26 experiment.
m@7 27
m@1 28 See runExperiment.bat for an example.
m@0 29
m@0 30 To use in a study:
m@0 31
m@4 32 1. put the relevant midi files in the directory specified by <midi
m@4 33 file directory> (e.g., Data/Midi/)
m@0 34
m@7 35 2. edit pfilelist.txt and filelist.txt (also in <midi file directory>)
m@7 36 to contain the midi files played in the practice and main blocks
m@4 37 respectively: put one file on each line followed by a list of note
m@7 38 numbers to probe with the visual clock. NB: that the last line of
m@7 39 these files must terminate with a newline.
m@0 40
m@7 41 3. edit Data/instructions.html if necessary or create a new set of
m@7 42 instructions.
m@0 43
m@0 44 The results are written to files in the Results/ directory.
m@0 45
m@6 46 4. responses can be given either using the mouse or using the numeric
m@6 47 keys (except in the case of a scalelength of 2 where the keys 'q' and
m@6 48 'p' are used).
m@0 49
m@0 50 FILES AND DIRECTORIES:
m@0 51
m@0 52 Data/:
m@7 53 - instructions.html: the default instructions file
m@0 54 - pfilelist.txt: the list of midi filenames in the practice block
m@0 55 - filelist.txt: the list of midi filenames in the main block
m@0 56 - Midi/: the location of the midi files specified above
m@0 57
m@0 58 Results/:
m@0 59 - the results are written to files in this directory
m@0 60
m@0 61 Icons/:
m@0 62 - contains icons used for the GUI
m@0 63
m@0 64
m@0 65 DEVELOPMENT
m@0 66
m@0 67 The code is organised according to a MVC structure:
m@0 68
m@0 69 Model: Experiment.java
m@0 70 - FileList.java
m@0 71 - ProbeID.java
m@0 72 - MidiPlayer.java
m@0 73 - MelodyResults.java
m@0 74 - SubjectResults.java
m@0 75 - Block.java
m@0 76
m@0 77 View: ExperimentGui.java
m@0 78 - Clock.java
m@0 79 - InstructionsPanel.java
m@0 80 - StimulusPanel.java
m@0 81 - SubjectDataPanel.java
m@0 82 - InterBlockPanel.java
m@0 83
m@0 84 Controller: ExperimentController.java