MatRad_Config.m

classdef MatRad_Config < handle
    %MatRad_Config MatRad Configuration class
    % This class is used globally through Matlab to handle default values and 
    % logging and is declared as global matRad_cfg.
    % Usage:
    %    matRad_cfg = MatRad_Config.instance();    
    %
    % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    %
    % Copyright 2019 the matRad development team.
    %
    % This file is part of the matRad project. It is subject to the license
    % terms in the LICENSE file found in the top-level directory of this
    % distribution and at https://github.com/e0404/matRad/LICENSES.txt. No part
    % of the matRad project, including this file, may be copied, modified,
    % propagated, or distributed except according to the terms contained in the
    % LICENSE file.
    %
    % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    
    properties
        logLevel = 3;
        propDoseCalc;        
        propOpt;
        propMC;
        propStf;
        keepLog = false; 
        
        disableGUI = false;
    end
    
    properties (SetAccess = private)
        messageLog = {};
    end
    
    properties (Constant)
        matRadRoot = fileparts(mfilename('fullpath'));
    end
    
    methods (Access = private)
        function obj = MatRad_Config()
            %MatRad_Config Constructs an instance of this class.             
            %  The configuration is implemented as a singleton and used globally
            %  Therefore its constructor is private
            %  For instantiation, use the static MatRad_Config.instance();           
            obj.reset();           
        end
                
    end
    
    methods
        function reset(obj)
            obj.setDefaultProperties();
        end
        
        function setDefaultProperties(obj)
            
            obj.propStf.defaultLongitudinalSpotSpacing = 3;
            obj.propStf.defaultAddMargin = true; %expand target for beamlet finding
            
            obj.propDoseCalc.defaultResolution = struct('x',3,'y',3,'z',3); %[mm]
            obj.propDoseCalc.defaultLateralCutOff = 0.995; %[rel.]
            obj.propDoseCalc.defaultGeometricCutOff = 50; %[mm]
            obj.propDoseCalc.defaultSsdDensityThreshold = 0.05; %[rel.]
            obj.propDoseCalc.defaultUseGivenEqDensityCube = false; %Use the given density cube ct.cube and omit conversion from cubeHU.
            obj.propDoseCalc.defaultIgnoreOutsideDensities = true; %Ignore densities outside of cst contours
            
            obj.propOpt.defaultMaxIter = 500;           
            
            obj.propMC.ompMC_defaultHistories = 1e6;
            obj.propMC.ompMC_defaultOutputVariance = false;
            obj.propMC.particles_defaultHistories = 2e4;
            obj.propMC.direct_defaultHistories = 1e6;

            %obj.propMC.default_photon_engine = 'ompMC';
            obj.propMC.default_proton_engine = 'MCsquare';
            obj.propMC.topas_defaultNumBatches = 5;
            
            obj.disableGUI = false;
            
            
        end
  
        %%For testing
        function setDefaultPropertiesForTesting(obj)
            obj.logLevel   = 1; %Omit output except errors
            
            obj.propStf.defaultLongitudinalSpotSpacing = 20;
            obj.propStf.defaultAddMargin = true; %expand target for beamlet finding
            
            obj.propDoseCalc.defaultResolution = struct('x',5,'y',6,'z',7); %[mm]
            obj.propDoseCalc.defaultGeometricCutOff = 20;
            obj.propDoseCalc.defaultLateralCutOff = 0.8;

            obj.propDoseCalc.defaultSsdDensityThreshold = 0.05;
            obj.propDoseCalc.defaultUseGivenEqDensityCube = false; %Use the given density cube ct.cube and omit conversion from cubeHU.
            obj.propDoseCalc.defaultIgnoreOutsideDensities = true;

            obj.propOpt.defaultMaxIter = 10;
            
            obj.propMC.ompMC_defaultHistories = 100;
            obj.propMC.ompMC_defaultOutputVariance = true;
            obj.propMC.particles_defaultHistories = 100;
            obj.propMC.direct_defaultHistories = 100;

            %obj.propMC.default_photon_engine = 'ompMC';
            obj.propMC.default_proton_engine = 'MCsquare'; 
            obj.propMC.topas_defaultNumBatches = 5;
            
            obj.disableGUI = true;
        end  
      
        function dispDebug(obj,formatSpec,varargin)
			%dispDebug wrapper for debug messages forwarded to displayToConsole 
            obj.displayToConsole('debug',formatSpec,varargin{:});
        end
        
        function dispInfo(obj,formatSpec,varargin)
			%dispInfo wrapper for standard / info output forwarded to displayToConsole 
            obj.displayToConsole('info',formatSpec,varargin{:});
        end
        
        function dispError(obj,formatSpec,varargin)
			%dispError wrapper for error messages forwarded to displayToConsole 
            obj.displayToConsole('error',formatSpec,varargin{:});
        end
        
        function dispWarning(obj,formatSpec,varargin)
			%dispWarning wrapper for warning messages forwarded to displayToConsole 
            obj.displayToConsole('warning',formatSpec,varargin{:});
        end
        
        function displayToConsole(obj,type,formatSpec,varargin)
			%displayToConsole lowest-level logging function for matRad. 
            %  input
			%    type:			type of the log information. Needs to be one of 'error', 'warning', 'info' or 'debug'.
			%    formatSpec: 	string to print using format specifications similar to fprintf
			%    varargin:   	variables according to formatSpec
			
            if nargin < 4
                forwardArgs = {formatSpec};
            else
                forwardArgs = {formatSpec,varargin{:}};
            end
            
            if obj.keepLog
                obj.messageLog{end+1,1} = upper(type);
                obj.messageLog{end,2} = sprintf(forwardArgs{:});
            end
            
            switch type
                case {'error'}
                    if obj.logLevel >= 1                            
                        error(forwardArgs{:});                        
                    end
                case{'warning'}
                    if obj.logLevel >= 2
                        warning(forwardArgs{:});
                    end
                case{'info'}                    
                    if obj.logLevel >= 3
                        fprintf(forwardArgs{:});                    
                    end
                case{'debug'}                    
                    if obj.logLevel >= 4
                        forwardArgs{1} = ['DEBUG: ' forwardArgs{1}];
                        fprintf(forwardArgs{:});
                    end
                otherwise
                    error('Log type %s not defined!',type);
            end
        end
        
        function obj = writeLogToFile(obj,filename)
			%writeLogToFile writes the log kept in MatRad_Config to file.             
            %  Note that the switch keepLog must be enabled for MatRad_Config to store all logging output.
			
            singleString = '%s: %s\n';
            fID = fopen(filename,'w');
            fprintf(fID,repmat(singleString,1,size(obj.messageLog,1)),obj.messageLog{:});
            fclose(fID);
        end
        
        function set.logLevel(obj,newLogLevel)       
			%%Property set methods for logLevel 
            minLevel = 1;
            maxLevel = 4;
            if newLogLevel >= minLevel && newLogLevel <= maxLevel
                obj.logLevel = newLogLevel;
            else
                obj.dispError('Invalid log level. Value must be between %d and %d',minLevel,maxLevel);
            end
        end
    end
    
    methods(Static)
      
        function obj = instance()
			%instance creates a singleton instance of MatRad_Config
            %  In MatRad_Config, the constructor is private to make sure only on global instance exists. 
			%  Call this static functino to get or create an instance of the matRad configuration class
            persistent uniqueInstance;
            
            if isempty(uniqueInstance)
                obj = MatRad_Config();
                uniqueInstance = obj;
            else
                obj = uniqueInstance;
            end
        end
    end
end