PIVlab_GUI.m

% PIVlab - Digital Particle Image Velocimetry Tool for MATLAB
% initiated by by Dr. William Thielicke and Prof. Dr. Eize J. Stamhuis
% developed by William Thielicke
% http://PIVlab.blogspot.com
% Third party content, thank you for your contributions!
% 3-point gaussian sub-pixel estimator by Uri Shavit, Roi Gurka, Alex Liberzon
% inpaint_nans by John D'Errico
% uipickfiles by Douglas Schwarz
% smoothn, dctn, idctn by Damien Garcia
% Exportfig by Ben Hinkle
% mmstream2 by Duane Hanselman
% f_readB16 by Carl Hall
% natsort, natsortfiles by Stephen23
%% TODO:
%{
%}

function PIVlab_GUI(desired_num_cores,batch_session_file)
%% Make figure
fh = findobj('tag', 'hgui');
if isempty(fh)
	%{
	splashscreen = figure('integerhandle','off','resize','off','windowstyle','modal','numbertitle','off','MenuBar','none','DockControls','off','Name','Loading...','Toolbar','none','Units','pixels','Position',[10 10 100 100],'tag','splashscreen','visible','off','handlevisibility','on');
	splash_ax=axes(splashscreen,'units','normalized');
	imshow(imread('pivlab_logo1.jpg'),"Parent",splash_ax,'border','tight');
	set(splash_ax,'Position',[0 0 1 1])
	set(gca,'DataAspectRatioMode','auto')
	movegui(splashscreen,'center');
	set(splashscreen,'visible','on')
	drawnow
	handle_splash_text = text(splash_ax,10,10,'Loading, please wait...');
	%}
	MainWindow = figure('numbertitle','off','MenuBar','none','DockControls','off','Name','INITIALIZING...','Toolbar','none','Units','normalized','Position',[0 0.1 1 0.8],'ResizeFcn', @gui.gui_MainWindow_ResizeFcn,'CloseRequestFcn', @gui.gui_MainWindow_CloseRequestFcn,'tag','hgui','visible','off','KeyPressFcn', @gui.gui_key_press);
	set (MainWindow,'Units','Characters');
	%clc
	%% Initialize
	handles = guihandles; %alle handles mit tag laden und ansprechbar machen
	guidata(MainWindow,handles)
	setappdata(0,'hgui',MainWindow);
	version = '3.00';
	gui.gui_put('PIVver', version);
	try
		load('PIVlab_settings_default.mat','build_date');
	catch
		build_date='';
	end
	if isempty(build_date)
		build_date='';
	else
	end

	v=ver('MATLAB');

	if ~exist('desired_num_cores','var')
		disp('-> Use the command "PIVlab_GUI(Nr_of_cores)" to select the amount of computation cores.')
	end

	if ~exist('splash_ax','var')
		disp(['-> Starting PIVlab ' version ', built on: ' char(datetime(build_date)) ' ...'])

		disp(['-> Using MATLAB version ' v.Version ' ' v.Release ' on ' computer '.'])
	else
		text_content=get(handle_splash_text,'String');
		set (handle_splash_text, 'String',[text_content newline '-> Starting PIVlab ' version ' ...' newline '-> Using MATLAB version ' v.Version ' ' v.Release ' on ' computer '.']);
	end

	margin=1.5;
	panelwidth=45;
	panelheighttools=12;
	panelheightpanels=35;
	do_correlation_matrices=0; % enable or disable the output of raw correlation matrices
	gui.gui_put('do_correlation_matrices',do_correlation_matrices);
	gui.gui_put('panelwidth',panelwidth);
	gui.gui_put('margin',margin);
	gui.gui_put('panelheighttools',panelheighttools);
	gui.gui_put('panelheightpanels',panelheightpanels);
	gui.gui_put('quickwidth',panelwidth);
	gui.gui_put('quickheight',3.2);
	gui.gui_put('quickvisible',1);
	gui.gui_put('alreadydisplayed',0);
	gui.gui_put('video_selection_done',0);

	%% check write access

	try
		temp=rand(3,3);
		save('temp.mat','temp');
		if ispc %Matlab seems to have issues with deleting files on unix systems
			delete 'temp.mat'
		end
		disp('-> Write access in current folder ok.')
	catch
		disp(['-> No write access in ' pwd '. PIVlab won''t work like this.'])
		disp('Press any key to continue... (but remember, PIVlab won''t work like this...)')
		beep;commandwindow;pause
	end


	%% Load defaults
	try
		psdfile=which('PIVlab_settings_default.mat');
		dindex=strfind(psdfile,filesep); %filesep ist '\'
		import.import_read_panel_width('PIVlab_settings_default.mat',psdfile(1:(dindex(end)-1)));
	catch
		try
			disp(['Could not load default settings in this path: ' psdfile(1:(dindex(end)-1))])
		catch
		end
		disp('Could not load default settings. But this doesn''t really matter.')
	end
	%% check required files
	tempfilepath = fileparts(which('PIVlab_GUI.m'));
	addpath(fullfile(tempfilepath, 'PIVlab_capture_resources'));
	try
		ctr=0;
		pivFiles = {'dctn.m' 'idctn.m' 'inpaint_nans.m' 'piv_DCC.m' 'piv_FFTmulti.m' 'PIVlab_preproc.m' 'PIVlab_postproc.m' 'PIVlablogo.jpg' 'smoothn.m' 'uipickfiles.m' 'PIVlab_settings_default.mat' 'hsbmap.mat' 'parula.mat' 'exportfig.m' 'fastLICFunction.m' 'icons.mat' 'mmstream2.m' 'PIVlab_citing.m' 'icons_quick.mat' 'f_readB16.m' 'vid_import.m' 'vid_hint.jpg' 'PIVlab_capture_pco.m' 'PIVlab_image_filter.m' 'pivparpool.m' 'pivprogress.m' 'piv_analysis.m' 'piv_quick.m' 'PIVlab_notch_filter.m' 'PIVlab_correlation_filter.m' 'PIVlab_capture_devicectrl_GUI.m' 'PIVlab_capture_lensctrl_GUI.m' 'PIVlab_capture_lensctrl.m' 'PIVlab_capture_sharpness_indicator.m' 'straddling_graph.m'};
		for i=1:size(pivFiles,2)
			if exist(pivFiles{1,i},'file')~=2
				disp(['ERROR: A required file was not found: ' pivFiles{1,i}]);
				disp('Press any key to continue... (but remember, PIVlab won''t work like this...)')
				beep;commandwindow;pause
			else
				ctr=ctr+1;
			end
		end
		if ctr==size(pivFiles,2)
			disp('-> All required files found.')
		end
	catch
		disp('-> Problem detecting required files.')
	end
	%%
	gui.gui_generateUI
	gui.gui_generateMenu

	%% Prepare axes
	gui.gui_switchui('multip01');
	pivlab_axis=axes('units','characters','parent',MainWindow);
	axis image;
	set(gca,'ActivePositionProperty','outerposition');%,'Box','off','DataAspectRatioMode','auto','Layer','bottom','Units','normalized');
	set(MainWindow, 'Name',['PIVlab ' gui.gui_retr('PIVver')])% ' by William Thielicke and Eize J. Stamhuis'])
	gui.gui_put('pivlab_axis',pivlab_axis);
	%%
	misc.misc_Lena
	%% Check Matlab version
	try
		if verLessThan('matlab', '9.7') == 0
			disp('-> Matlab version check ok.')
		else
			disp('WARNING: Your Matlab version is too old for running PIVlab.')
			disp('WARNING: You need at least version 9.7 (R2019b) to use all features.')
			disp('Press any key to continue... (but remember, PIVlab won''t work like this...)')
			beep;commandwindow;pause
		end
	catch
		disp('MATLAB version could not be checked automatically.')
		disp('WARNING: You need at least version 9.7 (R2019b) to use all features.')
		disp('Press any key to continue... (but remember, PIVlab won''t work like this...)')
		beep
		beep;commandwindow;pause
	end
	%% Check image toolbox availability
	try
		result=license('checkout','Image_Toolbox');
		if result == 1
			try
				J = adapthisteq(rand(8,8)); %#ok<NASGU>
				disp('-> Image Processing Toolbox found.')
			catch
				disp(' ')
				disp('Image Processing Toolbox not accessible! PIVlab won''t work like this.')
				disp('A license has been found, but the toolbox could not be accessed.')
				disp('This is not a PIVlab related issue. Before you can use PIVlab, you need to make sure that the following command can be run without error message from the MATLAB command line:')
				disp('"J = adapthisteq(rand(8,8))" (enter this without quotes)')
				disp(' ')
				disp('Press any key to continue... (but remember, PIVlab won''t work like this...)')
				beep;commandwindow;pause
			end
		else
			disp('ERROR: Image Processing Toolbox not found! PIVlab won''t work like this.')
			disp('Press any key to continue... (but remember, PIVlab won''t work like this...)')
			beep;commandwindow;pause
		end
		%% Check parallel computing toolbox availability
		gui.gui_put('parallel',0);
		try %checking for a parallel license file throws a huge error message wheh it is not available. This might scare users... Better: Try...catch block
			if ~exist('desired_num_cores','var') %no input argument --> use all existing cores
				if pivparpool('size')<=0 %no exisitng pool
					pivparpool('open',feature('numCores')); %use all cores
				end
				gui.gui_put('parallel',1);
			else%parameter supplied
				if desired_num_cores > 1 && desired_num_cores ~= pivparpool('size') %desired doesn't match existing pool
					if desired_num_cores > feature('numCores')%desired too many cores
						desired_num_cores=feature('numCores');
						disp('Selected too many cores. Adjusted to actually existing cores')
					end
					pivparpool('close')
					pivparpool('open',desired_num_cores);
					gui.gui_put('parallel',1);
				elseif desired_num_cores < 2 %leq than 1 core desired --> serial processing.
					pivparpool('close')
					gui.gui_put('parallel',0);
				elseif desired_num_cores==pivparpool('size')
					gui.gui_put('parallel',1);
				end
			end
			if gui.gui_retr('parallel')==1
				disp(['-> Distributed Computing Toolbox found. Parallel pool (' int2str(pivparpool('size')) ' workers) active (default settings).'])
			else
				disp('-> Distributed Computing disabled.')
			end
		catch
			disp('-> Running without parallelization (no distributed computing toolbox installed).')
		end

		handles=gui.gui_gethand;
		load icons.mat
		if gui.gui_retr('parallel') == 1
			set(handles.toggle_parallel, 'cdata',parallel_on,'TooltipString','Parallel processing on. Click to turn off.');
		else
			set(handles.toggle_parallel, 'cdata',parallel_off,'TooltipString','Parallel processing off. Click to turn on.');
		end

	catch
		disp('Toolboxes could not be checked automatically. You need the Image Processing Toolbox.')
	end

	%% Variable initialization
	gui.gui_put ('toggler',0);
	gui.gui_put('calu',1);
	gui.gui_put('calv',1);
	gui.gui_put('calxy',1);
	gui.gui_put('offset_x_true',0)
	gui.gui_put('offset_y_true',0)
	gui.gui_put('subtr_u', 0);
	gui.gui_put('subtr_v', 0);
	gui.gui_put('displaywhat',1);%vectors


	%% read current and last directory.....:
	warning('off','all') %if the variables don't exist, an ugly warning is displayed
	load('PIVlab_settings_default.mat','homedir');
	load('PIVlab_settings_default.mat','pathname');
	warning('on','all')
	warning('off','serialport:serialport:ReadlineWarning')
	if ~exist('pathname','var') || ~exist('homedir','var')
		try
			if exist(fullfile(fileparts(which('PIVlab_GUI.m')), 'Examples'),'dir') == 7 %if no previous path -> check if example dir exists
				homedir =fullfile(fileparts(which('PIVlab_GUI.m')), 'Examples'); %... and use it as default
				pathname=homedir;
				disp('-> No previous path found, using default path.')
			else %if example path doesnt exist -> use current directory
				homedir=pwd;
				pathname=pwd;
				disp(['-> Start up path: ' pwd])
			end
		catch %if something goes wrong -> use current dir
			homedir=pwd;
			pathname=pwd;
			disp(['-> Start up path: ' pwd])
		end
	else
		if exist(pathname ,'dir') ~= 7 %stored path doesnt exist -> replace with default
			homedir=pwd;
			pathname=pwd;
		end
		disp(['-> Start up path: ' pathname])
	end
	gui.gui_put('homedir',homedir);
	gui.gui_put('pathname',pathname);
	save('PIVlab_settings_default.mat','homedir','pathname','-append');

	%% Read and apply default settings
	try
		%XP Wu modification:
		psdfile=which('PIVlab_settings_default.mat');
		dindex=strfind(psdfile,filesep); %filesep ist '\'
		%erstes argument datei, zweites pfad bis zum letzten fileseperator.
		import.import_read_settings('PIVlab_settings_default.mat',psdfile(1:(dindex(end)-1)));
		disp(['-> Got default settings from: ' psdfile])
	catch
		disp('Could not load default settings. But this doesn''t really matter.')
	end
	%%

	%%
	misc.misc_CheckUpdates
	gui.gui_SetFullScreen

	gui.gui_displogo(1);drawnow;
	try
		close(splashscreen)
	catch
	end
	set(MainWindow, 'Visible','on');

	%% Batch session  processing in GUI
	if ~exist('batch_session_file','var') %no input argument --> no GUI batch processing
		gui.gui_put('batchModeActive',0)
	else
		if exist (batch_session_file,'file')
			[filepath,name,ext] = fileparts(batch_session_file);
			import.import_load_session_Callback (1,batch_session_file)
			disp('')
			disp(['Batch mode, analyzing ' batch_session_file])
			batch_session_file_output=fullfile(filepath,[name '_BATCH' ext]);
			disp(['Output will be saved as:  ' batch_session_file_output ])
			disp('...running PIV analysis...')
			piv.piv_do_analys_Callback
			piv.piv_AnalyzeAll_Callback
			disp('...running post processing...')
			validate.validate_apply_filter_all_Callback
			disp('...saving output...')
			export.export_save_session_Callback(1,batch_session_file_output)

			gui.gui_put('batchModeActive',1)
			disp('done, exiting...')
			gui.gui_MainWindow_CloseRequestFcn
		else
			disp(['NOT FOUND: ' batch_session_file])
			gui.gui_put('batchModeActive',0)
		end
	end

else %Figure handle does already exist --> bring PIVlab to foreground.
	disp('Only one instance of PIVlab is allowed to run.')
	figure(fh)
end