OpenBDLM_main.m

function [data, model, estimation, misc] = OpenBDLM_main(UserInput)
%OPENBDLM_MAIN Process control for OpenBDLM
%
%   SYNOPSIS:
%     [data, model, estimation, misc] = OPENBDLM_MAIN(UserInput)
%
%   INPUT:
%      UserInput          - character or cell array of characters (optional)
%
%                           If UserInput is not provided, the function runs
%                           in interactive mode, in which online user's
%                           interactions from the command line is
%                           required to perform the analysis.
%
%                           If UserInput is a character array, it should be
%                           the name of a configuration file name (see doc)
%                           The configuration file is only used to
%                           initialize the project. The function then
%                           switches to the interactive mode.
%
%                           If UserInput is a cell array, it should contain
%                           all the inputs required for analysis (see doc).
%                           The is the batch mode, in which the function runs
%                           silently by automatically reading pre-loaded
%                           commands.
%
%   OUTPUT:
%      data                - structure
%                            see documentation for details about the fields
%                            in structure "data"
%
%      model               - structure
%                            see documentation for details about the fields
%                            in structure "model"
%
%      estimation         - structure
%                            see documentation for details about the fields
%                            in structure "estimation"
%
%      misc               - structure
%                            see documentation for details about the fields
%                            in structure "misc"
%
%   DESCRIPTION:
%      OPENBDLM_MAIN is the process control function for OpenBDLM.
%      OpenBDLM is an open-source software for performing structural
%      health monitoring using Bayesian Dynamic Linear Models
%
%   EXAMPLES:
%      [data, model, estimation, misc] = OPENBDLM_MAIN()
%      [data, model, estimation, misc] = OPENBDLM_MAIN('CFG_TEST1.m')
%      [data, model, estimation, misc] = OPENBDLM_MAIN({'''CFG_TEST1.m''', '31'})
%
%
%   EXTERNAL FUNCTIONS CALLED:
%      DataLoader, saveDataBinary, verificationDataStructure, SimulateData
%      ModelConfiguration, buildModel, displayModelMatrices
%      modifyInitialHiddenStates, modifyTrainingPeriod, learnModelParameters,
%      modifyModelParameters, chooseIsDataSimulation, chooseProjectName
%      displayProjects, initializeProject, printConfigurationFile,
%      printProjectDateCreation, saveProject, testFileExistence,
%      computeInitialHiddenStates,      plotData, plotEstimations
%
%   SUBFUNCTIONS:
%      N/A
%
%   See also
%    DATALOADER, STATEESTIMATION, LEARNMODELPARAMETERS, SAVEDATABINARY,
%    SIMULATEDATA, MODELCONFIGURATION, BUILDMODEL, DISPLAYMODELMATRICES
%    MODIFYINITIALHIDDENSTATES, MODIFYTRAININGPERIOD,VERIFICATIONDATASTRUCTURE
%    MODIFYMODELPARAMETERS, CHOOSEISDATASIMULATION, CHOOSEPROJECTNAME
%     DISPLAYPROJECTS, INITIALIZEPROJECT, PRINTCONFIGURATIONFILE,
%    PRINTPROJECTDATECREATION, SAVEPROJECT, TESTFILEEXISTENCE,
%    COMPUTEINITIALHIDDENSTATES, PLOTDATA, PLOTESTIMATIONS

%   AUTHORS:
%        James-A Goulet, Luong Ha Nguyen, Ianis Gaudot
%
%      Email: <james.goulet@polymtl.ca>
%      Website: <http://www.polymtl.ca/expertises/goulet-james-alexandre>
%
%   REFERENCES:
%       [1]  Goulet, J.-A., 2017, Bayesian dynamic linear models for
%       structural health monitoring,
%       Structural Control and Health Monitoring, Vol. 24, Issue 12.
%
%       [2]  Goulet, J.-A., Koo K., 2017, Empirical validation of Bayesian
%       dynamic linear models in the context of structural health monitoring,
%       Journal of Bridge Engineering, Vol.23, Issue 2.
%
%       [3]  Nguyen, L. H., Goulet J.-A., 2018, Anomaly detection with the
%       Switching Kalman Filter for structural health monitoring,
%       Structural Control and Health Monitoring, Vol. 25, Issue 4.
%
%   MATLAB VERSION:
%      Tested on 9.1.0.441655 (R2016b)
%
%   DATE CREATED:
%       June 27, 2018
%
%   DATE LAST UPDATE:
%       October 30, 2018

%--------------------BEGIN CODE ----------------------

%% Version of the program
OpenBDLMversion = '1.0';

%% Warning if multiple conflictous installations
%findDuplicateInstallation

%% Verify that the program is running from the right location
currentFolder = cd;
isFileExist  = (exist(fullfile(currentFolder, mfilename), 'file') == 2);

if ~isFileExist
    disp(' ');
    error('%s is called from the wrong directory.', mfilename)
end

%% Read arguments and set internal variables
if exist('UserInput', 'var')
    [misc]=setInternalVars(UserInput);
else
    [misc]=setInternalVars();
end
    
if isempty(misc)
    disp(' ');
    error('Unrecognized input argument.')
end

%% Create log file to record messages during program run
[misc] = createLogFile(misc);

%% Set default options
[misc]=setDefaultOptions(misc);

if misc.internalVars.isQuiet
    % output messages in  a specific log file
    fileID=fopen(misc.internalVars.logFileName, 'a');
else
    % output message on screen
    fileID=1;
end

if misc.internalVars.InteractiveMode.isInteractiveMode || ...
        misc.internalVars.BatchMode.isBatchMode
    
    %Set default font type
    set(0,'DefaultAxesFontname','Helvetica')
    %Set default font size
    set(0,'DefaultAxesFontSize',20)
    %Set display format
    format short g
    
    %% Display welcome menu
    welcomeOpenBDLM(misc, 'version', OpenBDLMversion)
    incTest=0;
    MaxFailAttempts = 4;
    
    isAnswerCorrect = false;
    while ~isAnswerCorrect
        
        incTest=incTest+1;
        if incTest > MaxFailAttempts ; error(['Too many failed ', ...
                'attempts (', num2str(MaxFailAttempts)  ').']) ; end
        
        fprintf(fileID, '\n');
        fprintf(fileID,'- Start a new project: \n');
        fprintf(fileID, '\n');
        fprintf(fileID,['     *      ', ...
            'Enter a configuration filename \n']);
        fprintf(fileID, '     0   -> Interactive tool \n');
        fprintf(fileID, '\n');
        
        %% Display existing & saved projects
        [~] = displayProjects(misc);
        
        fprintf(fileID, ['- Type D to Delete project(s), ', ...
            'V for Version control, Q to Quit.\n']);
        if misc.internalVars.BatchMode.isBatchMode
            UserChoice= ...
                eval(char(misc.internalVars.BatchMode.Answers{...
                misc.internalVars.BatchMode.AnswerIndex}));
            UserChoice = num2str(UserChoice);
            if ischar(UserChoice)
                fprintf(fileID, '     %s  \n', UserChoice);
            else
                fprintf(fileID, '     %s  \n', num2str(UserChoice));
            end
        else
            fprintf(fileID,'\n');
            UserChoice = input('     choice >> ', 's');
        end
        fprintf(fileID,'\n');
        
        % Remove space and quotes
        UserChoice=strrep(UserChoice,'''',''); % remove quotes
        UserChoice=strrep(UserChoice,'"','' ); % remove double quotes
        UserChoice=strrep(UserChoice, ' ','' ); % remove spaces
        
        if isempty(UserChoice)
            continue
        elseif isnan(str2double(UserChoice))
            
            misc.internalVars.BatchMode.AnswerIndex = ...
                misc.internalVars.BatchMode.AnswerIndex+1;
            
            if strcmpi('D',UserChoice) && length(UserChoice) == 1
                %% Delete project file(s)
                piloteDeleteProject(misc)
                incTest=0;
                continue
                
            elseif strcmpi('V', UserChoice) && length(UserChoice) == 1
                %% Version control
                piloteVersionControl(misc)
                data=struct; model=struct; estimation=struct; misc=struct;
                diary off
                return
                
            elseif strcmpi('Q', UserChoice) && length(UserChoice) == 1
                
                %% Quit the program
                disp('     Done ! See you soon !');
                if misc.internalVars.isQuiet
                    fclose(fileID);
                else
                    diary off
                end
                data=struct; model=struct; estimation=struct; misc=struct;
                return
                
            else
                %% Load project from configuration file
                [data, model, estimation, misc]= ...
                    loadConfigurationFile(misc, UserChoice);
                
                isAnswerCorrect = true;
                
            end
            
        elseif round(str2double(UserChoice)) == 0
            
            misc.internalVars.BatchMode.AnswerIndex = ...
                misc.internalVars.BatchMode.AnswerIndex+1;
            
            %% Load a project from interactive mode
            [data, model, estimation, misc]=loadInteractive(misc);
            
            isAnswerCorrect = true;
        else
            misc.internalVars.BatchMode.AnswerIndex = ...
                misc.internalVars.BatchMode.AnswerIndex+1;
            
            %% Load project from project file
            UserChoice = round(str2double(UserChoice));
            [data, model, estimation, misc]= ...
                loadProjectFile(misc, UserChoice);
            if ~isempty(model)
                isAnswerCorrect = true;
            end
        end
    end
    
elseif misc.internalVars.ReadFromConfigFileMode.isReadFromConfigFileMode
    
    configFileName = ...
        misc.internalVars.ReadFromConfigFileMode.ConfigFilename;
    
    %% Load project from configuration file
    [data, model, estimation, misc]= loadConfigurationFile(misc, ...
        configFileName);
end

incTest=0;
MaxFailAttempts = 4;
while(1)
    
    incTest=incTest+1;
    if incTest > MaxFailAttempts ; error(['Too many failed ', ...
            'attempts (', num2str(MaxFailAttempts)  ').']) ; end
    
    %% Display menu
    [PossibleAnswers]=displayMenuOpenBDLM(misc);
    
    %% Read user's choice
    if misc.internalVars.BatchMode.isBatchMode
        user_inputs=eval( ...
            char(misc.internalVars.BatchMode.Answers{...
            misc.internalVars.BatchMode.AnswerIndex}));
        user_inputs = num2str(user_inputs);
        if ischar(user_inputs)
            fprintf(fileID, '     %s  \n', user_inputs);
        else
            fprintf(fileID, '     %s  \n', num2str(user_inputs));
        end
    else
        user_inputs = input('     choice >> ', 's');
    end
    
    % Remove space and quotes
    user_inputs=strrep(user_inputs,'''',''); % remove quotes
    user_inputs=strrep(user_inputs,'"','' ); % remove double quotes
    user_inputs=strrep(user_inputs, ' ','' ); % remove spaces
    
    
    if isnan(str2double(user_inputs))
        
        if strcmpi(user_inputs, 'Q')
            
            %% Save project and quit
            fprintf(fileID, '\n');
            saveProject(model, estimation, misc, ...
                'FilePath', misc.internalVars.ProjectPath)
            [misc]=saveResultsMAT(data, model, estimation, ...
                misc, 'FilePath', misc.internalVars.ResultsPath, ...
                'isForceOverwrite', true);
            fprintf(fileID, '\n');
            disp('     Done ! See you soon !');
            if misc.internalVars.isQuiet
                fclose(fileID);
            else
                diary off
            end
            return
        else
            fprintf(fileID, '\n');
            fprintf(fileID, '     wrong input \n');
            continue
        end
    elseif ~ischar(user_inputs) && ...
            ~any(ismember(PossibleAnswers, user_inputs ))
        fprintf(fileID, '\n');
        fprintf(fileID, '     wrong input \n');
        continue
        
    else
        misc.internalVars.BatchMode.AnswerIndex = ...
            misc.internalVars.BatchMode.AnswerIndex+1;
        
        user_inputs = round(str2double(user_inputs));
        
        if  user_inputs==1
            %% Learn model parameters
            [data, model, estimation, misc]= ...
                piloteOptimization(data, model, estimation, misc);
            incTest=0;
        elseif  user_inputs==2
            %% Initial hidden states estimation
            [data, model, estimation, misc]= ...
                piloteInitialStateEstimation(data, model, estimation, misc);
            incTest=0;
        elseif  user_inputs==3
            %% Hidden states estimation
            [data, model, estimation, misc]= ...
                piloteStateEstimation(data, model, estimation, misc);
            incTest=0;
        elseif  user_inputs==11
            %% Modify model parameters
            [model, misc]= ...
                piloteModifyModelParameters(data, model, estimation, misc);
            incTest=0;
        elseif  user_inputs==12
            %% Modify initial hidden states
            [model, misc]= ...
                piloteModifyInitialStates(data, model, estimation, misc);
            incTest=0;
        elseif  user_inputs==13
            %% Modify training period
            [misc]=piloteModifyTrainingPeriod(data, model, estimation, misc);
            incTest=0;
        elseif  user_inputs==14
            %% Plot tools
            [misc] = pilotePlot(data, model, estimation, misc);
            incTest=0;
        elseif  user_inputs==15
            %% Display model matrices
            piloteDisplayModelMatrices(data, model, estimation, misc)
            incTest=0;
        elseif  user_inputs==16
            %% Create synthetic data
            [data, model, estimation, misc]= ...
                piloteSimulateData(data, model, estimation, misc);
            incTest=0;
        elseif  user_inputs==17
            %% Export 
            [misc] = piloteExport(data, model, estimation, misc);
            incTest=0;
        elseif  user_inputs==18
            %% Export current options in a configuration file format
            [misc] = printOptions(misc);
            incTest=0;
        else
            disp(' ')
            disp('      wrong input')
        end
        
    end
    
end

end