test_ivc.m

function [singles, pairs] = test_ivc(runnum, imgnum, expected_num)
% Image View & Compare :: A command line program for viewing and comparing indexed or non-indexed (raster or non-raster) TIF images that exist in a test file directory speicifed by test_setGlobals.m.

command_args = ["browse"];
preselect = false;
concurrent = false;
if exist('imgnum', 'var')
    command_args = [command_args, "add"];
    preselect = true;
end
if exist('runnum', 'var')
    runnum = num2str(runnum);
    if isempty(runnum)
        runnum = '[]';
    end
    command_args = [command_args, runnum];
end
if exist('imgnum', 'var')
    imgnum = num2str(imgnum);
    if isempty(imgnum)
        imgnum = '[]';
    end
    command_args = [command_args, imgnum];
end
if exist('expected_num', 'var')
    concurrent = true;
    if isempty(expected_num)
        clear expected_num;
    elseif expected_num < 1
        error('Argument expected_num must be greater than or equal to 1.');
    end
end
if ~exist('imgnum', 'var')
    runnum = '[]';
    imgnum = '[]';
    command_args = [command_args, runnum, imgnum];
end
command = strjoin(command_args);

test_setGlobals();
global TESTDIR;


fprintf('TESTDIR set from test_getTestDir.m: %s\n', TESTDIR);

if exist(TESTDIR, 'dir') ~= 7
    mkdir(TESTDIR);
end

FILE_COMPARE_WAIT  = [TESTDIR,'/','COMPARE_WAIT'];
FILE_COMPARE_READY = [TESTDIR,'/','COMPARE_READY'];

if concurrent
    fid = fopen(FILE_COMPARE_WAIT, 'wt');
    fclose(fid);
    fid = fopen(FILE_COMPARE_READY, 'wt');
    fclose(fid);
end

fprintf(2, ['' ...
        '\n----- IVC COMMANDS -----\n' ...
        'browse [runnum] [imgnum]\n' ...
        '    :: Browse TESTDIR, may use "[]" as wildcard.\n' ...
        'list :: Show current BROWSE and SELECTION.\n' ...
        'add [browse_1] [browse_2] ... [browse_n]\n' ...
        '    :: Add images to SELECTION by current BROWSE index.\n' ...
        'remove [selection_1] [selection_2] ... [selection_n]\n' ...
        '    :: Remove images from SELECTION by current SELECTION index.\n' ...
        'delete [selection_1] [selection_2] ... [selection_n]\n' ...
        '    :: Delete images from TESTDIR by current SELECTION index.\n' ...
        'refresh :: Update BROWSE and SELECTION with current TESTDIR contents.\n' ...
        'view {img/ras} {noimg} {nohist} {nodata=x} {big} [selection_1] [selection_2] ... [selection_n]\n' ...
        '    :: View images separately by current SELECTION index.\n' ...
        'compare {img/ras} {noimg} {nohist} {nodata=x} {masknans} {showcast} {split} {difflate} {big} [selection_1 selection_2]\n' ...
        '    :: Compare two images by current SELECTION index.\n' ...
        'auto {img/ras} {noimg} {nohist} {nodata=x} {masknans} {showcast} {split} {difflate} {big}\n' ...
        '    :: Compare ml/py image pairs as saved by SRA/SIA, view others.\n' ...
        'figclose :: Close all figures.\n' ...
        'quit :: Exit without closing figures.\n' ...
        'close :: Close all figures and exit.\n']);

indexstr = '';
browseFiles = [];
browse = [];
selection = [];
view = [];
compare = [];
errmsg = '';

ready = false;
while ~ready
    arg_nums = cell2mat(arrayfun(@(x) str2double(char(x)), command_args, 'UniformOutput', false));
    arg_nums(isnan(arg_nums)) = [];
    isIVCcommand = false;
    show_browse_selection = false;
    try

        if strcmp(command_args(1), 'figclose')
            isIVCcommand = true;
            close all;

            command_args(1) = [];
        end

        if strcmp(command_args(1), 'list')
            isIVCcommand = true;

            command_args(1) = [];
            show_browse_selection = true;
        end

        if strcmp(command_args(1), 'delete')
            isIVCcommand = true;
            if isempty(arg_nums)
                to_delete = selection;
            else
                to_delete = selection(arg_nums);
            end

            for i = 1:length(to_delete)
                delete([TESTDIR,'/',char(to_delete(i))]);
            end

            command_args(1) = 'refresh';
            show_browse_selection = true;
        end

        if strcmp(command_args(1), 'refresh')
            isIVCcommand = true;
            if length(command_args) < 2 || ~strcmp(command_args(2), 'browse')
                browseFiles = dir([TESTDIR,'/',indexstr,'*.tif']);
                browse = setdiff({browseFiles.name}, selection);
            end
            testFiles = dir(TESTDIR);
            selection = intersect(selection, {testFiles.name});

            command_args(1) = [];
            show_browse_selection = true;
        end

        if strcmp(command_args(1), 'browse')
            isIVCcommand = true;
            runnum = [];
            imgnum = [];
            arg = 1;
            for i = 2:length(command_args)
                num = str2double(char(command_args(i)));
                if ~isnan(num) || strcmp(command_args(i), '[]')

                    if arg == 1
                        if isnan(num)
                            num = test_getLastRunnum();
                            if isempty(num)
                                break;
                            end
                        end
                        runnum = num;
                        arg = arg + 1;

                    elseif arg == 2
                        if isnan(num)
                            num = test_getNextImgnum(runnum, true, false);
                        end
                        imgnum = num;
                        arg = arg + 1;

                    else
                        fprintf("Ignoring excess number arguments to 'browse' command.\n");
                        break;
                    end
                end
            end

            indexstr_run = '';
            indexstr_img = '';
            if ~isempty(runnum)
                indexstr_run = sprintf('run%03d_', runnum);
                if ~isempty(imgnum)
                    indexstr_img = sprintf('%03d_', imgnum);
                end
            end

            indexstr = [indexstr_run,indexstr_img];
            browseFiles = dir([TESTDIR,'/',indexstr,'*.tif']);
            browse = setdiff({browseFiles.name}, selection);

            command_args(1) = [];
            arg_nums = [];
            show_browse_selection = true;
        end

        if any(strcmp(command_args(1), ["add", "remove"]))
            isIVCcommand = true;
            if strcmp(command_args(1), 'add')
                if isempty(arg_nums)
                    selection = [selection, browse];
                else
                    selection = [selection, browse(arg_nums)];
                end
            elseif strcmp(command_args(1), 'remove')
                if isempty(arg_nums)
                    selection = [];
                else
                    selection(arg_nums) = [];
                end
            end

            browse = setdiff({browseFiles.name}, selection);

            command_args(1) = [];
            arg_nums = [];
            show_browse_selection = true;
        end

        if any(strcmp(command_args(1), ["view", "comp", "compare", "auto"]))
            isIVCcommand = true;
            view = [];
            compare = [];

            if isempty(selection)
                errmsg = 'No images are selected for viewing/comparing.';
                error('CUSTOM MESSAGE');
            else

                if strcmp(command_args(1), 'view')
                    if isempty(arg_nums)
                        view_list = selection;
                    else
                        view_list = selection(arg_nums);
                    end
                    view = repmat("", [length(view_list), 2]);
                    view(:,1) = view_list;

                elseif any(strcmp(command_args(1), ["comp", "compare"]))
                    select_num_a = [];
                    select_num_b = [];

                    if isempty(arg_nums)
                        [~, compare] = test_matchFnames(selection);
                        if isempty(compare)
                            if length(selection) ~= 2
                                errmsg = 'No images could be automatically matched for comparison.';
                                error('CUSTOM MESSAGE');
                            end
                            arr1 = test_readImage(selection(1));
                            arr2 = test_readImage(selection(2));
                            if ~isequal(size(arr1), size(arr2))
                                errmsg = "Selected pair of images differ in array shape.";
                                errmsg = strcat(errmsg, sprintf("\n'%s': %dx%d\n", char(selection(1)), size(arr1, 1), size(arr1, 2)));
                                errmsg = strcat(errmsg, sprintf("'%s': %dx%d", char(selection(2)), size(arr2, 1), size(arr2, 2)));
                                error('CUSTOM MESSAGE');
                            end
                            clear('arr1', 'arr2');
                            select_num_a = 1;
                            select_num_b = 2;
                        end
                    elseif length(arg_nums) ~= 2
                        errmsg = "Zero or two number arguments must be given to 'compare' command.";
                        error('CUSTOM MESSAGE');
                    else
                        select_num_a = arg_nums(1);
                        select_num_b = arg_nums(2);
                    end

                    if isempty(compare)
                        compare = repmat("", [1, 2]);
                        compare(1,1) = selection(select_num_a);
                        compare(1,2) = selection(select_num_b);
                    end

                elseif strcmp(command_args(1), 'auto')
                    [view, compare] = test_matchFnames(selection, true);
                end

                % Handle options for view/compare/auto.
                set_image_type = false;
                image_type = -1;
                nodata_val = [];
                mask_nans = false;
                display_image = true;
                display_histogram = true;
                display_casting = false;
                display_split = false;
                display_difflate = false;
                display_small = true;
                if length(command_args) > 1
                    check_options = command_args(2:length(command_args));
                    if ~isempty(cell2mat(arrayfun(@(x) find(strcmp(x, ["image", "img"])), check_options, 'UniformOutput', false)))
                        image_type = 0;
                    end
                    if ~isempty(cell2mat(arrayfun(@(x) find(strcmp(x, ["raster", "ras"])), check_options, 'UniformOutput', false)))
                        if image_type ~= -1
                            errmsg = sprintf("'%s' options (img/image) and (ras/raster) cannot both be present.", command_args(1));
                            error('CUSTOM MESSAGE');
                        end
                        image_type = 1;
                    end
                    nodata_arg = find(cellfun(@(y) ~isempty(y), (arrayfun(@(x) find(strfind(x, ["nodata="])), check_options, 'UniformOutput', false))));
                    if ~isempty(nodata_arg)
                        nodata_str = strrep(check_options(nodata_arg), "nodata=", "");
                        nodata_val = str2double(nodata_str);
                        if isnan(nodata_val) && ~strcmp(lower(nodata_str), "nan")
                            errmsg = sprintf("Invalid nodata argument '%s'.", nodata_str);
                            error('CUSTOM MESSAGE');
                        end
                    end
                    if ~isempty(cell2mat(arrayfun(@(x) find(strcmp(x, ["masknans"])), check_options, 'UniformOutput', false)))
                        mask_nans = true;
                    end
                    if ~isempty(cell2mat(arrayfun(@(x) find(strcmp(x, ["noimg"])), check_options, 'UniformOutput', false)))
                        display_image = false;
                    end
                    if ~isempty(cell2mat(arrayfun(@(x) find(strcmp(x, ["nohist"])), check_options, 'UniformOutput', false)))
                        display_histogram = false;
                    end
                    if ~isempty(cell2mat(arrayfun(@(x) find(strcmp(x, ["showcast"])), check_options, 'UniformOutput', false)))
                        display_casting = true;
                    end
                    if ~isempty(cell2mat(arrayfun(@(x) find(strcmp(x, ["split"])), check_options, 'UniformOutput', false)))
                        display_split = true;
                    end
                    if ~isempty(cell2mat(arrayfun(@(x) find(strcmp(x, ["difflate"])), check_options, 'UniformOutput', false)))
                        display_difflate = true;
                    end
                    if ~isempty(cell2mat(arrayfun(@(x) find(strcmp(x, ["big"])), check_options, 'UniformOutput', false)))
                        display_small = false;
                    end
                end
                if image_type ~= -1
                    set_image_type = true;
                end

                compare_args = vertcat(view, compare);

                compare_total = compare_args.size(1);
                digits = floor(log10(compare_total)) + 1;
                num_format = ['%',num2str(digits),'d'];

                fprintf('\n');
                if compare_total > 0
                    fprintf('[t_arr1, t_arr2, t_diff, t_diff_bool] = \n');
                end
                for i = 1:compare_total
                    if strcmp(compare_args(i,2), "")
                        figtitle = compare_args(i,1);
                    else
                        figtitle = sprintf('(%s - %s)', compare_args(i,2), compare_args(i,1));
                    end

                    if ~set_image_type
                        if (contains(figtitle, '_ras_') || contains(figtitle, 'testRaster_'))
                            image_type = 1;
                        else
                            image_type = 0;
                        end
                    end
                    
                    nodata_val_str = '[]';
                    if ~isempty(nodata_val)
                        nodata_val_str = num2str(nodata_val);
                    end

                    progress = sprintf(['(',num_format,'/',num_format,')'], i, compare_total);
                    fprintf("Running %s test_compareImages('%s', '%s', '%s', %i, %s, %i, %i, %i, %i, %i, %i, %i);\n", ...
                        progress, compare_args(i,1), compare_args(i,2), figtitle, image_type, nodata_val_str, mask_nans, display_image, display_histogram, display_casting, display_split, display_difflate, display_small);
                    try
                        test_compareImages(compare_args(i,1), compare_args(i,2), figtitle, image_type, nodata_val, mask_nans, display_image, display_histogram, display_casting, display_split, display_difflate, display_small);
                    catch ME
                        fprintf(2, "*** Caught the following error during compare/view ***\n");
                        fprintf(2, "%s\n", getReport(ME));
                        fprintf(2, "--> Skipping this run and continuing...\n");
                    end
                end
                fprintf("\n");
            end

            if set_image_type
                command_args(2) = [];
            end
            command_args(1) = [];
        end

        if any(strcmp(command_args(1), ["quit", "close"]))
            isIVCcommand = true;
            if concurrent && exist(FILE_COMPARE_WAIT, 'file') == 2
                delete(FILE_COMPARE_WAIT);
            end
            while exist(FILE_COMPARE_READY, 'file') == 2
                ;
            end

            if strcmp(command_args(1), 'close')
                close all;
            end

            fprintf(2, '------------------------\n\n');
            return;
        end

        if ~isIVCcommand
            try
                eval(command);
            catch ME
                fprintf(2, "\n%s\n\n", getReport(ME));
            end
        end

    catch ME
        if strcmp(ME.message, 'CUSTOM MESSAGE')
            ;
        elseif strcmp(ME.message, 'Index exceeds array bounds.') ...
            || strcmp(ME.message, 'Index exceeds matrix dimensions.') ...
            || strcmp(ME.message, 'Matrix index is out of range for deletion.') ...
            || strcmp(ME.message, 'Subscript indices must either be real positive integers or logicals.')
            if ~isempty(command_args)
                errmsg = 'One or more number arguments is illegal.';
            end
        else
            rethrow(ME);
        end
    end

    if show_browse_selection
        indexstr_display = '(';
        if ~isempty(runnum)
            indexstr_display = [indexstr_display, sprintf('run%03d', runnum)];
            if ~isempty(imgnum)
                indexstr_display = [indexstr_display, sprintf(', img%03d', imgnum)];
            end
        else
            indexstr_display = [indexstr_display, 'all'];
        end
        indexstr_display = [indexstr_display, ')'];

        if ~preselect && ~exist('expected_num', 'var')
            fprintf('\n--- BROWSE %s ---\n', indexstr_display);
            if isempty(browse)
                fprintf('(empty)\n');
            else
                digits = floor(log10(length(browse))) + 1;
                num_format = ['%-',num2str(digits),'d'];
                for i=1:length(browse)
                    fprintf([num_format,': %s\n'], i, string(browse(i)));
                end
            end
        end

        if preselect || exist('expected_num', 'var')
            fprintf('\n--- SELECTION %s ---\n', indexstr_display);
        else
            fprintf('\n--- SELECTION ---\n');
        end
        if isempty(selection)
            fprintf('(empty)\n');
        else
            digits = floor(log10(length(selection))) + 1;
            num_format = ['%-',num2str(digits),'d'];
            for i=1:length(selection)
                fprintf([num_format,': %s\n'], i, string(selection(i)));
            end
        end
        fprintf('\n');
    end

    if preselect
        preselect = false;
    end

    if ~strcmp(errmsg, '')
        fprintf(2, '\n%s\n', errmsg);
        fprintf('\n');
        errmsg = '';
    end

    if exist('expected_num', 'var')
        if length(selection) ~= expected_num
            fprintf(2, '%d images are expected for comparison.\n', expected_num);
            if length(selection) < expected_num
                fprintf('Press [ENTER] to update selection.\n\n');
            else
                fprintf(2, 'WARNING: More images are selected than expected.\n');
                clear expected_num;
            end
        else
            clear expected_num;
        end
    end

%     if show_browse_selection && ~isempty(selection) && ~exist('expected_num', 'var')
%         fprintf('(Press [ENTER] to start auto view/compare of selected images)\n\n');
%     end

    fprintf(2, 'IVC>> ');
    next_command = input('', 's');

    if exist('expected_num', 'var')
        if strcmp(next_command, '')
            next_command = command;
        else
            clear expected_num;
        end
    end
    command = next_command;

%     if show_browse_selection && ~isempty(selection) && strcmp(command, '')
%          command = [command, ' auto'];
%     end

    command_args = string(strsplit(strtrim(command), ' '));
end