-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathsimpleConvertTDMS.m
1621 lines (1415 loc) · 70.1 KB
/
simpleConvertTDMS.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 [ConvertedData,ConvertVer,ChanNames,GroupNames,ci]=simpleConvertTDMS(varargin)
%Function to load LabView TDMS data file(s) into variables in the MATLAB workspace.
%An *.MAT file can also be created. If called with one input, the user selects
%a data file.
%
% TDMS format is based on information provided by National Instruments at:
% http://zone.ni.com/devzone/cda/tut/p/id/5696
%
% [ConvertedData,ConvertVer,ChanNames]=convertTDMS(SaveConvertedFile,filename)
%
% Inputs:
% SaveConvertedFile (required) - Logical flag (true/false) that
% determines whether a MAT file is created. The MAT file's name
% is the same as 'filename' except that the 'TDMS' file extension is
% replaced with 'MAT'. The MAT file is saved in the same folder
% and will overwrite an existing file without warning. The
% MAT file contains all the output variables.
%
% filename (optional) - Filename (fully defined) to be converted.
% If not supplied, the user is provided a 'File Open' dialog box
% to navigate to a file. Can be a cell array of files for bulk
% conversion.
%
% Outputs:
% ConvertedData (required) - Structure of all of the data objects.
% ConvertVer (optional) - Version number of this function.
% ChanNames (optional) - Cell array of channel names
% GroupNames (optional) - Cell array of group names
% ci (optional) - Structure of the channel index (an index to
% where all of the information for a channel resides in a
% file.
%
%
%'ConvertedData' is a structure with 'FileName', 'FileFolder', 'SegTDMSVerNum',
%'NumOfSegments' and 'Data' fields'. The 'Data' field is a structure.
%
%'ConvertedData.SegTDMSVerNum' is a vector of the TDMS version number for each
%segment.
%
%'ConvertedData.Data' is a structure with 'Root' and 'MeasuredData' fields.
%
%'ConvertedData.Data.Root' is a structure with 'Name' and 'Property' fields.
%The 'Property' field is also a structure; it contains all the specified properties
%(1 entry for each 'Property) for the 'Root' group. For each 'Property' there are
%'Name' and 'Value' fields. To display a list of all the property names, input
%'{ConvertedData.Data.Root.Property.Name}'' in the Command Window.
%
%'ConvertedData.Data.MeasuredData' is a structure containing all the channel/group
%information. For each index (for example, 'ConvertedData.Data.MeasuredData(1)'),
%there are 'Name', 'Data' and 'Property' fields. The list of channel names can
%be displayed by typing 'ChanNames' in the Command Window. Similarly, the list
%of group names can be displayed by typing 'GroupNames' in the Command Window.
%The 'Property' field is also a structure; it contains all the specified properties
%for that index (1 entry in the structure for each 'Property'). Any LabView waveform
%attributes ('wf_start_time', 'wf_start_offset', 'wf_increment' and 'wf_samples') that
%may exist are also included in the properties. For each 'Property' there are 'Name'
%and 'Value' fields. To display a list of all the property names, input
%'{ConvertedData.Data.MeasuredData(#).Property.Name}'' in the Command Window
%where '#' is the index of interest.
%
%If you recieve an error that DAQmxRaw data cannot be converted, this is due
%to the details on parsing this data type not being published by NI. the
%work around is to use a VI that reads in the data file and then writes it
%to a new file. See: https://decibel.ni.com/content/docs/DOC-32817
%
% See Also: simpleconvertTDMS
%-------------------------------------------------------------------------
%Brad Humphreys - v1.0 2008-04-23
%ZIN Technologies
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Brad Humphreys - v1.1 2008-07-03
%ZIN Technologies
%-Added abilty for timestamp to be a raw data type, not just meta data.
%-Addressed an issue with having a default nsmaples entry for new objects.
%-Added Error trap if file name not found.
%-Corrected significant problem where it was assumed that once an object
% existsed, it would in in every subsequent segement. This is not true.
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Grant Lohsen - v1.2 2009-11-15
%Georgia Tech Research Institute
%-Converts TDMS v2 files
%Folks, it's not pretty but I don't have time to make it pretty. Enjoy.
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Jeff Sitterle - v1.3 2010-01-10
%Georgia Tech Research Institute
%Modified to return all information stored in the TDMS file to inlcude
%name, start time, start time offset, samples per read, total samples, unit
%description, and unit string. Also provides event time and event
%description in text form
%Vast speed improvement as save was the previous longest task
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Grant Lohsen - v1.4 2009-04-15
%Georgia Tech Research Institute
%Reads file header info and stores in the Root Structure.
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Robert Seltzer - v1.5 2010-07-14
%BorgWarner Morse TEC
%-Tested in MATLAB 2007b and 2010a.
%-APPEARS to now be compatible with TDMS version 1.1 (a.k.a 4712) files;
% although, this has not been extensively tested. For some unknown
% reason, the version 1.2 (4713) files process noticeably faster. I think
% that it may be related to the 'TDSm' tag.
%-"Time Stamp" data type was not tested.
%-"Waveform" fields was not tested.
%-Fixed an error in the 'LV2MatlabDataType' function where LabView data type
% 'tdsTypeSingleFloat' was defined as MATLAB data type 'float64' . Changed
% to 'float32'.
%-Added error trapping.
%-Added feature to count the number of segments for pre-allocation as
% opposed to estimating the number of segments.
%-Added option to save the data in a MAT file.
%-Fixed "invalid field name" error caused by excessive string lengths.
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Robert Seltzer - v1.6 2010-09-01
%BorgWarner Morse TEC
%-Tested in MATLAB 2010a.
%-Fixed the "Coversion to cell from char is not possible" error found
% by Francisco Botero in version 1.5.
%-Added capability to process both fragmented or defragmented data.
%-Fixed the "field" error found by Lawrence.
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Christian Buxel - V1.7 2010-09-17
%RWTH Aachen
%-Tested in Matlab2007b.
%-Added support for german umlauts (�,�,�,�,�,�,�) in 'propsName'
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Andr� R�egg - V1.7 2010-09-29
%Supercomputing Systems AG
%-Tested in MATLAB 2006a & 2010b
%-Make sure that data can be loaded correctly independently of character
% encoding set in matlab.
%-Fixed error if object consists of several segments with identical segment
% information (if rawdataindex==0, not all segments were loaded)
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Robert Seltzer - v1.7 2010-09-30
%BorgWarner Morse TEC
%-Tested in MATLAB 2010b.
%-Added 'error trapping' to the 'fixcharformatlab' function for group and
% channel names that contain characters that are not 'A' through 'Z',
% 'a' through 'z', 0 through 9 or underscore. The characters are replaced
% with an underscore and a message is written to the Command Window
% explaining to the user what has happened and how to fix it. Only tested
% with a very limited number of "special" characters.
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Robert Seltzer - v1.8 2010-10-12
%BorgWarner Morse TEC
%-As a result of an error found by Peter Sulcs when loading data with very
% long channel names, I have re-written the sections of the function that
% creates the channel and property names that are used within the body of
% the function to make them robust against long strings and strings
% containing non-UTF8 characters. The original channel and property
% names (no truncation or character replacement) are now retained and
% included in the output structure. In order to implement this improvement,
% I added a 'Property' field as a structure to the 'ConvertedData' output
% structure.
%-Added a more detailed 'help' description ('doc convertTDMS') of the
% returned structure.
%-List of channel names added as an output parameter of the function.
%-Corrected an error in the time stamp converion. It was off by exactly
% 1 hour.
%-Tested in MATLAB 2010b with a limited number of diverse TDMS files.
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Robert Seltzer - v1.8 2010-10-19
%BorgWarner Morse TEC
%-Fixed an error found by Terenzio Girotto with the 'save' routine.
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Robert Seltzer - v1.8 2010-10-25
%BorgWarner Morse TEC
%-Fixed an error with channels that contain no data. Previously, if a
% channel contained no data, then it was not passed to the output structure
% even if it did contain properties.
%-Added 'GroupNames' as an optional output variable.
%-Fixed an error with capturing the properties of the Root object
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Philip Top - v1.9 2010-11-09
%John Breneman
%-restructured code as function calls
%-seperated metadata reads from data reads
%-preallocated space for SegInfo with two pass file read
%-preallocated index information and defined segdataoffset for each segment
%-preallocate space for data for speedup in case of fragmented files
%-used matlab input parser instead of nargin switch
%-vectorized timestamp reads for substantial speedup
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Robert Seltzer - v1.9 2010-11-10
%BorgWarner Morse TEC
%-Fixed an error error in the 'offset' calculation for strings
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Philip Top - v1.95 2011-5-10
%Fix Bug with out of order file segments
%Fix some issues with string array reads for newer version files,
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Brad Humphreys - v1.96 2013-10-9
%Fixed problem with error catch messages themselves (interleaved, version,
%big endian) using the TDMSFileName variable which was not available
%(passed into) the getSegInfo function. Added ability to work with
%interleaved and big endian files.
%So function now covers:
% -v1.0-v2.0
% -Interleaved and Decimated Data Formats
% -Big and Little Endian storage
% Does not work with DAQmxRawData
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Brad Humphreys - v1.97 2013-11-13
%Added information to help documentation on how to deal with DAQmxRaw Data.
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Brad Humphreys - v1.98 2014-5-27
%Per G. Lohsen's suggestion, added check to verify that first caharters are
% TDMs. If not, errors out and lets user know that the selected file is
% not a TDMS file.
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Brad Humphreys - v1.99 2014-7-7
%Corrected issue where when properties, but not raw data was updated in a
%later segment (rawDataIndex=FFFFFFFF), the channel index was still
%appended with a copy of the previous entries data.
%-------------------------------------------------------------------------
%-------------------------------------------------------------------------
%Sebastian Schwarzendahl (alias Haench) - v1.99 2014-10-23
% Added support for complex data types
% CSG - tdsTypeComplexSingleFloat=0x08000c
% CDB - tdsTypeComplexDoubleFloat=0x10000d)
% This feature was added in LV2013 (I believ) and produced an error in
% the previous version of this code.
%-------------------------------------------------------------------------
%Initialize outputs
ConvertVer='1.99'; %Version number of this conversion function
ConvertedData=[];
p=inputParser();
p.addRequired('SaveConvertedFile',@(x) islogical(x)||(ismember(x,[0,1])));
p.addOptional('filename','',@(x) iscell(x)||exist(x,'file'));
p.parse(varargin{:});
filename=p.Results.filename;
SaveConvertedFile=p.Results.SaveConvertedFile;
if isempty(filename)
%Prompt the user for the file
[filename,pathname]=uigetfile({'*.tdms','All Files (*.tdms)'},'Choose a TDMS File');
if filename==0
return
end
filename=fullfile(pathname,filename);
end
if iscell(filename)
%For a list of files
infilename=filename;
else
infilename=cellstr(filename);
end
for fnum=1:numel(infilename)
if ~exist(infilename{fnum},'file')
e=errordlg(sprintf('File ''%s'' not found.',infilename{fnum}),'File Not Found');
uiwait(e)
return
end
FileNameLong=infilename{fnum};
[pathstr,name,ext]=fileparts(FileNameLong);
FileNameShort=sprintf('%s%s',name,ext);
FileNameNoExt=name;
FileFolder=pathstr;
if fnum==1
fprintf('\n\n')
end
fprintf('Converting ''%s''...',FileNameShort)
fid=fopen(FileNameLong);
if fid==-1
e=errordlg(sprintf('Could not open ''%s''.',FileNameLong),'File Cannot Be Opened');
uiwait(e)
fprintf('\n\n')
return
end
% Build a database with segment info
[SegInfo,NumOfSeg]=getSegInfo(fid);
% Build a database with channel info
[channelinfo SegInfo]=getChannelInfo(fid,SegInfo,NumOfSeg);
% Add channel count to SegInfo
%SegInfo=addChanCount(SegInfo,channelinfo);
% Get the raw data
ob=getData(fid,channelinfo,SegInfo); %Returns the objects which have data. See postProcess function (appends to all of the objects)
fclose(fid);
%Assign the outputs
ConvertedData(fnum).FileName=FileNameShort;
ConvertedData(fnum).FileFolder=FileFolder;
ConvertedData(fnum).SegTDMSVerNum=SegInfo.vernum;
ConvertedData(fnum).NumOfSegments=NumOfSeg;
[ConvertedData(fnum).Data,CurrGroupNames]=postProcess(ob,channelinfo);
GroupNames(fnum)={CurrGroupNames};
TempChanNames={ConvertedData(fnum).Data.MeasuredData.Name};
TempChanNames(strcmpi(TempChanNames,'Root'))=[];
ChanNames(fnum)={sort(setdiff(TempChanNames',CurrGroupNames))};
if SaveConvertedFile
MATFileNameShort=sprintf('%s.mat',FileNameNoExt);
MATFileNameLong=fullfile(FileFolder,MATFileNameShort);
try
save(MATFileNameLong,'ConvertedData','ConvertVer','ChanNames')
fprintf('\n\nConversion complete (saved in ''%s'').\n\n',MATFileNameShort)
catch exception
fprintf('\n\nConversion complete (could not save ''%s'').\n\t%s: %s\n\n',MATFileNameShort,exception.identifier,...
exception.message)
end
else
fprintf('\n\nConversion complete.\n\n')
end
end
ci=channelinfo;
end
%%
function [SegInfo,NumOfSeg]=getSegInfo(fid)
% Go through the whole file and build a database of the segment lead-in
% information:
%1) Count the total number of segments in the file. (NumOfSeg)
%2) Get all of the "Lead In" Headers from all of the segements and store
% that in the SegInfo variable:
% SegInfo.SegStartPosn: Absolute Starting Position of Segment in file
% SegInfo.MetaStartPosn: Absolute Starting Position of Meta Data in file
% SegInfo.DataStartPosn: Absolute Starting Position of Raw Data in file
% SegInfo.DataLength: Number of bytes of Data in segment
% SegInfo.vernum: LV version number (4712 is v1.0, 4713 is v2.0)
% SegInfo.NumChan: number of channels in this segement. This is
% only instatated in this function to 0. This is later updated
% to show the number of channels in the segment (note that this
% is not the number of raw data channels in the segment, as a
% segment can just have property data).
%
% SegInfo.SegHasMetaData: There is Meta Data in the Segement
% SegInfo.SegHasRawData: There is Raw Data in the Segment
% SegInfo.SegHasDaqMxRaw: There is DAQmxRaw Data in the Segment
% SegInfo.SegInterleaved: 0: Contigous Data, 1: Interleaved Data
% SegInfo.SegBigEndian: 0: Little, 1:Big (numeric, leadin, raw, and meta)
% SegInfo.SegHasNewObjList: New object list in Segment
%
%3) While doing the above, also include error trapping for incompatibity
%Find the end of the file
fseek(fid,0,'eof');
eoff=ftell(fid);
frewind(fid);
segCnt=0;
CurrPosn=0;
LeadInByteCount=28; %From the National Instruments web page (http://zone.ni.com/devzone/cda/tut/p/id/5696) under
%the 'Lead In' description on page 2: Counted the bytes shown in the table.
while (ftell(fid) ~= eoff)
Ttag=fread(fid,1,'uint8','l');
Dtag=fread(fid,1,'uint8','l');
Stag=fread(fid,1,'uint8','l');
mtag=fread(fid,1,'uint8','l');
if Ttag==84 && Dtag==68 && Stag==83 && mtag==109
%Apparently, this sequence of numbers identifies the start of a new segment.
segCnt=segCnt+1;
%ToC Field
ToC=fread(fid,1,'uint32','l');
kTocBigEndian=bitget(ToC,7);
if kTocBigEndian
kTocEndian='b';
else
kTocEndian='l';
end
%TDMS format version number
vernum=fread(fid,1,'uint32',kTocEndian);
%From the National Instruments web page (http://zone.ni.com/devzone/cda/tut/p/id/5696) under the 'Lead In'
%description on page 2:
%The next eight bytes (64-bit unsigned integer) describe the length of the remaining segment (overall length of the
%segment minus length of the lead in). If further segments are appended to the file, this number can be used to
%locate the starting point of the following segment. If an application encountered a severe problem while writing
%to a TDMS file (crash, power outage), all bytes of this integer can be 0xFF. This can only happen to the last
%segment in a file.
nlen=fread(fid,1,'uint64',kTocEndian);
if (nlen>2^63)
break;
else
segLength=nlen;
end
TotalLength=segLength+LeadInByteCount;
CurrPosn=CurrPosn+TotalLength;
status=fseek(fid,CurrPosn,'bof'); %Move to the beginning position of the next segment
if (status<0)
warning('file glitch');
break;
end
else %TDSm should be the first charaters in a tdms file. If not there, error out to stop hunting.
fclose(fid);
error('Unable to find TDSm tag. This may not be a tdms file, or you forgot to add the .tdms extension to the filename and are reading the wrong file');
end
end
frewind(fid);
CurrPosn=0;
SegInfo.SegStartPosn=zeros(segCnt,1);
SegInfo.MetaStartPosn=zeros(segCnt,1);
SegInfo.DataStartPosn=zeros(segCnt,1);
SegInfo.vernum=zeros(segCnt,1);
SegInfo.DataLength=zeros(segCnt,1);
SegInfo.NumChan=zeros(segCnt,1);
SegInfo.SegHasMetaData=false(segCnt,1);
SegInfo.SegHasRawData=false(segCnt,1);
SegInfo.SegHasDaqMxRaw=false(segCnt,1);
SegInfo.SegInterleaved=false(segCnt,1);
SegInfo.SegBigEndian=false(segCnt,1);
SegInfo.SegHasNewObjList=false(segCnt,1);
segCnt=0;
while (ftell(fid) ~= eoff)
Ttag=fread(fid,1,'uint8','l');
Dtag=fread(fid,1,'uint8','l');
Stag=fread(fid,1,'uint8','l');
mtag=fread(fid,1,'uint8','l');
if Ttag==84 && Dtag==68 && Stag==83 && mtag==109
%Apparently, this sequence of numbers identifies the start of a new segment.
%Leaving the above comment in, because it reflects that state of
%the NI documenation on TDMS files when the contributers first started
%developing this code.
segCnt=segCnt+1;
if segCnt==1
StartPosn=0;
else
StartPosn=CurrPosn;
end
%ToC Field
ToC=fread(fid,1,'uint32','l');
kTocBigEndian=bitget(ToC,7);
kTocMetaData=bitget(ToC,2);
kTocNewObjectList=bitget(ToC,3);
kTocRawData=bitget(ToC,4);
kTocDaqMxRawData=bitget(ToC,8);
kTocInterleavedData=bitget(ToC,6);
if kTocBigEndian
kTocEndian='b';
else
kTocEndian='l';
end
% if kTocInterleavedData
% error([sprintf(['\n Seqment %.0f of the above file has interleaved data which is not supported with this '...
% 'function. '],segCnt),'Interleaved Data Not Supported']);
% fclose(fid);
% end
% if kTocBigEndian
% error(sprintf(['\n Seqment %.0f of the above file uses the big-endian data format which is not supported '...
% 'with this function. '],segCnt),'Big-Endian Data Format Not Supported');
% fclose(fid);
% end
if kTocDaqMxRawData
error(sprintf(['\n Seqment %.0f of the above file contains data in the DAQmxRaw NI datatype format which is not supported '...
'with this function. See help documentation in convertTDMS.m for how to fix this. '],segCnt),'DAQmxRawData Format Not Supported');
fclose(fid);
end
%TDMS format version number
vernum=fread(fid,1,'uint32',kTocEndian);
if ~ismember(vernum,[4712,4713])
error(sprintf(['\n Seqment %.0f of the above file used LabView TDMS file format version %.0f which is not '...
'supported with this function (%s.m).'],segCnt,vernum),...
'TDMS File Format Not Supported');
fclose(fid);
end
%From the National Instruments web page (http://zone.ni.com/devzone/cda/tut/p/id/5696) under the 'Lead In'
%description on page 2:
%The next eight bytes (64-bit unsigned integer) describe the length of the remaining segment (overall length of the
%segment minus length of the lead in). If further segments are appended to the file, this number can be used to
%locate the starting point of the following segment. If an application encountered a severe problem while writing
%to a TDMS file (crash, power outage), all bytes of this integer can be 0xFF. This can only happen to the last
%segment in a file.
segLength=fread(fid,1,'uint64',kTocEndian);
metaLength=fread(fid,1,'uint64',kTocEndian);
if (segLength>2^63)
fseek(fid,0,'eof');
flen=ftell(fid);
segLength=flen-LeadInByteCount-TotalLength;
TotalLength=segLength+LeadInByteCount;
else
TotalLength=segLength+LeadInByteCount;
CurrPosn=CurrPosn+TotalLength;
fseek(fid,CurrPosn,'bof'); %Move to the beginning position of the next segment
end
SegInfo.SegStartPosn(segCnt)=StartPosn;
SegInfo.MetaStartPosn(segCnt)=StartPosn+LeadInByteCount;
SegInfo.DataStartPosn(segCnt)=SegInfo.MetaStartPosn(segCnt)+metaLength;
SegInfo.DataLength(segCnt)=segLength-metaLength;
SegInfo.vernum(segCnt)=vernum;
SegInfo.SegHasMetaData(segCnt)=kTocMetaData;
SegInfo.SegHasRawData(segCnt)=kTocRawData;
SegInfo.SegHasDaqMxRaw(segCnt)=kTocDaqMxRawData;
SegInfo.SegInterleaved(segCnt)=kTocInterleavedData;
SegInfo.SegBigEndian(segCnt)=kTocBigEndian;
SegInfo.SegHasNewObjList(segCnt)=kTocNewObjectList;
end
end
NumOfSeg=segCnt;
end
%%
function [index SegInfo]=getChannelInfo(fid,SegInfo,NumOfSeg)
%Loop through the segements and get all of the object information.
% name: Short name such as Object3
% long_name: The path directory form of the object name
% rawdatacount: number of segments that have raw data for this object
% datastartindex: Absolute position in file of the begining of all raw
% data for the segment. Add the rawdata offset to get to this object's
% start point.
% arrayDim: array dimension of raw data (for now should always be one as
% NI does not support multi-dimension
% nValues: number of values of raw data in segment
% byteSize: number of bytes for string/char data
% index: segment numbers that contain raw data for this object
% rawdataoffset: offset from datastartindex for the begining of raw data
% for this object
% multiplier: As part of LV's optimization, it will appenend raw data writes to the
% TDMS file when meta data does not change, but forget to update the
% nValues. multiplier is the number of times the base pattern
% repeats.
% skip: When multiple raw data writes are appended, this is the number of
% bytes between the end of a channel in one block to the begining of that channel in
% the next block.
% dataType: The data type for this object. See LV2MatlabDataType function.
% datasize: Number of bytes for each raw data entry.
% Property Structures: Structure containg properties.
%Initialize variables for the file conversion
index=struct();
objOrderList={};
for segCnt=1:NumOfSeg
%Go to the segment starting position of the segment
fseek(fid,SegInfo.SegStartPosn(segCnt)+28,'bof');
% +28 bytes: TDSm (4) + Toc (4) + segVer# (4) + segLength (8) + metaLength (8)
%segVersionNum=SegInfo.vernum(segCnt);
kTocMetaData=SegInfo.SegHasMetaData(segCnt);
kTocNewObjectList=SegInfo.SegHasNewObjList(segCnt);
kTocRawData=SegInfo.SegHasRawData(segCnt);
kTocInterleavedData=SegInfo.SegInterleaved(segCnt);
kTocBigEndian=SegInfo.SegBigEndian(segCnt);
if kTocBigEndian
kTocEndian='b';
else
kTocEndian='l';
end
%% Process Meta Data
%If the object list from the last segment should be used....
if (kTocNewObjectList==0)
fnm=fieldnames(index); %Get a list of the objects/channels to loop through
for kk=1:length(fnm)
ccnt=index.(fnm{kk}).rawdatacount;
if (ccnt>0) %If there is raw data info in the previous segement, copy it into the new segement
if (index.(fnm{kk}).index(ccnt)==segCnt-1)
ccnt=ccnt+1;
index.(fnm{kk}).rawdatacount=ccnt;
index.(fnm{kk}).datastartindex(ccnt)=SegInfo.DataStartPosn(segCnt);
index.(fnm{kk}).arrayDim(ccnt)=index.(fnm{kk}).arrayDim(ccnt-1);
index.(fnm{kk}).nValues(ccnt)=index.(fnm{kk}).nValues(ccnt-1);
index.(fnm{kk}).byteSize(ccnt)=index.(fnm{kk}).byteSize(ccnt-1);
index.(fnm{kk}).index(ccnt)=segCnt;
index.(fnm{kk}).rawdataoffset(ccnt)=index.(fnm{kk}).rawdataoffset(ccnt-1);
SegInfo.NumChan(segCnt)=SegInfo.NumChan(segCnt)+1;
end
end
end
end
%If there is Meta data in the segement
if kTocMetaData
numObjInSeg=fread(fid,1,'uint32',kTocEndian);
if (kTocNewObjectList)
objOrderList=cell(numObjInSeg,1);
end
for q=1:numObjInSeg
obLength=fread(fid,1,'uint32',kTocEndian); %Get the length of the objects name
ObjName=convertToText(fread(fid,obLength,'uint8','l'))'; %Get the objects name
if strcmp(ObjName,'/')
long_obname='Root';
else
long_obname=ObjName;
%Delete any apostrophes. If the first character is a slash (forward or backward), delete it too.
long_obname(strfind(long_obname,''''))=[];
if strcmpi(long_obname(1),'/') || strcmpi(long_obname(1),'\')
long_obname(1)=[];
end
end
newob=0;
%Create object's name. Use a generic field name to avoid issues with strings that are too long and/or
%characters that cannot be used in MATLAB variable names. The actual channel name is retained for the final
%output structure.
if exist('ObjNameList','var')
%Check to see if the object already exists
NameIndex=find(strcmpi({ObjNameList.LongName},long_obname)==1,1,'first');
if isempty(NameIndex)
newob=1;
%It does not exist, so create the generic name field name
ObjNameList(end+1).FieldName=sprintf('Object%.0f',numel(ObjNameList)+1);
ObjNameList(end).LongName=long_obname;
NameIndex=numel(ObjNameList);
end
else
%No objects exist, so create the first one using a generic name field name.
ObjNameList.FieldName='Object1';
ObjNameList.LongName=long_obname;
NameIndex=1;
newob=1;
end
%Assign the generic field name
obname=ObjNameList(NameIndex).FieldName;
%Create the 'index' structure
if (~isfield(index,obname))
index.(obname).name=obname;
index.(obname).long_name=long_obname;
index.(obname).rawdatacount=0;
index.(obname).datastartindex=zeros(NumOfSeg,1);
index.(obname).arrayDim=zeros(NumOfSeg,1);
index.(obname).nValues=zeros(NumOfSeg,1);
index.(obname).byteSize=zeros(NumOfSeg,1);
index.(obname).index=zeros(NumOfSeg,1);
index.(obname).rawdataoffset=zeros(NumOfSeg,1);
index.(obname).multiplier=ones(NumOfSeg,1);
index.(obname).skip=zeros(NumOfSeg,1);
end
if (kTocNewObjectList)
objOrderList{q}=obname;
else
if ~ismember(obname,objOrderList)
objOrderList{end+1}=obname;
end
end
%Get the raw data Index
rawdataindex=fread(fid,1,'uint32',kTocEndian);
if rawdataindex==0
if segCnt==0 %Unclear why this is here, segCnt should always be >=1, unless there is a significant error
e=errordlg(sprintf('Seqment %.0f within ''%s'' has ''rawdataindex'' value of 0 (%s.m).',segCnt,...
TDMSFileNameShort,mfilename),'Incorrect ''rawdataindex''');
uiwait(e)
end
if kTocRawData
if (kTocNewObjectList)
ccnt=index.(obname).rawdatacount+1;
else
ccnt=index.(obname).rawdatacount;
end
%Copy the previous segments raw data info
index.(obname).rawdatacount=ccnt;
index.(obname).datastartindex(ccnt)=SegInfo.DataStartPosn(segCnt);
index.(obname).arrayDim(ccnt)=index.(obname).arrayDim(ccnt-1);
index.(obname).nValues(ccnt)=index.(obname).nValues(ccnt-1);
index.(obname).byteSize(ccnt)=index.(obname).byteSize(ccnt-1);
index.(obname).index(ccnt)=segCnt;
SegInfo.NumChan(segCnt)=SegInfo.NumChan(segCnt)+1;
end
elseif rawdataindex+1==2^32
%Objects raw data index matches previous index - no changes. The root object will always have an
%'FFFFFFFF' entry
if strcmpi(index.(obname).long_name,'Root')
index.(obname).rawdataindex=0;
else
%Need to account for the case where an object (besides the 'root') is added that has no data but reports
%using previous.
if newob
index.(obname).rawdataindex=0;
else
if kTocRawData
if (kTocNewObjectList)
ccnt=index.(obname).rawdatacount+1;
else
ccnt=index.(obname).rawdatacount;
end
% Modified by BTH 7-7-14. This caused an issue with files where properties
% were updated in later segments but no raw data was in that segment (it
% was copying the previous segments info instead of just setting it to default values).
% index.(obname).rawdatacount=ccnt;
% index.(obname).datastartindex(ccnt)=SegInfo.DataStartPosn(segCnt);
% index.(obname).arrayDim(ccnt)=index.(obname).arrayDim(ccnt-1);
% index.(obname).nValues(ccnt)=index.(obname).nValues(ccnt-1);
% index.(obname).byteSize(ccnt)=index.(obname).byteSize(ccnt-1);
% index.(obname).index(ccnt)=segCnt;
index.(obname).rawdatacount=ccnt;
index.(obname).datastartindex(ccnt)=0;
index.(obname).arrayDim(ccnt)=0;
index.(obname).nValues(ccnt)=0;
index.(obname).byteSize(ccnt)=0;
index.(obname).index(ccnt)=segCnt;
SegInfo.NumChan(segCnt)=SegInfo.NumChan(segCnt)+1;
end
end
end
else
%Get new object information
if (kTocNewObjectList)
ccnt=index.(obname).rawdatacount+1;
else
ccnt=index.(obname).rawdatacount;
if (ccnt==0)
ccnt=1;
end
end
index.(obname).rawdatacount=ccnt;
index.(obname).datastartindex(ccnt)=SegInfo.DataStartPosn(segCnt);
%index(end).lenOfIndexInfo=fread(fid,1,'uint32');
index.(obname).dataType=fread(fid,1,'uint32',kTocEndian);
if (index.(obname).dataType~=32)
index.(obname).datasize=getDataSize(index.(obname).dataType);
end
index.(obname).arrayDim(ccnt)=fread(fid,1,'uint32',kTocEndian);
index.(obname).nValues(ccnt)=fread(fid,1,'uint64',kTocEndian);
index.(obname).index(ccnt)=segCnt;
SegInfo.NumChan(segCnt)=SegInfo.NumChan(segCnt)+1;
if index.(obname).dataType==32
%Datatype is a string
index.(obname).byteSize(ccnt)=fread(fid,1,'uint64',kTocEndian);
else
index.(obname).byteSize(ccnt)=0;
end
end
%Get the properties
numProps=fread(fid,1,'uint32',kTocEndian);
if numProps>0
if isfield(index.(obname),'PropertyInfo')
PropertyInfo=index.(obname).PropertyInfo;
else
clear PropertyInfo
end
for p=1:numProps
propNameLength=fread(fid,1,'uint32',kTocEndian);
switch 1
case 1
PropName=fread(fid,propNameLength,'*uint8','l')';
PropName=native2unicode(PropName,'UTF-8');
case 2
PropName=fread(fid,propNameLength,'uint8=>char','l')';
otherwise
end
propsDataType=fread(fid,1,'uint32',kTocEndian);
%Create property's name. Use a generic field name to avoid issues with strings that are too long and/or
%characters that cannot be used in MATLAB variable names. The actual property name is retained for the
%final output structure.
if exist('PropertyInfo','var')
%Check to see if the property already exists for this object. Need to get the existing 'PropertyInfo'
%structure for this object. The 'PropertyInfo' structure is not necessarily the same for every
%object in the data file.
PropIndex=find(strcmpi({PropertyInfo.Name},PropName));
if isempty(PropIndex)
%Is does not exist, so create the generic name field name
propExists=false;
PropIndex=numel(PropertyInfo)+1;
propsName=sprintf('Property%.0f',PropIndex);
PropertyInfo(PropIndex).Name=PropName;
PropertyInfo(PropIndex).FieldName=propsName;
else
%Assign the generic field name
propExists=true;
propsName=PropertyInfo(PropIndex).FieldName;
end
else
%No properties exist for this object, so create the first one using a generic name field name.
propExists=false;
PropIndex=p;
propsName=sprintf('Property%.0f',PropIndex);
PropertyInfo(PropIndex).Name=PropName;
PropertyInfo(PropIndex).FieldName=propsName;
end
dataExists=isfield(index.(obname),'data');
%Get the number of samples already found and in the object
if dataExists
nsamps=index.(obname).nsamples+1;
else
nsamps=0;
end
if propsDataType==32 %String data type
PropertyInfo(PropIndex).DataType='String';
propsValueLength=fread(fid,1,'uint32',kTocEndian);
propsValue=convertToText(fread(fid,propsValueLength,'uint8=>char',kTocEndian))';
if propExists
if isfield(index.(obname).(propsName),'cnt')
cnt=index.(obname).(propsName).cnt+1;
else
cnt=1;
end
index.(obname).(propsName).cnt=cnt;
index.(obname).(propsName).value{cnt}=propsValue;
index.(obname).(propsName).samples(cnt)=nsamps;
else
if strcmp(index.(obname).long_name,'Root')
%Header data
index.(obname).(propsName).name=index.(obname).long_name;
index.(obname).(propsName).value={propsValue};
index.(obname).(propsName).cnt=1;
else
index.(obname).(propsName).name=PropertyInfo(PropIndex).Name;
index.(obname).(propsName).datatype=PropertyInfo(PropIndex).DataType;
index.(obname).(propsName).cnt=1;
index.(obname).(propsName).value=cell(nsamps,1); %Pre-allocation
index.(obname).(propsName).samples=zeros(nsamps,1); %Pre-allocation
if iscell(propsValue)
index.(obname).(propsName).value(1)=propsValue;
else
index.(obname).(propsName).value(1)={propsValue};
end
index.(obname).(propsName).samples(1)=nsamps;
end
end
else %Numeric data type
if propsDataType==68 %Timestamp
PropertyInfo(PropIndex).DataType='Time';
%Timestamp data type
if kTocBigEndian
tsec=fread(fid,1,'uint64','b')+fread(fid,1,'uint64','b')/2^64; %time since Jan-1-1904 in seconds
else
tsec=fread(fid,1,'uint64','l')/2^64+fread(fid,1,'uint64','l'); %time since Jan-1-1904 in seconds
end
%tsec=fread(fid,1,'uint64',kTocEndian)/2^64+fread(fid,1,'uint64',kTocEndian); %time since Jan-1-1904 in seconds
%R. Seltzer: Not sure why '5/24' (5 hours) is subtracted from the time value. That's how it was
%coded in the original function I downloaded from MATLAB Central. But I found it to be 1 hour too
%much. So, I changed it to '4/24'.
%propsValue=tsec/86400+695422-5/24; %/864000 convert to days; +695422 days from Jan-0-0000 to Jan-1-1904
propsValue=tsec/86400+695422-4/24; %/864000 convert to days; +695422 days from Jan-0-0000 to Jan-1-1904
else %Numeric
PropertyInfo(PropIndex).DataType='Numeric';
matType=LV2MatlabDataType(propsDataType);
if strcmp(matType,'Undefined')
e=errordlg(sprintf('No MATLAB data type defined for a ''Property Data Type'' value of ''%.0f''.',...
propsDataType),'Undefined Property Data Type');
uiwait(e)
fclose(fid);
return
end
if strcmp(matType,'uint8=>char')
propsValue=convertToText(fread(fid,1,'uint8',kTocEndian));
else
propsValue=fread(fid,1,matType,kTocEndian);
end
end
if propExists
cnt=index.(obname).(propsName).cnt+1;
index.(obname).(propsName).cnt=cnt;
index.(obname).(propsName).value(cnt)=propsValue;
index.(obname).(propsName).samples(cnt)=nsamps;
else
index.(obname).(propsName).name=PropertyInfo(PropIndex).Name;
index.(obname).(propsName).datatype=PropertyInfo(PropIndex).DataType;
index.(obname).(propsName).cnt=1;
index.(obname).(propsName).value=NaN(nsamps,1); %Pre-allocation
index.(obname).(propsName).samples=zeros(nsamps,1); %Pre-allocation
index.(obname).(propsName).value(1)=propsValue;
index.(obname).(propsName).samples(1)=nsamps;
end
end
end %'end' for the 'Property' loop
index.(obname).PropertyInfo=PropertyInfo;
end
end %'end' for the 'Objects' loop
end
%Address Decimation and Interleaving
if (kTocRawData)
singleSegDataSize=0;
rawDataBytes=0;
chanBytes=0;
rawDataOffset=0;
for kk=1:numel(objOrderList)
obname=objOrderList{kk};
ccnt=hasRawDataInSeg(segCnt,index.(obname));
if ccnt>0 %If segement has raw data
index.(obname).rawdataoffset(ccnt)=rawDataOffset;
if index.(obname).dataType==32 %Datatype is a string
rawDataBytes=index.(obname).byteSize(ccnt);
else
rawDataBytes=index.(obname).nValues(ccnt)*index.(obname).datasize;
if kTocInterleavedData
chanBytes=index.(obname).datasize;
else
chanBytes=rawDataBytes;
end