view README @ 6:ac0d14c9c9ab

Document previous change in README
Ignore-this: ecd3fd874a2b69c4c271146e742f948d

AUTHOR

Marcus Pearce <[e-mail]>


USAGE 

  java Experiment <show clock?> <multiple> <n> <midi device> <scale length> <low anchor> <high anchor> <midi file directory>

where <show clock?> specifies whether to show the clock (0 = no; 1 =
yes) and <multiple> and <n> are integers: the clock runs for <n> time
units before a probed event where the time unit is a multiple of the
tatum as specified by <multiple>.

<midi device> is an integer specifying the midi device to use (usually 0).

<scale length> is the number of levels of the rating scale and <low
anchor> and <high anchor> are its high and low anchors respectively
(e.g., "highly unexpected", "highly expected" with a scale length of
7). 

<midi file directory> is the directory where the midi files are stored

See runExperiment.bat for an example.

To use in a study:

1. put the relevant midi files in the directory specified by <midi
file directory> (e.g., Data/Midi/)

2. edit pfilelist.txt and filelist.txt (also in <midi file directory>) to
contain the midi files played in the practice and main blocks
respectively: put one file on each line followed by a list of note
numbers to probe with the visual clock.

3. edit Data/instructions.html if necessary.

The results are written to files in the Results/ directory.

4. responses can be given either using the mouse or using the numeric
keys (except in the case of a scalelength of 2 where the keys 'q' and
'p' are used).

FILES AND DIRECTORIES: 

Data/: 
  - instructions.html: the instructions file 
  - pfilelist.txt: the list of midi filenames in the practice block 
  - filelist.txt: the list of midi filenames in the main block 
  - Midi/: the location of the midi files specified above

Results/: 
  - the results are written to files in this directory 

Icons/: 
  - contains icons used for the GUI


DEVELOPMENT 

The code is organised according to a MVC structure: 

Model:      Experiment.java 
             - FileList.java           
             - ProbeID.java
             - MidiPlayer.java
             - MelodyResults.java   
             - SubjectResults.java
             - Block.java 

View:       ExperimentGui.java 
             - Clock.java
             - InstructionsPanel.java
             - StimulusPanel.java
             - SubjectDataPanel.java
             - InterBlockPanel.java

Controller: ExperimentController.java