annotate README @ 6:ac0d14c9c9ab

Document previous change in README Ignore-this: ecd3fd874a2b69c4c271146e742f948d
author Marcus Pearce <m.pearce@gold.ac.uk>
date Thu, 25 Nov 2010 11:12:24 +0000
parents 5080b65e6963
children e2242b4b0b3d
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@4 8 java Experiment <show clock?> <multiple> <n> <midi device> <scale length> <low anchor> <high anchor> <midi file directory>
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@1 24 See runExperiment.bat for an example.
m@0 25
m@0 26 To use in a study:
m@0 27
m@4 28 1. put the relevant midi files in the directory specified by <midi
m@4 29 file directory> (e.g., Data/Midi/)
m@0 30
m@4 31 2. edit pfilelist.txt and filelist.txt (also in <midi file directory>) to
m@4 32 contain the midi files played in the practice and main blocks
m@4 33 respectively: put one file on each line followed by a list of note
m@4 34 numbers to probe with the visual clock.
m@0 35
m@0 36 3. edit Data/instructions.html if necessary.
m@0 37
m@0 38 The results are written to files in the Results/ directory.
m@0 39
m@6 40 4. responses can be given either using the mouse or using the numeric
m@6 41 keys (except in the case of a scalelength of 2 where the keys 'q' and
m@6 42 'p' are used).
m@0 43
m@0 44 FILES AND DIRECTORIES:
m@0 45
m@0 46 Data/:
m@0 47 - instructions.html: the instructions file
m@0 48 - pfilelist.txt: the list of midi filenames in the practice block
m@0 49 - filelist.txt: the list of midi filenames in the main block
m@0 50 - Midi/: the location of the midi files specified above
m@0 51
m@0 52 Results/:
m@0 53 - the results are written to files in this directory
m@0 54
m@0 55 Icons/:
m@0 56 - contains icons used for the GUI
m@0 57
m@0 58
m@0 59 DEVELOPMENT
m@0 60
m@0 61 The code is organised according to a MVC structure:
m@0 62
m@0 63 Model: Experiment.java
m@0 64 - FileList.java
m@0 65 - ProbeID.java
m@0 66 - MidiPlayer.java
m@0 67 - MelodyResults.java
m@0 68 - SubjectResults.java
m@0 69 - Block.java
m@0 70
m@0 71 View: ExperimentGui.java
m@0 72 - Clock.java
m@0 73 - InstructionsPanel.java
m@0 74 - StimulusPanel.java
m@0 75 - SubjectDataPanel.java
m@0 76 - InterBlockPanel.java
m@0 77
m@0 78 Controller: ExperimentController.java