Difference between revisions of "Protocol Settings and Data files"
From Bcontrol
CarlosBrody (talk | contribs) (New page: Behavioral protocols that use Solo typically have two kinds of variables. First, a lot of GUI parameters that control how the protocol runs (e.g., one of these might be how long a white no...) |
CarlosBrody (talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | = This page only applies if you are using Solo = | ||
| + | |||
Behavioral protocols that use Solo typically have two kinds of variables. First, a lot of GUI parameters that control how the protocol runs (e.g., one of these might be how long a white noise sound to play in response to an incorrect trial). Second, a lot of variables that hold the data from a day's session, i.e., hold the outcome of running the protocol. We distinguish between these two, calling the first type of variables ''Settings'' and the second type of variables ''Data''. | Behavioral protocols that use Solo typically have two kinds of variables. First, a lot of GUI parameters that control how the protocol runs (e.g., one of these might be how long a white noise sound to play in response to an incorrect trial). Second, a lot of variables that hold the data from a day's session, i.e., hold the outcome of running the protocol. We distinguish between these two, calling the first type of variables ''Settings'' and the second type of variables ''Data''. | ||
| Line 4: | Line 6: | ||
; Saving settings. | ; Saving settings. | ||
| − | : If you've opened a protocol and you've set all the GUI variables to the values that you want for a subject, you can then save what is called a "Settings" file. You can do this by either (a) calling the function HandleParam/save_solouiparamvalues.m, which no one does; or (b) if your protocol uses the [[Plugins-saveload|@saveload]] plugin, which every protocol in their right mind does, then you click the "save settings" button. This will create a file that holds the values of all GUIs in your protocol. | + | : If you've opened a protocol and you've set all the GUI variables to the values that you want for a subject, you can then save what is called a "Settings" file. You can do this by either (a) calling the function HandleParam/save_solouiparamvalues.m, which no one does; or (b) if your protocol uses the [[Plugins-saveload|@saveload]] plugin, which every protocol in their right mind does, then you click the "save settings" button. This will create a file that holds the values of all GUIs in your protocol. |
| + | |||
| + | : The default filename and location for the file is | ||
| + | :: $RATTERDIR/SoloData/Settings/ExperimenterName/RatName/settings_@ProtocolName_ExperimenterName_RatName_yymmddx.mat | ||
| + | : where yymmdd is the current day, and x is a letter that makes this alphabetically the latest file on the day. (For example, if there is no settings file for today yet, then x will be an 'a'. If there is already a file ending in 'a', then x will be a 'b'. And so on.) | ||
| + | |||
| + | : The file will be saved locally on your disk. In most setups, it will then also be automatically uploaded to the cvs repository for $RATTERDIR/SoloData, from which it will be automatically downloaded to an actual behavior rig when the corresponding rat is going to run. | ||
; Loading settings. | ; Loading settings. | ||
| − | : | + | : When you load a settings file, all the GUI parameters in your protocol get instantiated to the values in the saved file, In addition, for each SoloParamHandle that |
Revision as of 23:12, 24 December 2011
This page only applies if you are using Solo
Behavioral protocols that use Solo typically have two kinds of variables. First, a lot of GUI parameters that control how the protocol runs (e.g., one of these might be how long a white noise sound to play in response to an incorrect trial). Second, a lot of variables that hold the data from a day's session, i.e., hold the outcome of running the protocol. We distinguish between these two, calling the first type of variables Settings and the second type of variables Data.
Protocol Settings
- Saving settings.
- If you've opened a protocol and you've set all the GUI variables to the values that you want for a subject, you can then save what is called a "Settings" file. You can do this by either (a) calling the function HandleParam/save_solouiparamvalues.m, which no one does; or (b) if your protocol uses the @saveload plugin, which every protocol in their right mind does, then you click the "save settings" button. This will create a file that holds the values of all GUIs in your protocol.
- The default filename and location for the file is
- $RATTERDIR/SoloData/Settings/ExperimenterName/RatName/settings_@ProtocolName_ExperimenterName_RatName_yymmddx.mat
- where yymmdd is the current day, and x is a letter that makes this alphabetically the latest file on the day. (For example, if there is no settings file for today yet, then x will be an 'a'. If there is already a file ending in 'a', then x will be a 'b'. And so on.)
- The file will be saved locally on your disk. In most setups, it will then also be automatically uploaded to the cvs repository for $RATTERDIR/SoloData, from which it will be automatically downloaded to an actual behavior rig when the corresponding rat is going to run.
- Loading settings.
- When you load a settings file, all the GUI parameters in your protocol get instantiated to the values in the saved file, In addition, for each SoloParamHandle that
