Comparative_MEA_dataset/Codes/MATLAB spike detection/FileRunner.m

classdef FileRunner
    %   Summary of this class goes here
    %   Detailed explanation goes here
    
    properties (SetAccess = private)
        files; % listing of the files that are read
        last_file; % the last file starts from 0
        file_read_error; % reading error starts from 1     
        type; % type of file reading now
        spkdetconf; % configuration for detecting spikes
        recordtime; % timestamp for the current recording
     
        duration; % duration of current file      
        samplerate;
        
        file_finished; % finishing indicator starts from 1
        
        first_ch_col; % starts with 1
        final_ch_col; % depends on plate type
        first_ch_row; % starts with 1
        final_ch_row; % depends on plate type
        first_well_col; % starts with 1
        final_well_col; % depends on plate type
        first_well_row; % starts with 1
        final_well_row; % depends on plate type
        last_ch_col; % starts with 0
        last_ch_row; % starts with 0
        last_well_row; % starts with 0
        last_well_col; % starts with 0
        
        Plate_type;
        T; % table for csv
        csv_directory; %where to save the csv files
    end
    
    methods
        function obj = FileRunner(p_SpikeDetConfiguration, p_TargetFiles,csv_directory)
            %constructor method
            obj.files = p_TargetFiles;
            obj.last_file = 0;
            
            obj.spkdetconf = p_SpikeDetConfiguration;
            obj.file_read_error = 0;       
            obj.file_finished = 1;
            obj.T=table;
            obj.csv_directory=csv_directory;
        end
        
        function r_fname = getCurrentFile(obj)    
            r_fname = obj.files{obj.last_file};
        end

        function [r_result, obj] = ReadSpikesFromNextChannel(obj) 
            %proceeds the processing to the next channel/file
            if obj.file_finished &&...
                obj.last_file >= length(obj.files)                      
                Finalcsv=sortrows(obj.T, 2);
                thefilenamefull=strsplit(obj.getCurrentFile(), '.');
                thefilename=strsplit(thefilenamefull{1}, '\');
                thefilename=thefilename{end};
                writetable(Finalcsv, strcat(obj.csv_directory, '\',thefilename,'_', 'spikes.csv'));
                disp('All files have been read from!');
                r_result = [];
            else 
                if obj.file_finished&&...
                    obj.last_file>0
                    Finalcsv=sortrows(obj.T, 2);
                    thefilenamefull=strsplit(obj.getCurrentFile(), '.');
                    thefilename=strsplit(thefilenamefull{1}, '\');
                    thefilename=thefilename{end};
                    writetable(Finalcsv, strcat(obj.csv_directory, '\',thefilename,'_', 'spikes.csv'));
                    obj.T=table; %zeroing the table
                    obj = obj.OpenNewFile();
                end
                
                if obj.file_finished
                    obj = obj.OpenNewFile(); 
                end
                
                [r_result.error,m_data, r_result.chlabel, obj] = obj.ReadAxionChannel();               
                obj = obj.SiirraOsoittimetSeuraavaan();
                if ~r_result.error
                    obj.spkdetconf.sr = obj.samplerate; 
                    [r_result.indexes, r_result.spikes, r_result.threshold, ~, r_result.noise] = DetectSpikes_Amp(m_data, obj.spkdetconf);                                                           
                    %only r_result.indexes are in use currently from all of the
                    %output of DetectSpikes_Amp function
                    Time=r_result.indexes;                  
                    Channel=string(repmat(r_result.chlabel, numel(r_result.indexes),1));
                    %repeating the channel label as many times %as the number
                    %of the detected spikes. (For the table creation)
                    TT=table(Channel, Time);
                    obj.T=[obj.T; TT];
                end                
            end
        end
     
               
                 
        function [errorread,data,chlabel, obj] = ReadAxionChannel(obj)
            %reading the data from the electrode
            disp(obj.getCurrentFile())
            data = [];
            m_well=strcat(char(64+obj.last_well_row+1),num2str(obj.last_well_col+1));            
            splitter=@(x) strsplit(x, '/'); 
            while ~any(strcmp(cellfun(@(z) z{end}, cellfun(splitter,{h5info(obj.getCurrentFile()).Groups(1).Groups.Name}, 'UniformOutput',false), 'UniformOutput',false), m_well)) 
                fprintf([m_well '_' 'seems to be excluded\n']);
                obj = obj.JumpNextWell;
                m_well=strcat(char(64+obj.last_well_row+1),num2str(obj.last_well_col+1));
                if obj.file_finished == 1
                    errorread = 1;%to show that the file finished and nothing to readhere
                    chlabel=[];
                    return
                end
            end
            
            m_ch=strcat(num2str(obj.last_ch_col+1),num2str(obj.last_ch_row+1));
            chlabel = strcat(m_well,'_',m_ch); % form the label (well and electrode)
            disp(['now reading: ' chlabel]);
            try                 
                data = h5read(obj.getCurrentFile(),['/Data/' m_well '/' m_ch]);
                errorread = 0;
            catch 
                errorread = 1;
                InactiveChannels=h5read(obj.getCurrentFile(), '/DataInfo/InactiveChannels');
                if any(contains(InactiveChannels, chlabel)) 
                    disp(['Channel' ' ' chlabel ' ' 'is inactive, it is not recorded in the initial analysed file.'])
                else
                    error(['Smth wrong with' ' ' chlabel ' ' 'channel reading!']); 
                end
          
            end 
        end
        
        function obj = SiirraOsoittimetSeuraavaan(obj)
            %shifts the well/electrode addresses (row/col) to the next after processing 
            if obj.final_ch_row-1 <= obj.last_ch_row 
                obj.last_ch_row = obj.first_ch_row-1;
                if obj.final_ch_col-1 <= obj.last_ch_col 
                    obj.last_ch_col = obj.first_ch_col-1;
                    if obj.final_well_col-1 <= obj.last_well_col 
                        obj.last_well_col = obj.first_well_col-1;
                        if obj.final_well_row-1 <= obj.last_well_row
                            disp('All channels have been read from!');
                            obj.file_finished = 1;
                        else
                            obj.last_well_row = obj.last_well_row+1;
                        end
                    else
                        obj.last_well_col = obj.last_well_col+1;
                    end
                else
                    obj.last_ch_col = obj.last_ch_col+1;
                end                    
            else
                obj.last_ch_row = obj.last_ch_row+1; 
            end            
        end
        
        
        function obj = OpenNewFile(obj)
            %launches new file opening
            obj.file_finished = 0;
            obj.file_read_error = 1; %setting it to 1, if everything successful it will be switched to 0 during OpenAxionFile
            while obj.file_read_error && obj.last_file < length(obj.files) 
                disp(['Opening new file: ' obj.files{obj.last_file+1}]);
                obj.type = strsplit(obj.files{obj.last_file+1},'.');
                obj.type = cell2mat(obj.type(end));
                obj = obj.OpenAxionFile(obj.files{obj.last_file+1});            
                obj.last_file = obj.last_file+1;                
            end
            if obj.file_read_error && obj.last_file == length(obj.files)
                error('NOT A SINGLE FILE WAS OPENED SUCCESSFULLY!')
            end
        end
                 
        function obj = OpenAxionFile(obj, p_TargetFile) 
            % sets the sample rate, voltageScale, recordtime from the file
            try
                obj.Plate_type=h5readatt(p_TargetFile, '/DataInfo/', 'Plate type');                
                obj.first_ch_col = 1;
                obj.first_ch_row = 1;
                obj.first_well_col = 1;
                obj.first_well_row = 1;
                
                obj.last_ch_col = 0;
                obj.last_ch_row = 0;
                obj.last_well_row = 0;
                obj.last_well_col = 0;
                
                if strcmp(obj.Plate_type, '12-well plate')
                    obj.final_ch_col = 8;
                    obj.final_ch_row = 8;
                    obj.final_well_col = 4;
                    obj.final_well_row = 3;
                elseif strcmp(obj.Plate_type, '48-well plate')
                    obj.final_ch_col = 4;
                    obj.final_ch_row = 4;
                    obj.final_well_col = 8;
                    obj.final_well_row = 6;
                else
                    disp('Unknown MEA layout!')
                end
                 
                obj.duration = h5readatt(p_TargetFile, '/DataInfo/','DurationInSec');
                obj.samplerate = h5readatt(p_TargetFile, '/DataInfo/','SamplingFrequencyInHz');               
                obj.file_read_error = 0;
            catch 
                disp (['File ' p_TargetFile ' could not be opened successfully!']);
                obj.file_read_error = 1;
            end
        end
        
        
        function obj = JumpNextWell(obj)  
            %proceeds to the next well 
            if obj.final_well_col-1 <= obj.last_well_col 
                obj.last_well_col = obj.first_well_col-1;
                if obj.final_well_row-1 <= obj.last_well_row
                    disp('All channels have been read from!');
                    obj.file_finished = 1;
                else
                    obj.last_well_row = obj.last_well_row+1;
                end
            else
                obj.last_well_col = obj.last_well_col+1;
            end
        end
        
    end
end