log_cube.m

Go to the documentation of this file.

%> @brief Log generated by a @ref reptt_blockcube
%>
%> This has a 4-D cell of @ref irlog
%>
%> Each slice logs(:, :, :, i) accounts for a different log class
%>
%> @sa reptt_blockcube
%>
classdef log_cube < irlog
    properties
        logs;
        blocks;
    end;
    
    properties(SetAccess=protected)
        no_datasets;
    end;
    
    methods
        function o = log_cube()
            o.classtitle = 'Cube log';
            o.flag_ui = 0;
            o.moreactions{end+1} = 'extract_sovalues';
        end;
        
        %> Creates a sovalues object
        %>
        %> Only works if the @ref log_cube::logs property has dimension [n, 1, 1, *]
        %>
        %> @return a @ref sovalues object
        function sov = extract_sovalues(o)
            [a, b, c, d] = size(o.logs); %#ok<*NASGU>
            if b > 1 || c > 1
                irerror('Extraction of sovalues only works if the cube was a single column!');
            end;
            
            sov = sovalues();
            sov.ax(2) = raxisdata_singleton('Singleton');
            sov.ax(1) = raxisdata();
            sov.ax(1).label = 'Case';
            sov.ax(1).values = 1:size(o.logs, 1);
            sov.values = sovalues.read_logss(o.logs);
            specs = cellfun(@(x) x.get_description(), o.blocks(:, :, :, 1), 'UniformOutput', 0);
            sov = sov.set_field('spec', specs);
            
        end;
        
        %> Pre-allocates the @ref log property; prepares to record.
        %>
        %> @param log_mold a cell of @ref irlog objects
        %> @param block_mold a cell of @ref block objects. Only used to get allocation dimensions
        %> @param no_reps Number of repetitions, such as "k" from a k-fold cross-validation
        function o = allocate_logs(o, log_mold, block_mold, no_reps)
            
            % Makes sure that all log_mold elements have a title that can be used as a field name
            for i = 1:numel(log_mold)
                log = log_mold{i};
                try
                    a.(log.title) = 10; % Checks validity of log title as field name
                catch ME
                    if isempty(log.title)
                        irerror('Log title is empty!');
                    end;
                    irerror(sprintf('log title "%s" cannot be used as a field name!', log.title));
                end;
            end;
            
            [ni, nj, nk] = size(block_mold);
            nl = numel(log_mold);
            
            for il = 1:nl
                for ii = 1:ni
                    for ij = 1:nj
                        for ik = 1:nk
                            if ~isempty(block_mold{ii, ij, ik})
                                o.logs{ii, ij, ik, il} = log_mold{il}.allocate(no_reps);
                            else
                                o.logs{ii, ij, ik, il} = [];
                            end;
                        end;
                    end;
                end;
            end;
        end;
    end;
end