visualStimGUI.m

function []=visualStimGUI(varargin)
%% Default params
simulationMode=false;
fprintf('Starting visual stimulation GUI in screen mode (for simulation mode start with visualStimGUI(''simulationMode'',1)\n');
initialVStim='VS_testStim';
% PsychImaging('PrepareConfiguration');
% PsychImaging('AddTask', 'General', 'UsePanelFitter', [600 450], 'Aspect');
%% Output list of default variables
%print out default arguments and values if no inputs are given
%{
if nargin==0
    defaultArguments=who;
    for k=1:numel(defaultArguments)
        eval(['defaultArgumentValue=' defaultArguments{k} ';']);
        if numel(defaultArgumentValue)==1
            disp([defaultArguments{k} ' = ' num2str(defaultArgumentValue)]);
        else
            fprintf([defaultArguments{k} ' = ']);
            disp(defaultArgumentValue);
        end
    end
    return;
end
%}
%% Collects all input variables
for k=1:2:nargin
    eval([varargin{k} '=' 'varargin{k+1};']);
end

%% Check GUI layout installation
%Check that GUI layout is installed and if not install it
installGUILayoutToolBox=false;
toolboxes = matlab.addons.toolbox.installedToolboxes;
if isempty(toolboxes)
    installGUILayoutToolBox=true;
else
    if ~any(strcmp({toolboxes.Name},'GUI Layout Toolbox'))
        installGUILayoutToolBox=true;
    end
end
if installGUILayoutToolBox
    disp('GUI Layout toolbox is not installed, trying to install...');
    d=which('GUI Layout Toolbox 2.3.5.mltbx');
    installedToolbox = matlab.addons.toolbox.installToolbox(d,true);
end

%% %%%%%%%%%%%%%%%% Parameter definitions  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
VS.hand.hMainFigure=figure; %initialize GUI figure

VS.par.dirSep=filesep; %choose file/dir separator according to platform

%collect all visual stimulation patterns
VS.par.VSDirectory=fileparts(which('visualStimGUI.m'));
VS.par.VSObjDir=[VS.par.VSDirectory VS.par.dirSep 'VStim'];
VS.par.PCspecificFilesDir=[VS.par.VSDirectory VS.par.dirSep 'PCspecificFiles'];
VS.par.savedStimFilesDir=[VS.par.VSDirectory VS.par.dirSep 'savedStims'];

%verify that visual stimulation scripts are included in the path and if not add them
if ~isfolder(VS.par.VSObjDir)
    fprintf('Default visual stimulation folder was not found in path. Adding paths.\n');
    addpath(genpath(VS.par.VSDirectory));
end

%verify that a folder for saving stim stats exists
if ~isfolder([VS.par.VSDirectory VS.par.dirSep 'stats'])
    mkdir([VS.par.VSDirectory VS.par.dirSep 'stats'])
end
% Script to get stim files from within subdirectories
dirinfo = dir([VS.par.VSObjDir VS.par.dirSep]);
dirinfo(~[dirinfo.isdir]) = [];  %remove non-directories
subdirinfo = cell(1,1);
subdirname = cell(1,1);
c = 1;
for K = 1 : length(dirinfo)
    thisdir = dirinfo(K).name;
    if ~isempty(dir(fullfile(strcat(dirinfo(3).folder,filesep,thisdir), 'VS_*.m')))
        subdirinfo{c,1} = dir(fullfile(strcat(dirinfo(3).folder,filesep,thisdir), 'VS_*.m'));
        if ismember('.',thisdir)
            thisdir = 'main';
        end
        subdirname{c,1} = thisdir;
        c=c+1;
    end
end

groupnumbers = [];
for i=1:length(subdirname)
    groupnumbers = [groupnumbers;repmat({i},length(subdirinfo{i}),1)];
end
VS.par.VSMethods= cat(1, subdirinfo{:});
VS.par.VSMethodGroups = subdirname;
VS.par.VSMethodGroupNumber = groupnumbers;
VS.par.VSMethods={VS.par.VSMethods.name};
VS.par.VSMethods=cellfun(@(x) x(1:end-2),VS.par.VSMethods,'UniformOutput',0);
VS.par.VSObjNames=cellfun(@(x) x(4:end),VS.par.VSMethods,'UniformOutput',0);
%check Matlab version for using uiextras of uix gui layout support
matlabVer=strsplit(version,'.');

%reseed random number generator
rng('shuffle');

%initial configuration
VS.par.currentVSO=find(strcmp(VS.par.VSMethods,initialVStim)); %the default visual stim (first on the list)
VS.par.screenAssignment=[3,2,3]; %1=nothing, 2=GUI, 3=VStim, eg [1, 2, 2] - 3 screen configuraiton with the first and last screen for stimulation and the 2nd for GUI
VS.par.screenTypes={'None','GUI','VStim'};

%check configuration file for PC specific values
visualStimGUIDir=fileparts(which('visualStimGUI.m'));
configFile=[visualStimGUIDir filesep 'PCspecificFiles' filesep 'GUIConfig.txt']; %JSON encoded
if exist(configFile,'file')
    fid=fopen(configFile);
    configText=fscanf(fid,'%s');
    configData=jsondecode(configText); % NOTICE: decodes all '.' to '_', ruining field names.
    fclose(fid);
    fn = fieldnames(configData);
    for i=1:numel(fn)
        fn2{i}=strrep(fn{i},'_','.');% converts '_' back to proper fied separators ('.')
        eval([fn2{i} '=configData.(fn{i});' ]);
    end
end
%initialize Psychophysics toolbox screens
VS.par.PTB_win=[];
initializeScreens(simulationMode);
VS.hand.batchMode.hBatchFigure=[]; %initialize batch mode figure handle - important for later

createVSGUI; % Create the main GUI of the visual stimulation GUI

% Switch to realtime
priorityLevel=MaxPriority(VS.par.PTB_win);
Priority(priorityLevel); %%priority is set back to regular after GUI closes
%initialize current visual stimulation object
initializeVisualStim;

%% %%%%%%%%%%%%%%%% Nested functions (only header) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% %%%%%%%%%%%%%%%%%%%%%%%%%% Initialize PTB Screen %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    function initializeScreens(simulationMode)
        if nargin==0
            simulationMode=0;
        end
        Screen('CloseAll');
        VS.par.screens=Screen('Screens');
        set(0,'Units','Pixels')
        VS.par.screenPositionsMatlab=get(0,'MonitorPositions');
        PsychTweak('UseGPUIndex', 1);
        Screen('Preference', 'ConserveVRAM',4096);
        if isunix %for visual stimulation setup
            %for working with two graphic cards on linux
            Screen('Preference', 'ScreenToHead', 0,0,0);
            %             Screen('Preference', 'ScreenToHead', 1,0,0);
            PsychTweak('UseGPUIndex',1);
        elseif ispc % this option is actually generic to situations of dual monitors on one graphics card
            if numel(VS.par.screens)>size(VS.par.screenPositionsMatlab,1)
                VS.par.screens=VS.par.screens(2:end);
            end
        end
        VS.par.nScreens=numel(VS.par.screens);

        for i=1:numel(VS.par.screens)
            screenProps=Screen('Resolution', VS.par.screens(i));
            %VS.par.ScreenWindowWidth(i)=screenProps.width; % try to remove - redundant
            %VS.par.ScreenWindowHeight(i)=screenProps.height; % try to remove - redundant
            VS.par.ScreenFrameRate(i)=screenProps.hz;
            VS.par.ScreenPixelSize(i)=screenProps.pixelSize;
            VS.par.ScreenPosOriginal(i,:)=Screen('Rect', VS.par.screens(i));
        end

        if ~isfield(VS.par,'ScreenPos') && ~simulationMode
            VS.par.ScreenPos=VS.par.ScreenPosOriginal(find(VS.par.screenAssignment==3,1,'first'),:);
        end

        if numel(VS.par.screenAssignment)>VS.par.nScreens
            msgbox({'Define screen configuration do not match available screens.','Reverting to minimal configuration. Please modify and initialize screens!'},'visual stimulation GUI error','help','replace','Success','modal');
            if VS.par.nScreens==1
                VS.par.screenAssignment=[3];%3-visual stimulation, 2-gui, 1-nothing
            elseif VS.par.nScreens==2
                VS.par.screenAssignment=[3,2];
            elseif VS.par.nScreens==3
                VS.par.screenAssignment=[3,3,1];
            end
        end
        pGUI=find(VS.par.screenAssignment==2);
        if isempty(pGUI)
            pGUI=1;
        elseif pGUI>1
            warning('Only one GUI screen can be selected in settings. Using the first screen selected as GUI');
            VS.par.screenAssignment(pGUI(2:end))=1;
        end
        scrnPos=VS.par.screenPositionsMatlab(pGUI,:);
        VS.par.GUIPosition=abs([scrnPos(1)+(scrnPos(3)-scrnPos(1))*0.01 scrnPos(2)+(scrnPos(4)-scrnPos(2))*0.07 (scrnPos(3)-scrnPos(1))*0.4 (scrnPos(4)-scrnPos(2))*0.8]);
        set(VS.hand.hMainFigure,'position',VS.par.GUIPosition);

        if ~simulationMode && VS.par.nScreens~=1
            try
                initializePTBScreens;
            catch
                disp('Please notice: Monitor test in PTB failed, use only for simulation mode!!!!');
                Screen('Preference','SkipSyncTests', 1);
                initializePTBScreens;
            end
        else
            disp('Notice! Screens in simulation mode - no syncing!!!')
            simulationMode=true;
            Screen('Preference','SkipSyncTests', 1);
            PTBScreenPosition=round([scrnPos(3)-150*9/7 scrnPos(4)-410 scrnPos(3)-50 scrnPos(4)-310]);
            [VS.par.PTB_win,VS.par.screenRect] = Screen('OpenWindow',VS.par.screens(1),[],PTBScreenPosition);
        end
    end

    function initializePTBScreens()
        for i=1:VS.par.nScreens
            if VS.par.screenAssignment(i)==3
                [VS.par.PTB_win(i)] = Screen('OpenWindow',VS.par.screens(i),[0 0 0]);
                if ~all(VS.par.ScreenPos==VS.par.ScreenPosOriginal(find(VS.par.screenAssignment==3,1,'first'),:))
                    glScalingFac=VS.par.ScreenPos([3 4])./VS.par.ScreenPosOriginal(i,[3 4]);
                    glTranslation=VS.par.ScreenPos([1 2])-VS.par.ScreenPosOriginal(i,[1 2]);
                    Screen('glTranslate', VS.par.PTB_win(i), glTranslation(1),glTranslation(2));
                    Screen('glScale', VS.par.PTB_win(i), glScalingFac(1),glScalingFac(2));
                end
            end
        end
        VS.par.PTB_win=VS.par.PTB_win(find(VS.par.screenAssignment==3)); %keep only active screens to send visual stim object
    end

%% %%%%%%%%%%%%%%%%%%%%%%%%%% Initialize VS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    function initializeVisualStim()

        childrenOfInteractivePanel=get(VS.hand.GenealBox.hInteractiveGUIparent,'Children');
        delete(childrenOfInteractivePanel);

        if isfield(VS.par,'VSO')
            VS.par.VSO.cleanUp; %clean old Vstim object
        end
        if length(VS.par.currentVSO)>1
            disp('More than one stimulation with the same name found')
        end
        eval(['VS.par.VSO=' VS.par.VSMethods{VS.par.currentVSO(1)} '(VS.par.PTB_win,VS.hand.GenealBox.hInteractiveGUIparent);']);

        %get properties of visual stimulation object
        VSControlMethods=VS.par.VSO.getVSControlMethods;
        VS.par.VSOMethod=VSControlMethods.methodName;
        VS.par.VSOMethodDescription=VSControlMethods.methodDescription;
        VS.par.nVSOMethods=numel(VS.par.VSOMethod);

        %get methods of visual stimulation object
        props=VS.par.VSO.getProperties;
        VS.par.VSOProp=props.publicPropName;
        VS.par.VSOPropDescription=props.publicPropDescription;
        VS.par.nProps=numel(VS.par.VSOProp);

        updateVisualStimBoxGUI;

    end

%% %%%%%%%%%%%%%%%%%%%%%%%%%% Callbacks %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    function changeSaveDirectory(hObj,event)
        [VS.par.saveDataFileName,VS.par.saveDataPath] = uiputfile('*.mat','Please choose a filename for saving VS metadata','VSData_XXX');
        set(VS.hand.GenealBox.hChangeDirEdit,'string',[VS.par.saveDataPath VS.par.saveDataFileName])
    end

    function CallbackRunBatchVSPush(hObj,event)
        %calculate position of Batch GUI
        VS.par.BatchGUIPosition=VS.par.GUIPosition;
        VS.par.BatchGUIPosition(1)=VS.par.GUIPosition(1)+VS.par.GUIPosition(3)+10;
        VS.par.BatchGUIPosition(3:4)=round(VS.par.BatchGUIPosition(3:4)*0.5);

        %create batch figure
        VS.hand.batchMode.hBatchFigure = figure;
        set(VS.hand.batchMode.hBatchFigure,'Position',VS.par.BatchGUIPosition,'Name','order batch stimuli GUI',...
            'NumberTitle','off', 'MenuBar','none', 'Toolbar','none', 'HandleVisibility','off');
        VS.hand.batchMode.hScrollPanel = uix.ScrollingPanel('Parent',VS.hand.batchMode.hBatchFigure);
        VS.hand.batchMode.hListBox = uix.VBox('Parent', VS.hand.batchMode.hScrollPanel, 'Padding', 5, 'Spacing', 5);
        VS.hand.batchMode.hListButtonBox  = uix.VBox('Parent', VS.hand.batchMode.hListBox, 'Padding', 5, 'Spacing', 5);
        set(VS.hand.batchMode.hListBox, 'units', 'norm', 'position', [0 0 0.75 1])
        set(VS.hand.batchMode.hListButtonBox, 'units', 'norm', 'position', [0.8 0 1 1])

        %VS.par.items = methods(arrayfun(@(x) buts{x}.Value == 1, 1:numel(buts)));
        VS.hand.batchMode.hlist = uicontrol('Parent', VS.hand.batchMode.hListBox, 'style', 'listbox');
        
        VS.hand.batchMode.hLoadBatchStims = uicontrol('Parent',VS.hand.batchMode.hListButtonBox,'String','Load stims', 'Callback', @CallBackLoadBatchStims);
        VS.hand.batchMode.hpromote = uicontrol('Parent', VS.hand.batchMode.hListButtonBox, 'String', '^', 'Callback', @(s,e)CallbackMoveitem(1));
        VS.hand.batchMode.hdemote = uicontrol('Parent', VS.hand.batchMode.hListButtonBox, 'String', 'v', 'Callback', @(s,e)CallbackMoveitem(-1));
        VS.hand.batchMode.hrunbatch = uicontrol('Parent',VS.hand.batchMode.hListButtonBox,'String','Run batch >', 'Callback', @CallbackRunBatch);
    end

    function CallBackLoadBatchStims(hObj,event)
        %load previously saved parameter file
        [FileName,PathName,FilterIndex] = uigetfile('*.mat','Choose saved visual stims',VS.par.savedStimFilesDir,'MultiSelect','on');
        %go over all loaded stims and verify that  stimulation objects still exist and have the same properties
        for ii=1:numel(FileName)
            props=load([PathName FileName{ii}]);
            if any(strcmp(props.VS_class,VS.par.VSMethods))
                fprintf('Stim %s found, checking properties...',props.VS_class);
                props.ObjectPros=properties(props.VS_class);
                for j=1:size(props.props,1)
                    if ~any(strcmp(props.ObjectPros,props.props{j,1}))
                        errordlg({'Some properties in the save stim do not exist','please save stim again for this version and reload'},'VS toolbox error');
                        return;
                    end
                end
                fprintf('Done!\n');
            else
                errordlg({'This saved stimulation is from an older version','please save again for this version and reload'},'VS toolbox error')
            end
        end
        set(VS.hand.batchMode.hlist,'string', FileName,'Tooltip',fullfile(PathName,FileName))
    end

    function CallbackMoveitem(increment)
        % Get the existing items and the current item
        items = get(VS.hand.batchMode.hlist, 'string');
        current = get(VS.hand.batchMode.hlist, 'value');
        fullPath = get(VS.hand.batchMode.hlist, 'Tooltip');
        toswap = current - increment;
        
        % Ensure that we aren't already at the top/bottom
        if toswap < 1 || toswap > numel(items)
            return
        end
        
        % Swap the two entries that need to be swapped
        inds = [current, toswap];
        items(inds) = flipud(items(inds));
        fullPath(inds) = flipud(fullPath(inds));
        
        % Update the order and the selected item
        set(VS.hand.batchMode.hlist, 'string', items);
        set(VS.hand.batchMode.hlist, 'value', toswap);
        set(VS.hand.batchMode.hlist, 'Tooltip', fullPath);
    end

    function CallbackRunBatch(hObj,event)
        VS.par.BatchStimList = get(VS.hand.batchMode.hlist, 'Tooltip');
        for stm=1:numel(VS.par.BatchStimList)
            VS.par.BatchStimProp{stm}=load(VS.par.BatchStimList{stm});
            stimNumber=find(strcmp(VS.par.VSMethods,VS.par.BatchStimProp{stm}.VS_class));
            CallbackChangeVisualStim(NaN,NaN,stimNumber);
            CallbackFileMenuLoadParams(NaN,NaN,VS.par.BatchStimList{stm})
            CallbackRunVSPush;
        end
    end
    
    function CallbackRunVSPush(hObj,event)
        %prepare save file
        saveFile=get(VS.hand.GenealBox.hChangeDirEdit,'string');
        if strcmp(saveFile,'Default dir') || ~get(VS.hand.GenealBox.hSaveStats,'value')
            currentTime=clock;
            timeString=[];
            for i=1:numel(currentTime)-1
                timeString=[timeString num2str(currentTime(i)) '_'];
            end
            sec_ms=num2str(currentTime(6));
            sec_ms(find(sec_ms=='.'))='_';
            timeString=[timeString sec_ms];
            saveFile=[VS.par.VSDirectory filesep 'stats' filesep VS.par.VSObjNames{VS.par.currentVSO} '_' timeString];
        end

        %Add screen location to visual stimulation object
        VS.par.VSO.screenPositionsMatlab=VS.par.screenPositionsMatlab;

        %run visual stimulation
        VS.par.VSO=VS.par.VSO.run;

        VSMetaData=VS.par.VSO.getProperties; %get properties

        save (saveFile,'VSMetaData');
        set(VS.hand.GenealBox.hChangeDirEdit,'string','Default dir'); %to prevent saving again on the same file name after running
        fprintf('Stimulation parameters saved to %s\n!',saveFile);

        %send mail
        if VSMetaData.allPropVal{find(ismember(VSMetaData.allPropName, 'sendMail'))}
            for i=1:numel(VSMetaData.allPropVal{find(ismember(VSMetaData.allPropName, 'sendMailTo'))})
                sendMailViaGmail(VSMetaData.allPropVal{find(ismember(VSMetaData.allPropName, 'sendMailTo'))}{i},[VSMetaData.metaClassData.Name(4:end) ' Stimulation Ended'], 'You can now open the door.');
            end
        end
        %prepare figure
        if VS.par.VSO.lastExcecutedTrial~=0
            VS.hand.stimulationStatisticsFigure=figure('Position',[VS.par.GUIPosition([1 2]) 800 600]);
            set(VS.hand.stimulationStatisticsFigure,'PaperPositionMode','auto');

            VSMetaData=VS.par.VSO.getLastStimStatistics(VS.hand.stimulationStatisticsFigure); %if a figure handle is added as input object plots
            print(saveFile(1:end-4),'-djpeg','-r300');
            %exportapp(VS.hand.stimulationStatisticsFigure,[saveFile(1:end-4) '.jpg']); %check if working - currently problematic
        end
    end


    function CallbackEstimateStimDurationPush(hObj,event)
        estimatedTime=VS.par.VSO.estimateProtocolDuration;
        hrs = floor(estimatedTime/3600);
        mnts = floor((estimatedTime/60)-(hrs*60));
        scs = estimatedTime-(mnts*60)-(hrs*3600);
        if isnan(estimatedTime)
            disp(['Estimation method non functional']);
            return;
        end
        currentTime=clock;
        outputTimeStr={['Current time: ' datestr(now)]...
            ['Estimated visual stimulation duration: ' num2str(hrs,'%02.f') ':' num2str(mnts,'%02.f') ':' num2str(scs,'%02.f') ],...
            ['Estimated stimulation end: ' datestr(datenum(now)+datenum([0 0 0 0 0 estimatedTime]))]};
        disp(outputTimeStr(:));
        h=msgbox(outputTimeStr,'VS estimated duration','help','replace');
        set(h,'Position',[VS.par.GUIPosition([1 2]) 350 80]);
    end
    function CallbackInitializeTriggersPush(hObj,event)
        VS.par.VSO.initializeTTL;
        VS.par.VSO.sendTTL(1,true);
        WaitSecs(0.25);
        VS.par.VSO.sendTTL(2,true);
        WaitSecs(0.25);
        VS.par.VSO.sendTTL(3,true);
        WaitSecs(0.25);
        VS.par.VSO.sendTTL(4,true);
        WaitSecs(0.25);
        VS.par.VSO.sendTTL(1,false);
        VS.par.VSO.sendTTL(2,false);
        VS.par.VSO.sendTTL(3,false);
        VS.par.VSO.sendTTL(4,false);
        disp('Triggers initialized');
    end

    function CallbackInitializeScreenPush(hObj,event)
        initializeScreens;
        initializeVisualStim;
    end

    function CallbackInitializePositionEdit(hObj,event)
        VS.par.ScreenPos(find(VS.par.screenAssignment==3,1,'first'),:)=str2num(hObj.String);
        initializeScreens;
        %CallbackInitializeScreenPush;
    end

    function CallbackTestVSPush(hObj,event)
    end

    function CallbackChangeMonitorConfiguration(hObj,event,monitorNum,buttonPressed)
        values=set(event.Source.Parent.Children,'Value',false);
        hObj.Value=true;
        VS.par.screenAssignment(monitorNum)=buttonPressed;
        disp('Press initialize to update the configuration');
    end
%% %%%%%%%%%%%%%%%%%%%%%%%%%% Properties callbacks %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    function CallbackChangePropertyValue(hObj,event,propertyType,propertyNumber)
        %propertyType==1->logical,2->numeric,3->string
        switch propertyType
            case 1 %logical
                VS.par.VSO.(VS.par.VSOProp{propertyNumber})=get(hObj,'value');
            case 2 %numeric
                tmpValue=str2num(get(hObj,'string'));
                if isempty(tmpValue) %for the case that the value entered is a string, not a numeric
                    h=msgbox('The format of the property is not correct, please re-enter','Attention','error','replace');
                    set(h,'Position',[VS.par.GUIPosition([1 2]) 350 80]);
                    set(hObj,'string',num2str(VS.par.VSO.(VS.par.VSOProp{propertyNumber})));
                else
                    VS.par.VSO.(VS.par.VSOProp{propertyNumber})=str2num(get(hObj,'string'));
                end
            case 3 %string
                VS.par.VSO.(VS.par.VSOProp{propertyNumber})=get(hObj,'string');
        end
    end
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% Menu callbacks %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    function CallbackChangeVisualStim(hObj,event,selectedVSO)
        set(VS.hand.visualStimMenu.([VS.par.VSMethods{VS.par.currentVSO}]),'Checked','off');
        set(VS.hand.visualStimMenu.([VS.par.VSMethods{selectedVSO}]),'Checked','on'); %select one of the stims
        VS.par.currentVSO=selectedVSO;
        initializeVisualStim;
    end

    function CallbackFileMenuLoadParams(hObj,event,fullFileName)
        if ~exist('fullFileName','var')
            [FileName,PathName,FilterIndex] = uigetfile('*.mat','Choose VS properties file',VS.par.PCspecificFilesDir);
            if exist('FileName','var')
                fullFileName=[PathName FileName];
            else
                fprintf('Stimulation not loaded!');
                return;
            end
        end
        
        props=load(fullFileName);
        if strcmp(props.VS_class,class(VS.par.VSO))
            for i=1:size(props.props,1)
                if isprop(VS.par.VSO,props.props{i,1})
                    VS.par.VSO.(props.props{i,1})=cast(props.props{i,2},class(VS.par.VSO.(props.props{i,1}))); %update object
                else
                    disp(['The loaded property : ' props.props{1,i} 'does not exist in the current visual stim Class']);
                end
            end
            updateVisualStimBoxGUI;
        else
            errordlg({'The class of the loaded configuration is different than the current class','please change to the appropriate class and reload configuration'},'VS toolbox error')
        end
    end

    function CallbackFileMenuSaveParams(hObj,event)
        VS_class=class(VS.par.VSO);
        defaultFileName=['VSConf' VS_class(3:end)];
        [FileName,PathName,FilterIndex] = uiputfile('*.mat','Choose VS properties file',[VS.par.PCspecificFilesDir filesep defaultFileName]);
        tmpProp=VS.par.VSO.getProperties;
        props(:,1)=tmpProp.publicPropName;
        props(:,2)=tmpProp.publicPropVal;
        save([PathName FileName],'props','VS_class');
    end
%% %%%%%%%%%%%%%%%%%%%%%%%%%% Create VS GUI %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    function createVSGUI()
        % Construct main GUI screen

        %% Open a window and add some menus
        set(VS.hand.hMainFigure,'Position',VS.par.GUIPosition,'Name','Visual Stimulation GUI',...
            'NumberTitle','off', 'MenuBar','none', 'Toolbar','none', 'HandleVisibility','off','CloseRequestFcn',@closeMainGUIFigure);

        % define zoom options
        VS.hand.hMainFigureZoom = zoom(VS.hand.hMainFigure); %get zoom handle
        set(VS.hand.hMainFigureZoom,'Enable','on','Motion','Both','RightClickAction','PostContextMenu');

        % set file menus
        VS.hand.hFileMenu = uimenu(VS.hand.hMainFigure, 'Label', 'File' );
        VS.hand.hFileMenuLoadStimParams=uimenu(VS.hand.hFileMenu,'Label','Load stimulation parameter','Callback', @CallbackFileMenuLoadParams);
        VS.hand.hFileMenuSaveStimParams=uimenu(VS.hand.hFileMenu,'Label','Save stimulation parameter','Callback', @CallbackFileMenuSaveParams);

        % set visual stimulation menu
        VS.hand.hVisualStimMenuMain = uimenu(VS.hand.hMainFigure, 'Label', 'Visual stimulation' );

        for j=1:length(VS.par.VSMethodGroups)
            VS.hand.hVisualStimMenu{j} = uimenu('Parent',VS.hand.hVisualStimMenuMain, 'Label', VS.par.VSMethodGroups{j});
        end

        for i=1:length(VS.par.VSMethods)
            VS.hand.visualStimMenu.([VS.par.VSMethods{i}])=uimenu('Parent',VS.hand.hVisualStimMenu{VS.par.VSMethodGroupNumber{i}},...
                'Label', VS.par.VSObjNames{i}, 'Checked','off', 'Callback', {@CallbackChangeVisualStim,i});
        end

        set(VS.hand.visualStimMenu.([VS.par.VSMethods{VS.par.currentVSO(1)}]),'Checked','on'); %select one of the stims

        % Arrange the main interface windows
        VS.hand.hMainWindow = uix.HBoxFlex('Parent',VS.hand.hMainFigure, 'Spacing',8);
        VS.hand.hGenealBox = uix.VBox('Parent',VS.hand.hMainWindow, 'Spacing',4, 'Padding',4);
        VS.hand.hPropertyBox = uix.VBox('Parent',VS.hand.hMainWindow, 'Spacing',4, 'Padding',4);
        set(VS.hand.hMainWindow, 'Widths',[-1 -1]);

        % Set left box
        VS.hand.GenealBox.hGeneralBoxPanel = uix.Panel('Parent',VS.hand.hGenealBox, 'Title','General');
        VS.hand.GenealBox.hMainVBox = uix.VBox('Parent',VS.hand.GenealBox.hGeneralBoxPanel, 'Spacing',4, 'Padding',4);

        VS.hand.GenealBox.hRunHBox=uix.HBox('Parent',VS.hand.GenealBox.hMainVBox, 'Spacing',4, 'Padding',4);
        VS.hand.GenealBox.hRunPush=uicontrol('Parent', VS.hand.GenealBox.hRunHBox, 'Style','push', 'String','Run VS (Esc = abort)','Callback',@CallbackRunVSPush);
        VS.hand.GenealBox.hRunBatchPush=uicontrol('Parent', VS.hand.GenealBox.hRunHBox, 'Style','push', 'String','Open batch GUI','Callback',@CallbackRunBatchVSPush);
        set(VS.hand.GenealBox.hRunHBox, 'Widths',[-1 -1]);

        %VS.hand.GenealBox.hRunTest=uicontrol('Parent', VS.hand.GenealBox.hMainVBox, 'Style','push', 'String','Run & Test VS','Callback',@CallbackTestVSPush);
        VS.hand.GenealBox.hSaveStats=uicontrol('Parent', VS.hand.GenealBox.hMainVBox, 'Style','checkbox', 'String','Save stats to file','value',1);

        VS.hand.GenealBox.hChDirHBox=uix.HBox('Parent',VS.hand.GenealBox.hMainVBox, 'Spacing',4, 'Padding',4);
        VS.hand.GenealBox.hChangeDirPush=uicontrol('Parent', VS.hand.GenealBox.hChDirHBox, 'Style','push','String','Ch Dir','Callback',@changeSaveDirectory);
        VS.hand.GenealBox.hChangeDirEdit=uicontrol('Parent', VS.hand.GenealBox.hChDirHBox, 'Style','edit','string','Default dir');
        set(VS.hand.GenealBox.hChDirHBox, 'Widths',[-1 -7]);

        VS.hand.GenealBox.hEstimateStimDurationPush=uicontrol('Parent', VS.hand.GenealBox.hMainVBox, 'Style','push', 'String','Estimate stim duration','Callback',@CallbackEstimateStimDurationPush);
        %VS.hand.GenealBox.hSendEMailEdit=uicontrol('Parent', VS.hand.GenealBox.hMainVBox, 'Style','edit', 'String','send email','Callback',@CallbackSendEmailEdit);

        VS.hand.GenealBox.hInitializeTriggers=uicontrol('Parent', VS.hand.GenealBox.hMainVBox, 'Style','push', 'String','Init triggers','Callback',@CallbackInitializeTriggersPush);

        VS.hand.GenealBox.hScreensPanel = uix.Panel('Parent',VS.hand.GenealBox.hMainVBox, 'Title','PTB Screens');
        VS.hand.GenealBox.hScreenVBox=uix.VBox('Parent',VS.hand.GenealBox.hScreensPanel, 'Spacing',4, 'Padding',4);

        VS.hand.GenealBox.hScreenInitHBox=uix.HBox('Parent',VS.hand.GenealBox.hScreenVBox, 'Spacing',4, 'Padding',4);
        VS.hand.GenealBox.hInitializeScreensPush=uicontrol('Parent', VS.hand.GenealBox.hScreenInitHBox, 'Style','push', 'String','initialize screen','Callback',@CallbackInitializeScreenPush);
        VS.hand.GenealBox.hInitializeScreensPositionEdit=uicontrol('Parent', VS.hand.GenealBox.hScreenInitHBox, 'Style','edit', 'String',num2str(VS.par.ScreenPosOriginal(find(VS.par.screenAssignment==3,1,'first'),:)),'Callback',@CallbackInitializePositionEdit);
        set(VS.hand.GenealBox.hScreenInitHBox, 'Widths',[-1 -1]);

        % generate Screen selection GUI 
        for s=1:VS.par.nScreens
            VS.hand.GenealBox.hPTBScreenPanel(s) = uipanel('Parent', VS.hand.GenealBox.hScreenVBox,'Title',['Monitor #' num2str(s)]);
            VS.hand.GenealBox.hPTBScreenButtongroup(s) = uix.HButtonBox('Parent', VS.hand.GenealBox.hPTBScreenPanel(s));
            for buttons=1:3
                VS.hand.GenealBox.Screenbutton(s,buttons) = uicontrol('Parent',VS.hand.GenealBox.hPTBScreenButtongroup(s),...
                    'Style','radiobutton','String',VS.par.screenTypes(buttons),'Callback',{@CallbackChangeMonitorConfiguration,s,buttons}); %change from togglebutton to radiobutton if more than one can be selected
                if VS.par.screenAssignment(s)==buttons
                    set(VS.hand.GenealBox.Screenbutton(s,buttons),'value',1);
                end
            end
        end
        VS.hand.GenealBox.hInteractiveGUIparent = uipanel('Parent', VS.hand.GenealBox.hScreenVBox,'Title','VS interactive panel');

        set(VS.hand.GenealBox.hScreenVBox, 'Heights',[30 40*ones(1,VS.par.nScreens) -1]);
        set(VS.hand.GenealBox.hMainVBox, 'Heights',[50 30 30 30 30 -1]);
    end %createGUI

    function updateVisualStimBoxGUI()
        childrenOfVisualStimBox=get(VS.hand.hPropertyBox,'Children');
        delete(childrenOfVisualStimBox);


        VS.hand.PropertyBox.hPropertyBoxPanel = uix.ScrollingPanel('Parent',VS.hand.hPropertyBox); %, 'Title','Visual stimlation object'
        VS.hand.PropertyBox.hMethodsVBox = uix.VBox('Parent', VS.hand.PropertyBox.hPropertyBoxPanel, 'Padding', 5, 'Spacing', 5);

        h = 20;
        %set VS methods box
        VS.hand.PropertyBox.hMethodsGrid=uix.Grid('Parent', VS.hand.PropertyBox.hMethodsVBox, 'Padding', 5, 'Spacing', 5);

        VSOcopy=VS.par.VSO; %For some reason, it is not possible to send a object that is part of a structure as callback
        if VS.par.nVSOMethods>0
            for i=1:VS.par.nVSOMethods
                if numel(VS.par.VSOMethodDescription)<i
                    VS.par.VSOMethodDescription{i}='';
                    disp('Some methods do not contain a description field');
                end
                VS.hand.PropertyBox.(['h' VS.par.VSOMethod{i} 'Push'])=uicontrol('Parent', VS.hand.PropertyBox.hMethodsGrid, 'Style','push',...
                    'String',VS.par.VSOMethod{i}(3:end),'TooltipString',VS.par.VSOMethodDescription{i},'HorizontalAlignment','Left');
                eval(['set(VS.hand.PropertyBox.h' VS.par.VSOMethod{i} 'Push,''Callback'',@(src,event)' VS.par.VSOMethod{i} '(VSOcopy,src,event,VS.hand.GenealBox.hInteractiveGUIparent));']);
            end

            if size(VS.hand.PropertyBox.hMethodsGrid.Widths,1)>1
                VS.hand.PropertyBox.hMethodsGrid.Widths = [-2,-1];
            else
                VS.hand.PropertyBox.hMethodsGrid.Widths = [-1];
            end

            VS.hand.PropertyBox.hMethodsGrid.Heights(:) = h;
        end
        VS.hand.PropertyBox.hMethodsVBox.Heights = VS.par.nVSOMethods*h + (VS.par.nVSOMethods+1)*5;

        %set VS property box
        VS.hand.PropertyBox.hPropertyVBox = uix.VBox('Parent', VS.hand.PropertyBox.hMethodsVBox, 'Padding', 5, 'Spacing', 5);
        VS.hand.PropertyBox.hPropertyGrid = uix.Grid('Parent', VS.hand.PropertyBox.hPropertyVBox, 'Padding', 5, 'Spacing', 5);

        for i=1:VS.par.nProps
            VS.hand.PropertyBox.(['h' VS.par.VSOProp{i} 'Txt'])=uicontrol('Parent', VS.hand.PropertyBox.hPropertyGrid, 'Style','text',...
                'String',VS.par.VSOProp{i},'TooltipString',VS.par.VSOPropDescription{i},'HorizontalAlignment','Left');
        end
        VS.hand.PropertyBox.remarksEdit=uicontrol('Parent',VS.hand.PropertyBox.hPropertyGrid, ...
            'Style','text','String',VS.par.VSO.remarks); %add the remarks text

        VS.par.VSOPropVal=cell(VS.par.nProps,1);
        for i=1:VS.par.nProps
            VS.par.VSOPropVal{i}=VS.par.VSO.(VS.par.VSOProp{i});
            if isa(VS.par.VSOPropVal{i},'logical')
                VS.hand.PropertyBox.(['h' VS.par.VSOProp{i} 'Check'])=uicontrol('Parent',VS.hand.PropertyBox.hPropertyGrid, ...
                    'Style','checkbox','value',VS.par.VSOPropVal{i},'Callback',{@CallbackChangePropertyValue,1,i});
            elseif isa(VS.par.VSOPropVal{i},'numeric')
                VS.hand.PropertyBox.(['h' VS.par.VSOProp{i} 'Edit'])=uicontrol('Parent',VS.hand.PropertyBox.hPropertyGrid, ...
                    'Style','edit','String',num2str(VS.par.VSOPropVal{i}),'Callback',{@CallbackChangePropertyValue,2,i});
            elseif ischar(VS.par.VSOPropVal{i}) || isstring(VS.par.VSOPropVal{i})
                VS.hand.PropertyBox.(['h' VS.par.VSOProp{i} 'Edit'])=uicontrol('Parent',VS.hand.PropertyBox.hPropertyGrid, ...
                    'Style','edit','String',VS.par.VSOPropVal{i},'Callback',{@CallbackChangePropertyValue,3,i});
            else
                error('One of the fields in the visual stimulation object is not a numeric, logical or string');
            end
        end
        VS.hand.PropertyBox.hPropertyGrid.Widths = [-2,-1];
        VS.hand.PropertyBox.hPropertyGrid.Heights(:) = h;
        VS.hand.PropertyBox.hPropertyVBox.Heights = VS.par.nProps*h + (VS.par.nProps+1)*5;

        VS.hand.PropertyBox.hPropertyBoxPanel.Heights =  (VS.par.nVSOMethods+VS.par.nProps)*h + (VS.par.nVSOMethods+VS.par.nProps+1)*5;

    end

    function closeMainGUIFigure(hObj,event)
        Screen('Preference','SkipSyncTests', 1);
        Screen('CloseAll');
        if ~isempty(VS.hand.batchMode.hBatchFigure)
            delete(VS.hand.batchMode.hBatchFigure);
        end
        delete(hObj);
        clear VS;
        Priority(0);
    end
end