forked from tszalay/PoreView
-
Notifications
You must be signed in to change notification settings - Fork 0
/
abfload.m
1390 lines (1354 loc) · 47.4 KB
/
abfload.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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
function [d,si,h]=abfload(fn,varargin)
% ** function [d,si,h]=abfload(fn,varargin)
% loads and returns data in ABF (Axon Binary File) format.
% Data may have been acquired in the following modes:
% (1) event-driven variable-length (currently only abf versions < 2.0)
% (2) event-driven fixed-length or waveform-fixed length
% (3) gap-free
% Information about scaling, the time base and the number of channels and
% episodes is extracted from the header of the abf file.
%
% OPERATION
% If the second input variable is the char array 'info' as in
% [d,si,h]=abfload('d:\data01.abf','info')
% abfload will not load any data but return detailed information (header
% parameters) on the file in output variable h. d and si will be empty.
% In all other cases abfload will load data. Optional input parameters
% listed below (= all except the file name) must be specified as
% parameter/value pairs, e.g. as in
% d=abfload('d:\data01.abf','start',100,'stop','e');
%
% >>> INPUT VARIABLES >>>
% NAME TYPE, DEFAULT DESCRIPTION
% fn char array abf data file name
% start scalar, 0 only gap-free-data: start of cutout to be
% read (unit: s)
% stop scalar or char, only gap-free-data: end of cutout to be
% 'e' read (unit: sec). May be set to 'e' (end
% of file).
% sweeps 1d-array or char, only episodic data: sweep numbers to be
% 'a' read. By default, all sweeps will be read
% ('a').
% channels cell array names of channels to be read, like
% or char, 'a' {'IN 0','IN 8'} (make sure spelling is
% 100% correct, including blanks). If set
% to 'a', all channels will be read.
% chunk scalar, 0.05 only gap-free-data: the elementary chunk
% size (megabytes) to be used for the
% 'discontinuous' mode of reading data
% (fewer channels to be read than exist)
% machineF char array, the 'machineformat' input parameter of the
% 'ieee-le' matlab fopen function. 'ieee-le' is the
% correct option for windows; depending on
% the platform the data were recorded/shall
% be read by abfload 'ieee-be' is the
% alternative.
% << OUTPUT VARIABLES <<<
% NAME TYPE DESCRIPTION
% d the data read, the format depending on the record-
% ing mode
% 1. GAP-FREE:
% 2d array 2d array of size
% <data pts> by <number of chans>
% Examples of access:
% d(:,2) data from channel 2 at full length
% d(1:100,:) first 100 data points from all channels
% 2. EPISODIC FIXED-LENGTH/WAVEFORM FIXED-LENGTH:
% 3d array 3d array of size
% <data pts per sweep> by <number of chans> by <number
% of sweeps>.
% Examples of access:
% d(:,2,:) a matrix containing all episodes
% (at full length) of the second
% channel in its columns
% d(1:200,:,[1 11]) contains first 200 data points of
% episodes 1 and 11 of all channels
% 3. EPISODIC VARIABLE-LENGTH:
% cell array cell array whose elements correspond to single sweeps.
% Each element is a (regular) array of size
% <data pts per sweep> by <number of chans>
% Examples of access:
% d{1} a 2d-array which contains episode 1
% (all of it, all channels)
% d{2}(1:100,2) a 1d-array containing the first 100
% data points of channel 2 in episode 1
% si scalar the sampling interval in us
% h struct information on file (selected header parameters)
%
%
% CONTRIBUTORS
% Original version by Harald Hentschke ([email protected])
% Extended to abf version 2.0 by Forrest Collman ([email protected])
% pvpmod.m by Ulrich Egert ([email protected])
% Date of this version: May 20, 2009
% -------------------------------------------------------------------------
% PART 1: check of input vars
% -------------------------------------------------------------------------
% --- defaults
% gap-free
start=0.0;
stop='e';
% episodic
sweeps='a';
% general
channels='a';
% the size of data chunks (see above) in Mb. 0.05 Mb is an empirical value
% which works well for abf with 6-16 channels and recording durations of
% 5-30 min
chunk=0.05;
machineF='ieee-le';
verbose=1;
% if first and only optional input argument is string 'info' the user's
% request is to obtain information on the file (header parameters), so set
% flag accordingly
if nargin==2 && ischar(varargin{1}) && strcmp('info',varargin{1})
doLoadData=false;
else
doLoadData=true;
% assign values of optional input parameters if any were given
pvpmod(varargin);
end
if verbose
disp(['** ' mfilename])
end
% some constants
BLOCKSIZE=512;
% output variables
d=[];
si=[];
h=[];
if ischar(stop)
if ~strcmpi(stop,'e')
error('input parameter ''stop'' must be specified as ''e'' (=end of recording) or as a scalar');
end
end
% check existence of file
if ~exist(fn,'file'),
error(['could not find file ' fn]);
end
% -------------------------------------------------------------------------
% PART 2a: determine abf version
% -------------------------------------------------------------------------
if verbose
disp(['opening ' fn '..']);
end
[fid,messg]=fopen(fn,'r',machineF);
if fid == -1,
error(messg);
end
% on the occasion, determine absolute file size
fseek(fid,0,'eof');
fileSz=ftell(fid);
fseek(fid,0,'bof');
% *** read value of parameter 'fFileSignature' (i.e. abf version) from header ***
sz=4;
[fFileSignature,n]=fread(fid,sz,'uchar=>char');
if n~=sz,
fclose(fid);
error('something went wrong reading value(s) for fFileSignature');
end
% rewind
fseek(fid,0,'bof');
% transpose
fFileSignature=fFileSignature';
% -------------------------------------------------------------------------
% PART 2b: define file information ('header') parameters of interest
% -------------------------------------------------------------------------
% The list of header parameters created below (variable 'headPar') is
% derived from the abf version 1.8 header section. It is by no means
% exhaustive (i.e. there are many more parameters in abf files) but
% sufficient for proper upload, scaling and arrangement of data acquired
% under many conditons. Further below, these parameters will be made fields
% of struct h. h, which is also an output variable, is then used in PART 3,
% which does the actual job of uploading, scaling and rearranging the data.
% That part of the code relies on h having a certain set of fields
% irrespective of ABF version.
% Unfortunately, in the transition to ABF version 2.0 many of the header
% parameters were moved to different places within the abf file and/or
% given other names or completely restructured. In order for the code to
% work with pre- and post-2.0 data files, all parameters missing in the
% header must be gotten into h. This is accomplished in lines ~262 and
% following:
% if h.fFileVersionNumber>=2
% ...
% Furthermore,
% - h as an output from an ABF version < 2.0 file will not contain new
% parameters introduced into the header like 'nCRCEnable'
% - h will in any case contain a few 'home-made' fields that have
% proven to be useful. Some of them depend on the recording mode. Among
% the more or less self-explanatory ones are
% -- si sampling interval
% -- recChNames the names of all channels, e.g. 'IN 8',...
% -- dataPtsPerChan sample points per channel
% -- dataPts sample points in file
% -- recTime recording start and stop time in seconds from
% midnight (millisecond resolution)
% -- sweepLengthInPts sample points per sweep (one channel)
% -- sweepStartInPts the start times of sweeps in sample points
% (from beginning of recording)
% call local function for header proper
headPar=define_header(fFileSignature);
TagInfo=define_TagInfo;
switch fFileSignature
case 'ABF ' % ** note the blank
% ************************
% abf version < 2.0
% ************************
% do nothing, header already defined above
case 'ABF2'
% ************************
% abf version >= 2.0
% ************************
Sections=define_Sections;
ProtocolInfo=define_ProtocolInfo;
ADCInfo=define_ADCInfo;
otherwise
error('unknown or incompatible file signature');
end
% convert headPar to struct
s=cell2struct(headPar,{'name','offs','numType','value'},2);
numOfParams=size(s,1);
clear tmp headPar;
% -------------------------------------------------------------------------
% PART 2c: read parameters of interest
% -------------------------------------------------------------------------
% convert names in structure to variables and read value from header
for g=1:numOfParams
if fseek(fid, s(g).offs,'bof')~=0,
fclose(fid);
error(['something went wrong locating ' s(g).name]);
end
sz=length(s(g).value);
% use dynamic field names
[h.(s(g).name),n]=fread(fid,sz,s(g).numType);
if n~=sz,
fclose(fid);
error(['something went wrong reading value(s) for ' s(g).name]);
end
end
% transpose
h.fFileSignature=h.fFileSignature';
% several header parameters need a fix or version-specific refinement:
if strcmp(h.fFileSignature,'ABF2')
% h.fFileVersionNumber needs to be converted from an array of integers to
% a float
h.fFileVersionNumber=h.fFileVersionNumber(4)+h.fFileVersionNumber(3)*.1...
+h.fFileVersionNumber(2)*.001+h.fFileVersionNumber(1)*.0001;
% convert ms to s
h.lFileStartTime=h.uFileStartTimeMS*.001;
else
% h.fFileVersionNumber is a float32 the value of which is sometimes a
% little less than what it should be (e.g. 1.6499999 instead of 1.65)
h.fFileVersionNumber=.001*round(h.fFileVersionNumber*1000);
% in abf < 2.0 two parameters are needed to obtain the file start time
% with millisecond precision - let's integrate both into parameter
% lFileStartTime (unit: s) so that nFileStartMillisecs will not be needed
h.lFileStartTime=h.lFileStartTime+h.nFileStartMillisecs*.001;
end
% *** read file information that has gone elsewhere in ABF version >= 2.0
% and assign values ***
if h.fFileVersionNumber>=2
% --- read in the Sections
Sects=cell2struct(Sections,{'name'},2);
numOfSections=length(Sections);
offset=76;
for i=1:numOfSections
eval([Sects(i).name '=ReadSectionInfo(fid,offset);']);
offset=offset+4+4+8;
end
% --- read in the Strings
fseek(fid,StringsSection.uBlockIndex*BLOCKSIZE,'bof');
BigString=fread(fid,StringsSection.uBytes,'char');
% this is a hack
goodstart=strfind(lower(char(BigString)'),'clampex');
%this extends the hack to deal with axoscope files
if isempty(goodstart)
goodstart=strfind(lower(char(BigString)'),'axoscope');
end
BigString=BigString(goodstart(1):end)';
stringends=find(BigString==0);
stringends=[0 stringends];
for i=1:length(stringends)-1
Strings{i}=char(BigString(stringends(i)+1:stringends(i+1)-1));
end
h.recChNames=[];
h.recChUnits=[];
% --- read in the ADCSection
for i=1:ADCSection.llNumEntries
ADCsec(i)=ReadSection(fid,ADCSection.uBlockIndex*BLOCKSIZE+ADCSection.uBytes*(i-1),ADCInfo);
ii=ADCsec(i).nADCNum+1;
h.nADCSamplingSeq(i)=ADCsec(i).nADCNum;
h.recChNames=strvcat(h.recChNames, Strings{ADCsec(i).lADCChannelNameIndex});
h.recChUnits=strvcat(h.recChUnits, Strings{ADCsec(i).lADCUnitsIndex});
h.nTelegraphEnable(ii)=ADCsec(i).nTelegraphEnable;
h.fTelegraphAdditGain(ii)=ADCsec(i).fTelegraphAdditGain;
h.fInstrumentScaleFactor(ii)=ADCsec(i).fInstrumentScaleFactor;
h.fSignalGain(ii)=ADCsec(i).fSignalGain;
h.fADCProgrammableGain(ii)=ADCsec(i).fADCProgrammableGain;
h.fInstrumentOffset(ii)=ADCsec(i).fInstrumentOffset;
h.fSignalOffset(ii)=ADCsec(i).fSignalOffset;
end
% --- read in the protocol section
ProtocolSec=ReadSection(fid,ProtocolSection.uBlockIndex*BLOCKSIZE,ProtocolInfo);
% ---
h.nOperationMode=ProtocolSec.nOperationMode;
h.fSynchTimeUnit=ProtocolSec.fSynchTimeUnit;
h.nADCNumChannels=ADCSection.llNumEntries;
h.lActualAcqLength=DataSection.llNumEntries;
h.lDataSectionPtr=DataSection.uBlockIndex;
h.nNumPointsIgnored=0;
% in ABF version < 2.0 h.fADCSampleInterval is the sampling interval
% defined as
% 1/(sampling freq*number_of_channels)
% so divide ProtocolSec.fADCSequenceInterval by the number of
% channels
h.fADCSampleInterval=ProtocolSec.fADCSequenceInterval/h.nADCNumChannels;
h.fADCRange=ProtocolSec.fADCRange;
h.lADCResolution=ProtocolSec.lADCResolution;
h.lSynchArrayPtr=SynchArraySection.uBlockIndex;
h.lSynchArraySize=SynchArraySection.llNumEntries;
else
TagSection.llNumEntries=h.lNumTagEntries;
TagSection.uBlockIndex=h.lTagSectionPtr;
TagSection.uBytes=64;
end
Tagsec=[];
for i=1:TagSection.llNumEntries
if (i==1)
Tagsec=ReadSection(fid,TagSection.uBlockIndex*BLOCKSIZE+TagSection.uBytes*(i-1),TagInfo);
else
Tagsec(i)=ReadSection(fid,TagSection.uBlockIndex*BLOCKSIZE+TagSection.uBytes*(i-1),TagInfo);
end
Tagsec(i).sComment=char(Tagsec(i).sComment)';
end
h.Tags=Tagsec;
% -------------------------------------------------------------------------
% PART 2d: groom parameters & perform some plausibility checks
% -------------------------------------------------------------------------
if h.lActualAcqLength<h.nADCNumChannels,
fclose(fid);
error('less data points than sampled channels in file');
end
% the numerical value of all recorded channels (numbers 0..15)
recChIdx=h.nADCSamplingSeq(1:h.nADCNumChannels);
% the corresponding indices into loaded data d
recChInd=1:length(recChIdx);
if h.fFileVersionNumber<2
% the channel names, e.g. 'IN 8' (for ABF version 2.0 these have been
% extracted above at this point)
h.recChNames=(reshape(char(h.sADCChannelName),10,16))';
h.recChNames=h.recChNames(recChIdx+1,:);
% same with signal units
h.recChUnits=(reshape(char(h.sADCUnits),8,16))';
h.recChUnits=h.recChUnits(recChIdx+1,:);
end
% convert to cell arrays
h.recChNames=deblank(cellstr(h.recChNames));
h.recChUnits=deblank(cellstr(h.recChUnits));
% check whether requested channels exist
chInd=[];
eflag=0;
if ischar(channels)
if strcmp(channels,'a')
chInd=recChInd;
else
fclose(fid);
error('input parameter ''channels'' must either be a cell array holding channel names or the single character ''a'' (=all channels)');
end
else
for i=1:length(channels)
tmpChInd=strmatch(channels{i},h.recChNames,'exact');
if ~isempty(tmpChInd)
chInd=[chInd tmpChInd];
else
% set error flag to 1
eflag=1;
end
end
end
if eflag
fclose(fid);
disp('**** available channels:');
disp(h.recChNames);
disp(' ');
disp('**** requested channels:');
disp(channels);
error('at least one of the requested channels does not exist in data file (see above)');
end
% display available channels if in info mode
if ~doLoadData
disp('**** available channels:');
disp(h.recChNames);
end
% gain of telegraphed instruments, if any
if h.fFileVersionNumber>=1.65
addGain=h.nTelegraphEnable.*h.fTelegraphAdditGain;
addGain(addGain==0)=1;
else
addGain=ones(size(h.fTelegraphAdditGain));
end
% determine offset at which data start
switch h.nDataFormat
case 0
dataSz=2; % bytes/point
precision='int16';
case 1
dataSz=4; % bytes/point
precision='float32';
otherwise
fclose(fid);
error('invalid number format');
end
headOffset=h.lDataSectionPtr*BLOCKSIZE+h.nNumPointsIgnored*dataSz;
% h.fADCSampleInterval is the TOTAL sampling interval
h.si=h.fADCSampleInterval*h.nADCNumChannels;
% assign same value to si, which is an output variable
si=h.si;
if ischar(sweeps) && sweeps=='a'
nSweeps=h.lActualEpisodes;
sweeps=1:h.lActualEpisodes;
else
nSweeps=length(sweeps);
end
% -------------------------------------------------------------------------
% PART 3: read data (note: from here on code is generic and abf version
% should not matter)
% -------------------------------------------------------------------------
switch h.nOperationMode
case 1
if verbose
disp('data were acquired in event-driven variable-length mode');
end
if h.fFileVersionNumber>=2.0
errordlg('abfload currently does not work with data acquired in event-driven variable-length mode and ABF version 2.0','ABF version issue');
else
if (h.lSynchArrayPtr<=0 || h.lSynchArraySize<=0),
fclose(fid);
error('internal variables ''lSynchArraynnn'' are zero or negative');
end
switch h.fSynchTimeUnit
case 0 % time information in synch array section is in terms of ticks
h.synchArrTimeBase=1;
otherwise % time information in synch array section is in terms of usec
h.synchArrTimeBase=h.fSynchTimeUnit;
end
% the byte offset at which the SynchArraySection starts
h.lSynchArrayPtrByte=BLOCKSIZE*h.lSynchArrayPtr;
% before reading Synch Arr parameters check if file is big enough to hold them
% 4 bytes/long, 2 values per episode (start and length)
if h.lSynchArrayPtrByte+2*4*h.lSynchArraySize<fileSz,
fclose(fid);
error('file seems not to contain complete Synch Array Section');
end
if fseek(fid,h.lSynchArrayPtrByte,'bof')~=0,
fclose(fid);
error('something went wrong positioning file pointer to Synch Array Section');
end
[synchArr,n]=fread(fid,h.lSynchArraySize*2,'int32');
if n~=h.lSynchArraySize*2,
fclose(fid);
error('something went wrong reading synch array section');
end
% make synchArr a h.lSynchArraySize x 2 matrix
synchArr=permute(reshape(synchArr',2,h.lSynchArraySize),[2 1]);
% the length of episodes in sample points
segLengthInPts=synchArr(:,2)/h.synchArrTimeBase;
% the starting ticks of episodes in sample points WITHIN THE DATA FILE
segStartInPts=cumsum([0 (segLengthInPts(1:end-1))']*dataSz)+headOffset;
% start time (synchArr(:,1)) has to be divided by h.nADCNumChannels to get true value
% go to data portion
if fseek(fid,headOffset,'bof')~=0,
fclose(fid);
error('something went wrong positioning file pointer (too few data points ?)');
end
% ** load data if requested
if doLoadData
for i=1:nSweeps,
% if selected sweeps are to be read, seek correct position
if ~isequal(nSweeps,h.lActualEpisodes),
fseek(fid,segStartInPts(sweeps(i)),'bof');
end
[tmpd,n]=fread(fid,segLengthInPts(sweeps(i)),precision);
if n~=segLengthInPts(sweeps(i)),
warning(['something went wrong reading episode ' int2str(sweeps(i)) ': ' segLengthInPts(sweeps(i)) ' points should have been read, ' int2str(n) ' points actually read']);
end
h.dataPtsPerChan=n/h.nADCNumChannels;
if rem(n,h.nADCNumChannels)>0,
fclose(fid);
error('number of data points in episode not OK');
end
% separate channels..
tmpd=reshape(tmpd,h.nADCNumChannels,h.dataPtsPerChan);
% retain only requested channels
tmpd=tmpd(chInd,:);
tmpd=tmpd';
% if data format is integer, scale appropriately; if it's float, tmpd is fine
if ~h.nDataFormat
for j=1:length(chInd),
ch=recChIdx(chInd(j))+1;
tmpd(:,j)=tmpd(:,j)/(h.fInstrumentScaleFactor(ch)*h.fSignalGain(ch)*h.fADCProgrammableGain(ch)*addGain(ch))...
*h.fADCRange/h.lADCResolution+h.fInstrumentOffset(ch)-h.fSignalOffset(ch);
end
end
% now place in cell array, an element consisting of one sweep with channels in columns
d{i}=tmpd;
end
end
end
case {2,5}
if h.nOperationMode==2
disp('data were acquired in event-driven fixed-length mode');
else
disp('data were acquired in waveform fixed-length mode (clampex only)');
end
% extract timing information on sweeps
if (h.lSynchArrayPtr<=0 || h.lSynchArraySize<=0),
fclose(fid);
error('internal variables ''lSynchArraynnn'' are zero or negative');
end
switch h.fSynchTimeUnit
case 0 % time information in synch array section is in terms of ticks
h.synchArrTimeBase=1;
otherwise % time information in synch array section is in terms of usec
h.synchArrTimeBase=h.fSynchTimeUnit;
end
% the byte offset at which the SynchArraySection starts
h.lSynchArrayPtrByte=BLOCKSIZE*h.lSynchArrayPtr;
% before reading Synch Arr parameters check if file is big enough to hold them
% 4 bytes/long, 2 values per episode (start and length)
if h.lSynchArrayPtrByte+2*4*h.lSynchArraySize>fileSz,
fclose(fid);
error('file seems not to contain complete Synch Array Section');
end
if fseek(fid,h.lSynchArrayPtrByte,'bof')~=0,
fclose(fid);
error('something went wrong positioning file pointer to Synch Array Section');
end
[synchArr,n]=fread(fid,h.lSynchArraySize*2,'int32');
if n~=h.lSynchArraySize*2,
fclose(fid);
error('something went wrong reading synch array section');
end
% make synchArr a h.lSynchArraySize x 2 matrix
synchArr=permute(reshape(synchArr',2,h.lSynchArraySize),[2 1]);
if numel(unique(synchArr(:,2)))>1
fclose(fid);
error('sweeps of unequal length in file recorded in fixed-length mode');
end
% the length of sweeps in sample points (**note: parameter lLength of
% the ABF synch section is expressed in samples (ticks) whereas
% parameter lStart is given in synchArrTimeBase units)
h.sweepLengthInPts=synchArr(1,2)/h.nADCNumChannels;
% the starting ticks of episodes in sample points (t0=1=beginning of
% recording)
h.sweepStartInPts=synchArr(:,1)*(h.synchArrTimeBase/h.fADCSampleInterval/h.nADCNumChannels);
% recording start and stop times in seconds from midnight
h.recTime=h.lFileStartTime;
h.recTime=h.recTime+[0 (1e-6*(h.sweepStartInPts(end)+h.sweepLengthInPts))*h.fADCSampleInterval*h.nADCNumChannels];
% determine first point and number of points to be read
startPt=0;
h.dataPts=h.lActualAcqLength;
h.dataPtsPerChan=h.dataPts/h.nADCNumChannels;
if rem(h.dataPts,h.nADCNumChannels)>0 || rem(h.dataPtsPerChan,h.lActualEpisodes)>0
fclose(fid);
error('number of data points not OK');
end
% temporary helper var
dataPtsPerSweep=h.sweepLengthInPts*h.nADCNumChannels;
if fseek(fid,startPt*dataSz+headOffset,'bof')~=0
fclose(fid);
error('something went wrong positioning file pointer (too few data points ?)');
end
d=zeros(h.sweepLengthInPts,length(chInd),nSweeps);
% the starting ticks of episodes in sample points WITHIN THE DATA FILE
selectedSegStartInPts=((sweeps-1)*dataPtsPerSweep)*dataSz+headOffset;
% ** load data if requested
if doLoadData
for i=1:nSweeps,
fseek(fid,selectedSegStartInPts(i),'bof');
[tmpd,n]=fread(fid,dataPtsPerSweep,precision);
if n~=dataPtsPerSweep,
fclose(fid);
error(['something went wrong reading episode ' int2str(sweeps(i)) ': ' dataPtsPerSweep ' points should have been read, ' int2str(n) ' points actually read']);
end
h.dataPtsPerChan=n/h.nADCNumChannels;
if rem(n,h.nADCNumChannels)>0
fclose(fid);
error('number of data points in episode not OK');
end
% separate channels..
tmpd=reshape(tmpd,h.nADCNumChannels,h.dataPtsPerChan);
% retain only requested channels
tmpd=tmpd(chInd,:);
tmpd=tmpd';
% if data format is integer, scale appropriately; if it's float, d is fine
if ~h.nDataFormat
for j=1:length(chInd),
ch=recChIdx(chInd(j))+1;
tmpd(:,j)=tmpd(:,j)/(h.fInstrumentScaleFactor(ch)*h.fSignalGain(ch)*h.fADCProgrammableGain(ch)*addGain(ch))...
*h.fADCRange/h.lADCResolution+h.fInstrumentOffset(ch)-h.fSignalOffset(ch);
end
end
% now fill 3d array
d(:,:,i)=tmpd;
end
end
case 3
if verbose
disp('data were acquired in gap-free mode');
end
% from start, stop, headOffset and h.fADCSampleInterval calculate first point to be read
% and - unless stop is given as 'e' - number of points
startPt=floor(1e6*start*(1/h.fADCSampleInterval));
% this corrects undesired shifts in the reading frame due to rounding errors in the previous calculation
startPt=floor(startPt/h.nADCNumChannels)*h.nADCNumChannels;
% if stop is a char array, it can only be 'e' at this point (other values would have
% been caught above)
if ischar(stop),
h.dataPtsPerChan=h.lActualAcqLength/h.nADCNumChannels-floor(1e6*start/h.si);
h.dataPts=h.dataPtsPerChan*h.nADCNumChannels;
else
h.dataPtsPerChan=floor(1e6*(stop-start)*(1/h.si));
h.dataPts=h.dataPtsPerChan*h.nADCNumChannels;
if h.dataPts<=0
fclose(fid);
error('start is larger than or equal to stop');
end
end
if rem(h.dataPts,h.nADCNumChannels)>0
fclose(fid);
error('number of data points not OK');
end
tmp=1e-6*h.lActualAcqLength*h.fADCSampleInterval;
if verbose
disp(['total length of recording: ' num2str(tmp,'%5.1f') ' s ~ ' num2str(tmp/60,'%3.0f') ' min']);
% 8 bytes per data point expressed in Mb
disp(['memory requirement for complete upload in matlab: '...
num2str(round(8*h.lActualAcqLength/2^20)) ' MB']);
end
% recording start and stop times in seconds from midnight
h.recTime=h.lFileStartTime;
h.recTime=[h.recTime h.recTime+tmp];
if fseek(fid,startPt*dataSz+headOffset,'bof')~=0,
fclose(fid);
error('something went wrong positioning file pointer (too few data points ?)');
end
if doLoadData
% *** decide on the most efficient way to read data:
% (i) all (of one or several) channels requested: read, done
% (ii) one (of several) channels requested: use the 'skip' feature of
% fread
% (iii) more than one but not all (of several) channels requested:
% 'discontinuous' mode of reading data. Read a reasonable chunk of data
% (all channels), separate channels, discard non-requested ones (if
% any), place data in preallocated array, repeat until done. This is
% faster than reading the data in one big lump, separating channels and
% discarding the ones not requested
if length(chInd)==1 && h.nADCNumChannels>1
% --- situation (ii)
% jump to proper reading frame position in file
if fseek(fid,(chInd-1)*dataSz,'cof')~=0
fclose(fid);
error('something went wrong positioning file pointer (too few data points ?)');
end
% read, skipping h.nADCNumChannels-1 data points after each read
[d,n]=fread(fid,h.dataPtsPerChan,precision,dataSz*(h.nADCNumChannels-1));
if n~=h.dataPtsPerChan,
fclose(fid);
error(['something went wrong reading file (' int2str(h.dataPtsPerChan) ' points should have been read, ' int2str(n) ' points actually read']);
end
elseif length(chInd)/h.nADCNumChannels<1
% --- situation (iii)
% prepare chunkwise upload:
% preallocate d
d=repmat(nan,h.dataPtsPerChan,length(chInd));
% the number of data points corresponding to the maximal chunk size,
% rounded off such that from each channel the same number of points is
% read (do not forget that each data point will by default be made a
% double of 8 bytes, no matter what the original data format is)
chunkPtsPerChan=floor(chunk*2^20/8/h.nADCNumChannels);
chunkPts=chunkPtsPerChan*h.nADCNumChannels;
% the number of those chunks..
nChunk=floor(h.dataPts/chunkPts);
% ..and the remainder
restPts=h.dataPts-nChunk*chunkPts;
restPtsPerChan=restPts/h.nADCNumChannels;
% chunkwise row indices into d
dix=(1:chunkPtsPerChan:h.dataPtsPerChan)';
dix(:,2)=dix(:,1)+chunkPtsPerChan-1;
dix(end,2)=h.dataPtsPerChan;
if verbose && nChunk
disp(['reading file in ' int2str(nChunk) ' chunks of ~' num2str(chunk) ' Mb']);
end
% do it
for ci=1:size(dix,1)-1
[tmpd,n]=fread(fid,chunkPts,precision);
if n~=chunkPts
fclose(fid);
error(['something went wrong reading chunk #' int2str(ci) ' (' ...
int2str(chunkPts) ' points should have been read, ' int2str(n) ' points actually read']);
end
% separate channels..
tmpd=reshape(tmpd,h.nADCNumChannels,chunkPtsPerChan);
d(dix(ci,1):dix(ci,2),:)=tmpd(chInd,:)';
end
% collect the rest, if any
if restPts
[tmpd,n]=fread(fid,restPts,precision);
if n~=restPts
fclose(fid);
error(['something went wrong reading last chunk (' ...
int2str(restPts) ' points should have been read, ' int2str(n) ' points actually read']);
end
% separate channels..
tmpd=reshape(tmpd,h.nADCNumChannels,restPtsPerChan);
d(dix(end,1):dix(end,2),:)=tmpd(chInd,:)';
end
else
% --- situation (i)
[d,n]=fread(fid,h.dataPts,precision);
if n~=h.dataPts,
fclose(fid);
error(['something went wrong reading file (' int2str(h.dataPts) ' points should have been read, ' int2str(n) ' points actually read']);
end
% separate channels..
d=reshape(d,h.nADCNumChannels,h.dataPtsPerChan);
d=d';
end
% if data format is integer, scale appropriately; if it's float, d is fine
if ~h.nDataFormat
for j=1:length(chInd),
ch=recChIdx(chInd(j))+1;
d(:,j)=d(:,j)/(h.fInstrumentScaleFactor(ch)*h.fSignalGain(ch)*h.fADCProgrammableGain(ch)*addGain(ch))...
*h.fADCRange/h.lADCResolution+h.fInstrumentOffset(ch)-h.fSignalOffset(ch);
end
end
end
otherwise
disp('recording mode is ''high-speed oscilloscope'' which is not implemented -- returning empty matrix');
d=[];
h.si=[];
end
fclose(fid);
% h=orderfields(h);
% ########################################################################
% LOCAL FUNCTIONS
% ########################################################################
function headPar=define_header(fileSig)
switch fileSig
case 'ABF ' % ** note the blank
% ************************
% abf version < 2.0
% ************************
%
% temporary initializing var
tmp=repmat(-1,1,16);
% define vital header parameters and initialize them with -1: set up a cell
% array (and convert it to a struct below, which is more convenient)
% column order is
% name, position in header in bytes, type, value)
headPar={
'fFileSignature',0,'*char',[-1 -1 -1 -1];
'fFileVersionNumber',4,'float32',-1;
'nOperationMode',8,'int16',-1;
'lActualAcqLength',10,'int32',-1;
'nNumPointsIgnored',14,'int16',-1;
'lActualEpisodes',16,'int32',-1;
'lFileStartTime',24,'int32',-1;
'lDataSectionPtr',40,'int32',-1;
'lTagSectionPtr',44,'int32',-1;
'lNumTagEntries',48,'int32',-1;
'lSynchArrayPtr',92,'int32',-1;
'lSynchArraySize',96,'int32',-1;
'nDataFormat',100,'int16',-1;
'nADCNumChannels', 120, 'int16', -1;
'fADCSampleInterval',122,'float', -1;
'fSynchTimeUnit',130,'float',-1;
'lNumSamplesPerEpisode',138,'int32',-1;
'lPreTriggerSamples',142,'int32',-1;
'lEpisodesPerRun',146,'int32',-1;
'fADCRange', 244, 'float', -1;
'lADCResolution', 252, 'int32', -1;
'nFileStartMillisecs', 366, 'int16', -1;
'nADCPtoLChannelMap', 378, 'int16', tmp;
'nADCSamplingSeq', 410, 'int16', tmp;
'sADCChannelName',442, 'uchar', repmat(tmp,1,10);
'sADCUnits',602, 'uchar', repmat(tmp,1,8);
'fADCProgrammableGain', 730, 'float', tmp;
'fInstrumentScaleFactor', 922, 'float', tmp;
'fInstrumentOffset', 986, 'float', tmp;
'fSignalGain', 1050, 'float', tmp;
'fSignalOffset', 1114, 'float', tmp;
'nTelegraphEnable',4512,'int16',tmp;
'fTelegraphAdditGain',4576,'float',tmp
};
case 'ABF2'
% ************************
% abf version >= 2.0
% ************************
headPar={
'fFileSignature',0,'*char',[-1 -1 -1 -1];
'fFileVersionNumber',4,'bit8=>int',[-1 -1 -1 -1];
'uFileInfoSize',8,'uint32',-1;
'lActualEpisodes',12,'uint32',-1;
'uFileStartDate',16','uint32',-1;
'uFileStartTimeMS',20,'uint32',-1;
'uStopwatchTime',24,'uint32',-1;
'nFileType',28,'int16',-1;
'nDataFormat',30,'int16',-1;
'nSimultaneousScan',32,'int16',-1;
'nCRCEnable',34,'int16',-1;
'uFileCRC',36,'uint32',-1;
'FileGUID',40,'uint32',-1;
'uCreatorVersion',56,'uint32',-1;
'uCreatorNameIndex',60,'uint32',-1;
'uModifierVersion',64,'uint32',-1;
'uModifierNameIndex',68,'uint32',-1;
'uProtocolPathIndex',72,'uint32',-1;
};
end
function Sections=define_Sections
Sections={'ProtocolSection';
'ADCSection';
'DACSection';
'EpochSection';
'ADCPerDACSection';
'EpochPerDACSection';
'UserListSection';
'StatsRegionSection';
'MathSection';
'StringsSection';
'DataSection';
'TagSection';
'ScopeSection';
'DeltaSection';
'VoiceTagSection';
'SynchArraySection';
'AnnotationSection';
'StatsSection';
};
function ProtocolInfo=define_ProtocolInfo
ProtocolInfo={
'nOperationMode','int16',1;
'fADCSequenceInterval','float',1;
'bEnableFileCompression','bit1',1;
'sUnused1','char',3;
'uFileCompressionRatio','uint32',1;
'fSynchTimeUnit','float',1;
'fSecondsPerRun','float',1;
'lNumSamplesPerEpisode','int32',1;
'lPreTriggerSamples','int32',1;
'lEpisodesPerRun','int32',1;
'lRunsPerTrial','int32',1;
'lNumberOfTrials','int32',1;
'nAveragingMode','int16',1;
'nUndoRunCount','int16',1;
'nFirstEpisodeInRun','int16',1;
'fTriggerThreshold','float',1;
'nTriggerSource','int16',1;
'nTriggerAction','int16',1;
'nTriggerPolarity','int16',1;
'fScopeOutputInterval','float',1;
'fEpisodeStartToStart','float',1;
'fRunStartToStart','float',1;
'lAverageCount','int32',1;
'fTrialStartToStart','float',1;
'nAutoTriggerStrategy','int16',1;
'fFirstRunDelayS','float',1;
'nChannelStatsStrategy','int16',1;
'lSamplesPerTrace','int32',1;
'lStartDisplayNum','int32',1;
'lFinishDisplayNum','int32',1;
'nShowPNRawData','int16',1;
'fStatisticsPeriod','float',1;
'lStatisticsMeasurements','int32',1;
'nStatisticsSaveStrategy','int16',1;
'fADCRange','float',1;
'fDACRange','float',1;
'lADCResolution','int32',1;
'lDACResolution','int32',1;
'nExperimentType','int16',1;
'nManualInfoStrategy','int16',1;
'nCommentsEnable','int16',1;
'lFileCommentIndex','int32',1;
'nAutoAnalyseEnable','int16',1;
'nSignalType','int16',1;
'nDigitalEnable','int16',1;
'nActiveDACChannel','int16',1;
'nDigitalHolding','int16',1;
'nDigitalInterEpisode','int16',1;
'nDigitalDACChannel','int16',1;
'nDigitalTrainActiveLogic','int16',1;
'nStatsEnable','int16',1;
'nStatisticsClearStrategy','int16',1;
'nLevelHysteresis','int16',1;
'lTimeHysteresis','int32',1;
'nAllowExternalTags','int16',1;
'nAverageAlgorithm','int16',1;
'fAverageWeighting','float',1;
'nUndoPromptStrategy','int16',1;
'nTrialTriggerSource','int16',1;
'nStatisticsDisplayStrategy','int16',1;
'nExternalTagType','int16',1;
'nScopeTriggerOut','int16',1;
'nLTPType','int16',1;
'nAlternateDACOutputState','int16',1;
'nAlternateDigitalOutputState','int16',1;
'fCellID','float',3;
'nDigitizerADCs','int16',1;
'nDigitizerDACs','int16',1;
'nDigitizerTotalDigitalOuts','int16',1;
'nDigitizerSynchDigitalOuts','int16',1;
'nDigitizerType','int16',1;
};
function ADCInfo=define_ADCInfo
ADCInfo={
'nADCNum','int16',1;
'nTelegraphEnable','int16',1;
'nTelegraphInstrument','int16',1;
'fTelegraphAdditGain','float',1;
'fTelegraphFilter','float',1;
'fTelegraphMembraneCap','float',1;
'nTelegraphMode','int16',1;
'fTelegraphAccessResistance','float',1;
'nADCPtoLChannelMap','int16',1;
'nADCSamplingSeq','int16',1;
'fADCProgrammableGain','float',1;
'fADCDisplayAmplification','float',1;
'fADCDisplayOffset','float',1;
'fInstrumentScaleFactor','float',1;
'fInstrumentOffset','float',1;
'fSignalGain','float',1;
'fSignalOffset','float',1;
'fSignalLowpassFilter','float',1;
'fSignalHighpassFilter','float',1;
'nLowpassFilterType','char',1;
'nHighpassFilterType','char',1;
'fPostProcessLowpassFilter','float',1;
'nPostProcessLowpassFilterType','char',1;
'bEnabledDuringPN','bit1',1;
'nStatsChannelPolarity','int16',1;
'lADCChannelNameIndex','int32',1;
'lADCUnitsIndex','int32',1;
};
function TagInfo=define_TagInfo
TagInfo={
'lTagTime','int32',1;
'sComment','char',56;
'nTagType','int16',1;
'nVoiceTagNumber_or_AnnotationIndex','int16',1;
};
function Section=ReadSection(fid,offset,Format)
s=cell2struct(Format,{'name','numType','number'},2);
fseek(fid,offset,'bof');
for i=1:length(s)
eval(['[Section.' s(i).name ',n]=fread(fid,' num2str(s(i).number) ',''' s(i).numType ''');']);
end
function SectionInfo=ReadSectionInfo(fid,offset)
fseek(fid,offset,'bof');
SectionInfo.uBlockIndex=fread(fid,1,'uint32');
fseek(fid,offset+4,'bof');
SectionInfo.uBytes=fread(fid,1,'uint32');
fseek(fid,offset+8,'bof');
SectionInfo.llNumEntries=fread(fid,1,'int64');
function pvpmod(x)
% PVPMOD - evaluate parameter/value pairs
% pvpmod(x) assigns the value x(i+1) to the parameter defined by the
% string x(i) in the calling workspace. This is useful to evaluate
% <varargin> contents in an mfile, e.g. to change default settings
% of any variable initialized before pvpmod(x) is called.
%
% (c) U. Egert 1998
% this loop is assigns the parameter/value pairs in x to the calling
% workspace.
if ~isempty(x)
for i = 1:2:size(x,2)
assignin('caller', x{i}, x{i+1});
end;