annotate README @ 0:4031cbb02f08

Initial import. Ignore-this: 87317e384f22bde48db996355191fa5f
author Marcus Pearce <m.pearce@gold.ac.uk>
date Tue, 18 May 2010 11:37:10 +0100
parents
children 93ed757b9871
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@0 8 java Experiment <multiple> <n> <scale length> <low anchor> <high anchor>
m@0 9
m@0 10 where <multiple> and <n> are integers: the clock runs for <n> time
m@0 11 units before a probed event where the time unit is a multiple of the
m@0 12 tatum as specified by <multiple>. <scale length> is the number of
m@0 13 levels of the rating scale and <low anchor> and <high anchor> are its
m@0 14 high and low anchors respectively (e.g., "highly unexpected", "highly
m@0 15 expected" with a scale length of 7). See runExperiment.bat for an example.
m@0 16
m@0 17 To use in a study:
m@0 18
m@0 19 1. put the relevant midi files in Data/Midi;
m@0 20
m@0 21 2. edit pfilelist.txt and filelist.txt to contain the midi files
m@0 22 played in the practice and main blocks respectively: put one file on
m@0 23 each line followed by a list of note numbers to probe with the visual
m@0 24 clock.
m@0 25
m@0 26 3. edit Data/instructions.html if necessary.
m@0 27
m@0 28 The results are written to files in the Results/ directory.
m@0 29
m@0 30
m@0 31 FILES AND DIRECTORIES:
m@0 32
m@0 33 Data/:
m@0 34 - instructions.html: the instructions file
m@0 35 - pfilelist.txt: the list of midi filenames in the practice block
m@0 36 - filelist.txt: the list of midi filenames in the main block
m@0 37 - Midi/: the location of the midi files specified above
m@0 38
m@0 39 Results/:
m@0 40 - the results are written to files in this directory
m@0 41
m@0 42 Icons/:
m@0 43 - contains icons used for the GUI
m@0 44
m@0 45
m@0 46 DEVELOPMENT
m@0 47
m@0 48 The code is organised according to a MVC structure:
m@0 49
m@0 50 Model: Experiment.java
m@0 51 - FileList.java
m@0 52 - ProbeID.java
m@0 53 - MidiPlayer.java
m@0 54 - MelodyResults.java
m@0 55 - SubjectResults.java
m@0 56 - Block.java
m@0 57
m@0 58 View: ExperimentGui.java
m@0 59 - Clock.java
m@0 60 - InstructionsPanel.java
m@0 61 - StimulusPanel.java
m@0 62 - SubjectDataPanel.java
m@0 63 - InterBlockPanel.java
m@0 64
m@0 65 Controller: ExperimentController.java