forked from cortex-lab/KiloSort
-
Notifications
You must be signed in to change notification settings - Fork 0
/
batch_run_ks.m
203 lines (178 loc) · 7.6 KB
/
batch_run_ks.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
function batch_run_ks(varargin)
%==========================================================================
p = inputParser();
p.addParameter('mcdatapath', [], @(x) ischar(x));
p.addParameter('MEAtype', [], @(x) ischar(x));
p.addParameter('Experimenttype', [], @(x) ischar(x));
p.addParameter('AnalyzeMultipleExp', true, @(x) islogical(x));
p.addParameter('verbose', true, @(x) islogical(x));
p.parse(varargin{:});
verbose = p.Results.verbose;
multiexpflag = p.Results.AnalyzeMultipleExp;
rootpaths = p.Results.mcdatapath;
meatypes = p.Results.MEAtype;
exptypes = p.Results.Experimenttype; % option to change initial ops for cell culture, MHK Nov 2019
if isempty(rootpaths) || ~exist(rootpaths,'dir')
if multiexpflag
[rootpaths, meatypes, exptypes] = getmultiplepaths(rootpaths);
else
rootpaths = uigetdir([],'Select mcd data folder');
rootpaths = {rootpaths}; % convert to cell to run it seemlessly with batch files
end
end
%==========================================================================
up = userpath; [pp, ~] = fileparts(up);
KilosortPath = fullfile(pp, 'GitHub', 'KiloSortMEA');
NpyMatlabPath = fullfile(pp, 'GitHub', 'npy-matlab');
addpath(genpath(KilosortPath)); addpath(genpath(NpyMatlabPath));
%================================================================
for iexp = 1:numel(rootpaths)
%----------------------------------------------------------------------
kssortedpath = fullfile(rootpaths{iexp},'ks_sorted');
%----------------------------------------------------------------------
% make diary
diarypath = fullfile(rootpaths{iexp}, 'ks_output_logger.txt');
if exist(diarypath, 'file'); delete(diarypath); end
diary(diarypath); diary on;
%----------------------------------------------------------------------
binname = 'alldata.dat';
binpath = fullfile(kssortedpath, binname);
%----------------------------------------------------------------------
metadata = [];
metadata.root = rootpaths{iexp};
metadata.meatype = meatypes{iexp};
metadata.exptypes = exptypes{iexp};
%----------------------------------------------------------------------
% search for ks binary in the root folder or do conversion
if exist(binpath,'file')
disp('Kilosort binary found!')
% load bininfo
bininfopath = fullfile(metadata.root,'ks_sorted','bininfo.mat');
if ~exist(bininfopath,'file')
error("Can't find bininfo.mat, exiting");
end
ifile = load(bininfopath); bininfo = ifile.bininfo;
else
%----------------------------------------------------------------------
disp('Kilosort binary missing, starting conversion...')
metadata = getmcdmetadata(metadata,verbose);
% do conversion
bininfo = convertToRawBinary(metadata);
save(fullfile(kssortedpath, 'bininfo.mat'),'bininfo', '-v7.3');
disp('Conversion completed!');
% write text file for eventmarkers used in Phy amplitude view
ksEventMarkers(kssortedpath, metadata.root);
fprintf('Done! Took %.2f min\n', toc/60);
end
%----------------------------------------------------------------------
%read frametimes
if ~exist(fullfile(rootpaths{iexp}, 'frametimes'),'dir')
fprintf('Extracting frametimings...\n');
readFrametimesNew('mcdatapath', rootpaths{iexp}, 'Nchan', bininfo.NchanTOT, ...
'fs', bininfo.fs, 'convfac', bininfo.convfac);
end
%----------------------------------------------------------------------
if ispc
% Windows
temppath = 'G:';
elseif isunix
% Linux
temppath = '/mnt/nvme';
else
error('OS not supported');
end
%----------------------------------------------------------------------
metadata.bininfo = bininfo;
metadata.binpath = binpath;
metadata.whpath = fullfile(temppath, 'DATA_sorted', 'temp_wh.dat');
%----------------------------------------------------------------------
% get options and make channel map
ops = getKsOptionsMEA(metadata);
%----------------------------------------------------------------------
% sort data
gpuDevice(1); %initialize GPU (erases any existing GPU arrays)
rez = preprocessData(ops); % preprocess data and extract spikes for initialization
rez = fitTemplates(rez); % fit templates iteratively
gpuDevice(1); %initialize GPU (erases any existing GPU arrays)
rez = fullMPMUNew2(rez);% extract final spike times (overlapping extraction)
delete(ops.fproc); % remove temporary file
%----------------------------------------------------------------------
% save sorted data to the original folder
fprintf('Saving results to Phy \n')
rezToPhy(rez, kssortedpath); %rezToPhy
rez.cProj = []; rez.cProjPC = [];
% save matlab results file
fprintf('Saving final results in rez \n')
save(fullfile(ops.root, 'ks_sorted','rez.mat'),'rez', '-v7.3');
clear ops metadata;
%----------------------------------------------------------------------
diary off;
%----------------------------------------------------------------------
end
%==========================================================================
end
function mtdat = getmcdmetadata(mtdat, verbose)
stimfiles = dir([mtdat.root,filesep,'*.mcd']);
mtdat.recording_type = 'mcd';
if numel(stimfiles) == 0
stimfiles = dir([mtdat.root,filesep,'*.msrd']);
mtdat.recording_type = 'msrd';
end
if numel(stimfiles) == 0
stimfiles = dir([mtdat.root,filesep,'*.h5']);
mtdat.recording_type = 'h5';
end
[~, expname]= fileparts(mtdat.root);
if isempty(stimfiles)
error('Hey yo!, there aint no recoreded MCD/H5 data in this folder! good luck with analysis');
end
if verbose
disp([repmat('-',1,20),' Experiment : ',expname,' ', repmat('-',1,20)]);
end
%sort filenames
namelist = {stimfiles.name}';
filenum = cellfun(@(x)sscanf(x,'%d_yy.txt'),namelist);
[~,Sidx] = sort(filenum);
stimfiles = stimfiles(Sidx);
mtdat.mcdfilenames = {stimfiles.name}';
mtdat.mcdfilesize = [stimfiles.bytes]'/(2^10^3);
mtdat.totalexpsize = sum(mtdat.mcdfilesize);
mtdat.exptime = {stimfiles.date}';
[str,dt] = deal(cell(size(stimfiles,1),1));
for jj = 1:size(stimfiles,1)
str{jj} = [num2str(jj,'%02d'),':',repmat(' ',1,5),mtdat.mcdfilenames{jj}(1:15),' ... ',...
mtdat.mcdfilenames{jj}(end-3:end), repmat(' ',1,5),'size: ',num2str(mtdat.mcdfilesize(jj),'%.3g'),...
' GB', repmat(' ',1,5),'recorded at: ', mtdat.exptime{jj}];
gp = strfind(mtdat.exptime{jj},':');
dt{jj} = mtdat.exptime{jj}(1:gp(1)-4);
end
mtdat.expdate = cell2mat(unique(dt));
mtdat.label = str;
if verbose
disp(str);
disp([repmat('-',1,40),'> Total size: ', num2str(mtdat.totalexpsize,'%.3g')]);
disp([repmat('-',1,40),'> Experiment date: ', mtdat.expdate(1,:)]);
disp(repmat(' ',2,1))
end
end
function [pathlist, meatypelist, exptypelist] = getmultiplepaths(batchtxtpath)
if isempty(batchtxtpath) || ~exist(batchtxtpath,'file')
[batchpathfile,batchfilepath] = uigetfile('*.txt','Select the text file for all the data folders');
else
[batchfilepath,batchpathfile,batchfileformat] = fileparts(batchtxtpath);
batchpathfile = [batchpathfile,batchfileformat];
end
fid = fopen(fullfile(batchfilepath,batchpathfile),'r');
C = textscan(fid,'%s %s %s','whitespace','','Delimiter',',');
fclose(fid);
pathlist = C{1};
meatypelist = strrep(C{2},' ','');
if size(C{1},1) > 1 && size(C{1},1) > size(C{3},1) % this to fill up last empty text
C{3}{size(C{1},1)} = '';
end
if isempty(C{3})
exptypelist = {''};
else
exptypelist = C{3};
end
end