Bpod Wiki - BpodParameterGUI

BpodParameterGUI()

Description

Displays the settings from the "GUI" subfield of a settings struct. Creates a user interface for viewing and manual override.

The GUI subfield names (i.e. X in Settings.GUI.X) are displayed as labels on the left. Edit boxes populated with parameter values for each X are shown on the right.
In the current version, only numerical parameters are valid.
By default, text edit boxes are used to show parameters. Other UI types can be specified.
By default, all parameters are clustered on one UI panel. Parameter groups can be specified.
When synced, the GUI will display any programmed updates to the parameter values since the last sync.
If the user manually edited a parameter, this becomes the new value irrespective of automated changes.
An example GUI automatically generated from this struct:

Settings.SamplingRate = 44100

Settings.GUI.SineWaveFrequency = 500;

Settings.GUI.SpeakerType = 1;

is shown here (also see examples below):

Syntax

On first call (before main loop):

BpodParameterGUI('init', Settings)

On subsequent calls (once per trial):

NewSettings = BpodParameterGUI('sync', Settings)

Parameters

Settings: A struct of settings and parameters with at least some numeric parameters in the subfield "GUI"
Optionally, a field GUImeta can be included in Settings.
- GUIMeta subfields are formatted as: GUImeta.[parameterName].[attribute] = value.
- GUIMeta attributes are:
  - Style (possible values: 'popupmenu', 'checkbox', 'pushbutton', 'text', 'edit')
  - String
    - A cell array of strings (for popupmenu).
- Optionally, a field GUIPanels can be included. GUIPanels fields are GUIPanels.[panelName] = {parameterNames}

Returns

NewSettings: The settings struct, updated with any parameter changes manually entered by the user

Example

% 1. This code initializes a UI for a Bpod settings struct selected on protocol launch, and syncs it on each of 10 trials (UI image above).

% Import settings or populate if empty

S = BpodSystem.ProtocolSettings; % Load settings chosen in launch manager into current workspace as a struct called S

if isempty(fieldnames(S)) % If an empty struct, populate struct with default settings

S.GUI.SineWaveFrequency = 500; % Frequency of stimulus

S.GUI.SpeakerType = 1; % Type of speaker

end

% Initialize parameter GUI plugin

BpodParameterGUI('init', S);

% Run 10 trials:

for currentTrial = 1:10

S = BpodParameterGUI('sync', S); % Sync parameters with BpodParameterGUI plugin

...Create, send and run state matrix,

...add and save events

...update S with new parameters based on performance

end

% 2. This code initializes parameters with a more complex settings UI

S = struct;

S.nonUIsetting = 23; % A setting not in S.GUI, so not included on the UI

S.GUI.InitialDelay = 0.2; % Set parameter values

S.GUI.TimeoutDelay = 5;

S.GUI.UseAntiBias = 1;

S.GUI.ManualStimulate = 'ManualStimulation(1)'; % Callback function for pushbutton

S.GUI.DifficultyLevel = 1;

S.GUIMeta.UseAntiBias.Style = 'checkbox';

S.GUIMeta.ManualStimulate.Style = 'pushbutton';

S.GUIMeta.DifficultyLevel.Style = 'popupmenu';

S.GUIMeta.DifficultyLevel.String = {'Easy', 'Difficult', 'Impossible'};

S.GUIPanels.Timing = {'InitialDelay', 'TimeoutDelay'}; % UI panel for timing parameters

S.GUIPanels.Shaping = {'UseAntiBias', 'ManualStimulate', 'DifficultyLevel'};

BpodParameterGUI('init', S);