Difference between revisions of "WaterMaze"
(→WaterMaze Main Config File) |
(→WaterMaze Main Config File) |
||
| Line 34: | Line 34: | ||
===WaterMaze Main Config File=== | ===WaterMaze Main Config File=== | ||
Which paradigms are being run during the experiment, along with other experimental setup data, are defined inside WaterMaze.xml in the data directory. | Which paradigms are being run during the experiment, along with other experimental setup data, are defined inside WaterMaze.xml in the data directory. | ||
| − | + | The config file should be structured accordingly | |
| + | <?xml version="1.0"> | ||
<Plugin> | <Plugin> | ||
<WaterMaze> | <WaterMaze> | ||
| − | + | ... | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</WaterMaze> | </WaterMaze> | ||
</Plugin> | </Plugin> | ||
| + | |||
| + | |||
Each trial is numbered sequentially. NumWidth and NumHeight specify the number of tiles in each direction. Time is the length of the trial in seconds. | Each trial is numbered sequentially. NumWidth and NumHeight specify the number of tiles in each direction. Time is the length of the trial in seconds. | ||
Revision as of 11:49, 22 November 2013
Contents |
Running WaterMaze
- Enable in mycalvr.xml
- In WaterMaze submenu of CalVR, hit Load
Commands
l - load geometry n - next trial r - repeat trial b - back to previous trial p - play/pause h - help 1-9 - reset position
To run the game, after you have loaded CalVR, press 'l' to load the game, then press 'p' to start the first trial. After the trial has completed, press 'n' to go to the next trial in the sequence, 'b' to go to a previous trial, or 'r' to repeat current trial. After you have selected a trial, press 'p' to start the trial.
When the game is paused, you may press the numbers 1-9 to reset the position of the subject to a predefined position (currently the 4 corners and the center).
Running States
- disconnected: Initial running state in CalVR. In the android controller this indicates that the device is not connected to CalVR.
- connected: CalVR is connected to an android controller and ready to start an experiment.
- experiment start: State used to indicate the beginning of a paradigm.
- geometry loaded: Scene has been loaded, ready to begin a trial.
- starting trial: Starting procedure has begun, but trial has not begun and data is not being recorded.
- running trial: Test subject is navigating the Water Maze and data is being reported to android controllers.
- ending trial: Trial is over and the trial ending procedure is being run.
- trial end: Trial ending procedure has terminated and the application is now awaiting a command.
- paradigm end: The paradigm has run the maximum number of trials and there are additional paradigms to run.
- paradigm end continuous: The paradigm either has no trial limit, or the minimum number of trials has been run, but less than the maximumum, and there are additional paradigms to be run.
- experiment end: Equivalent to paradigm end, but there are no additional paradigms to be run.
- experiment end continuous: Equivalent to paradigm end continuous, but there are no additional paradigms to be run.
Note: In the android controller source code, available operator actions are detailed inside StateManager.java
WaterMaze Main Config File
Which paradigms are being run during the experiment, along with other experimental setup data, are defined inside WaterMaze.xml in the data directory. The config file should be structured accordingly
<?xml version="1.0">
<Plugin>
<WaterMaze>
...
</WaterMaze>
</Plugin>
Each trial is numbered sequentially. NumWidth and NumHeight specify the number of tiles in each direction. Time is the length of the trial in seconds.
Doxygen API Generation
The WaterMaze CalVR contains doxygen comment tags. To enable the build of the WaterMaze API, set the value, MAKE_WATERMAZE_DOCUMENTATION to ON inside cmake. The API is included in the git repository and building WaterMaze with the MAKE_WATERMAZE_DOCUMENTATION value ON will regenerate the API. The documentation is located inside the root directory of the WaterMaze project folder inside the folder labeled doc.
