This Gitlab instance will be briefly unavailable today from 19:15 CET onwards for maintenance reasons.
Diese Gitlab-Instanz wird heute ab 19:15 Uhr kurzzeitig nicht verfügbar sein aufgrund von Wartungsarbeiten.
@@ -4,10 +4,50 @@ This chapter contains functions that are essential to the toolbox. The functions
## myHardwareSetup
function: myHardwareSetup
**Description**
Used to set all basic parameters of the hardware in your setup. Needs to be stored on each experimental computer in the directory where your experiment is stored. Edit this function when building a new setup. Possible parameters for every section (1-11) are given in the script. Save changes to this script in order to use the same basic parameters consistently in every experimental design. Change this function when moving your paradigm from one experimental device to another. You do not need to call this function manually, it will be called by initOTBR internally!
## myParadigmSetup
function: myParadigmSetup
**Description**
Used to set all basic parameters of the software in your setup. Needs to be stored on each experimental computer in the directory where your experiment is stored. Edit this function when building a new setup. Possible parameters for every section (1-6) are given in the script. Save changes to this script in order to use the same basic parameters consistently in every experimental design. Change this function only when building a new paradigm. You do not need to call this function manually, it will be called by initOTBR internally!
## initOTBR
function: initOTBR
**Description**
Always the first function that has to be called. Used to initialize global variables and functions, as well as to check for specific entries, pathways and installations that are essential to the toolbox. Automatically calls the functions myHardwareSetup and myParadigmSetup to setup the toolbox that handles your specific hardware.
## startExperiment
function: startExperiment
**Description**
This helper function turns off all devices, clears the screen and turns on the house light. Turning on the house light requires a proper edited myHardwareSetup.m file. It's useful to call startExperiment after initialization to start with controlled conditions. Not a necessary function but helpful in animal experiments.
**Examples**
~~~
1. startExperiment;
% Turns off all devices, clears the screen and turns on house light.
~~~
See also: feeding, punishment
## stopExperiment
function: stopExperiment
**Description**
This function closes the stimulus presentation window and takes care of all stimulus devices that are used (feeder, etc.). Always call this function at the end of your experiment.