source: aedes_readfid.m @ 112

Last change on this file since 112 was 112, checked in by tjniskan, 9 years ago
  • Still trying to get EPI working

M aedes_readfid.m
M aedes_revision.m

File size: 56.1 KB
Line 
1function [DATA,msg_out] = aedes_readfid(filename,varargin)
2% AEDES_READFID - Read VNMR (Varian) FID-files
3%   
4%
5% Synopsis:
6%        [DATA,msg]=aedes_readfid(filename,'PropertyName1',value1,'PropertyName2',value2,...)
7%        [DATA,msg]=aedes_readfid(filename,'header')
8%        [DATA,msg]=aedes_readfid(filename,output_filename)
9%
10% Description:
11%        The function reads VNMR (Varian) FID-file and return a structure
12%        DATA with fields DataFormat, HDR, FTDATA, KSPACE, PROCPAR, and
13%        PHASETABLE. The fields of the DATA structure are constructed as
14%        follows:
15%       
16%        DATA
17%          |-> DataFormat         (string identifier for data format 'vnmr')
18%          |-> HDR
19%                |-> FileHeader   (data file header)
20%                |-> BlockHeaders (data block headers, not stored by default)
21%                |-> fname        (file name)
22%                |-> fpath        (file path)
23%                |-> Param        (parameter values used by AEDES_READFID to read the data)
24%          |-> FTDATA             (real fourier transformed image data)
25%          |-> KSPACE             (complex k-space, empty by default)
26%          |-> PROCPAR            (parameters from procpar file)
27%          |-> PHASETABLE         (phasetable)
28%
29%        The DATA structure is returned as empty (without HDR, FTDATA,
30%        KSPACE, and PROCPAR fields) if an error has occurred during
31%        reading. The error message is returned in the second output
32%        argument msg. If AEDES_READFID is called with only one output argument
33%        (i.e. without MSG), the error message is echoed to the workspace.
34%       
35%        The first input argument is either a string containing full path to
36%        the FID-file or the header structure HDR. Only the data file header
37%        can be read by giving a string 'header' as the second input
38%        argument.
39%
40%        By default the k-space is not returned, i.e. the field KSPACE is
41%        empty. The returned data can be adjusted by using the 'return'
42%        property and values 1, 2, or 3 (see below for more information).
43%
44%        The supported property-value pairs in AEDES_READFID (property strings
45%        are not case sensitive):
46%
47%        Property:        Value:                Description:
48%        *********        ******                ************
49%        'Return'      :  [ {1} | 2 | 3 | 4 ]   % 1=return only ftdata (default)
50%                                               % 2=return only k-space
51%                                               % 3=return both ftdata & kspace
52%                                               % 4=return raw kspace
53%
54%        'FastRead'    :  [{'off'} | 'on' ]     % Enables an experimental
55%                                               % method for very fast reading
56%                                               % of fid-files. This not as
57%                                               % robust as the older
58%                                               % method and can consume a lot
59%                                               % of memory.
60%
61%        'OutputFile'  :  filename              % Writes the slices into
62%                                               % NIfTI-format files
63%                                               % using the given filename.
64%
65%        'DCcorrection':  [ {'off'} | 'on' ]    % 'on'=use DC correction
66%                                               % 'off'=don't use DC correction
67%                                               % (default)
68%
69%        'Procpar'     :  (procpar-structure)   % Input procpar
70%                                               % structure. If this
71%                                               % property is not set the
72%                                               % procpar structure
73%                                               % will be read using
74%                                               % AEDES_READPROCPAR
75%
76%        'ZeroPadding' :  ['off'|'on'|{'auto'}] % 'off' = force
77%                                               % zeropadding off
78%                                               % 'on' = force
79%                                               % zeropadding on (force
80%                                               % images to be square)
81%                                               % 'auto' = autoselect
82%                                               % using relative FOV
83%                                               % dimensions (default)
84%
85%        'PhaseTable'  : (custom phase table)   % User-specified
86%                                               % line order for
87%                                               % k-space. The phase table
88%                                               % is obtained from the file
89%                                               % specified in
90%                                               % procpar.petable if
91%                                               % necessary.
92%
93%        'sorting'      : [ 'off' | {'on'} ]    % 'off' =disable k-space
94%                                               % sorting, i.e. ignore the
95%                                               % phase table and/or arrays.
96%                                               % 'on' =sort k-space using
97%                                               % phase table and/or array
98%                                               % information if necessary
99%                                               % (default)
100%
101%        'wbar'        : [ {'on'} | 'off' ]     % 'on'  = show waitbar
102%                                               % 'off' = don't show waitbar
103%
104%        'FlipKspace'  : [ {'off'} | 'LR' |
105%                             'UD' | 'LRUD' ]   % 'off' = don't flip (default)
106%                                               % 'LR' = left/right
107%                                               % 'UD' = up/down
108%                                               % 'LRUD' = left/right and
109%                                               % up/down
110%
111%        'FlipInd'     : [ {'all'} | 'alt' |
112%                          (custom vector)  ]   % 'all' = flip all slices
113%                                               % (default)
114%                                               % 'alt' = flip every
115%                                               % second slice
116%                                               % (custom vector) = A
117%                                               % custom vector containing
118%                                               % indices to the flipped slices
119%
120%        'Precision'   : ['single'|{'double'}]  % Precision of the
121%                                               % outputted data.
122%                                               % 'single' = 32-bit float
123%                                               % 'double' = 64-bit float
124%
125%        'OrientImages': [ {'on'} | 'off' ]     % Orient FTDATA after
126%                                               % reading the data using
127%                                               % PROCPAR.orient property.
128%
129%        'RemoveEPIphaseIm' : ['on'|{'off'}]    % Remove the phase image
130%                                               % from EPI data. This
131%                                               % option only affects EPI
132%                                               % images.
133%
134% Examples:
135%        [DATA,msg]=aedes_readfid(filename)             % Read image data from 'filename'
136%        [DATA,msg]=aedes_readfid(filename,'header')    % Read only data file header
137%
138%        [DATA,msg]=aedes_readfid(filename,'return',1)  % Return only image data (default)
139%        [DATA,msg]=aedes_readfid(filename,'return',2)  % Return only k-space
140%        [DATA,msg]=aedes_readfid(filename,'return',3)  % Return both image data and k-space
141%       
142%        % Read first data file header and then image data and k-space
143%        [DATA,msg]=aedes_readfid(filename,'header')
144%        [DATA,msg]=aedes_readfid(DATA.HDR,'return',3)
145%
146%        % Read VNMR-data with default options and save slices in NIfTI
147%        % format
148%        DATA=aedes_readfid('example.fid','saved_slices.nii');
149%
150%        % If you want to use non-default options and also write
151%        % NIfTI-files, use the property/value formalism, for example
152%        DATA=aedes_readfid('example.fid','ZeroPadding','off',...
153%                     'OutputFile','saved_slices.nii');
154%
155% See also:
156%        AEDES_READFIDPREFS, AEDES_READPROCPAR, AEDES_READPHASETABLE,
157%        AEDES_DATA_READ, AEDES_WRITE_NIFTI, AEDES
158
159% This function is a part of Aedes - A graphical tool for analyzing
160% medical images
161%
162% Copyright (C) 2006 Juha-Pekka Niskanen <Juha-Pekka.Niskanen@uku.fi>
163%
164% Department of Physics, Department of Neurobiology
165% University of Kuopio, FINLAND
166%
167% This program may be used under the terms of the GNU General Public
168% License version 2.0 as published by the Free Software Foundation
169% and appearing in the file LICENSE.TXT included in the packaging of
170% this program.
171%
172% This program is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
173% WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
174
175
176
177
178if nargout==2
179  Dat.ShowErrors = false;
180  msg_out='';
181else
182  Dat.ShowErrors = true;
183end
184
185%% ---------------------
186% Defaults
187Dat.ReturnKSpace  = false;
188Dat.ReturnFTData  = true;
189Dat.DCcorrection  = false;
190Dat.ZeroPadding = 2;
191Dat.Sorting = true;
192Dat.UsePhaseTable = true;
193Dat.FastDataRead = true;
194Dat.precision = 'single';
195
196
197%% Other defaults
198Dat.ShowWaitbar   = true;
199procpar=[];
200Dat.phasetable=[];
201Dat.FlipKspace = 0;
202Dat.FlipInd = 'all';
203Dat.OutputFile = false;
204Dat.ReturnRawKspace = false;
205Dat.ReorientEPI = false;
206Dat.RemoveEPIphaseIm = false;
207Dat.OrientImages = true;
208
209%% -------------------------------------------------------------------
210
211
212%% Set data format label
213DATA.DataFormat = 'vnmr';
214
215%% Parse input arguments
216if nargin==0 || isempty(filename)
217 
218  %% Get default directory
219  try
220    defaultdir = getpref('Aedes','GetDataFileDir');
221  catch
222    defaultdir = [pwd,filesep];
223  end
224 
225  %% If no input arguments are given, ask for a file
226  [f_name, f_path, f_index] = uigetfile( ...
227       {'fid;FID','Varian FID-files (fid)'; ...
228        '*.*', 'All Files (*.*)'}, ...
229        'Select VNMR (Varian) FID file',defaultdir);
230  if ( all(f_name==0) || all(f_path==0) ) % Cancel is pressed
231    DATA=[];
232    msg_out='Canceled';
233    return
234  end
235  ReadHdr = true;
236  ReadData = true;
237  filename=[f_path,f_name];
238 
239  %% Set default directory to preferences
240  setpref('Aedes','GetDataFileDir',f_path)
241 
242end
243
244if nargin==1
245  if isstruct(filename)
246    hdr = filename;
247    filename = [hdr.fpath,hdr.fname];
248    ReadHdr = false;
249    ReadData = true;
250% $$$     ReturnKSpace = false;
251% $$$     ReturnFTData = true;
252   
253  elseif ischar(filename)
254    ReadHdr = true;
255    ReadData = true;
256% $$$     ReturnKSpace = false;
257% $$$     ReturnFTData = true;
258  end
259elseif nargin==2
260  if strcmpi(varargin{1},'header')
261    ReadHdr = true;
262    ReadData = false;
263% $$$     ReturnKSpace = false;
264  elseif ischar(varargin{1})
265    ReadHdr = true;
266    ReadData = true;
267    Dat.OutputFile = varargin{1};
268  else
269    if ~Dat.ShowErrors
270      DATA=[];
271      msg_out=sprintf('Invalid second input argument "%s".',varargin{1});
272      return
273    else
274      error('Invalid second input argument "%s".',varargin{1})
275    end
276  end
277else
278  if isstruct(filename)
279    hdr = filename;
280    filename = [hdr.fpath,hdr.fname];
281    ReadHdr = false;
282    ReadData = true;
283  elseif isempty(filename)
284    [f_name, f_path, f_index] = uigetfile( ...
285        {'fid;FID','Varian FID-files (fid)'; ...
286         '*.*', 'All Files (*.*)'}, ...
287        'Select VNMR (Varian) FID file');
288    if ( all(f_name==0) || all(f_path==0) ) % Cancel is pressed
289      DATA=[];
290      msg_out='Canceled';
291      return
292    end
293    ReadHdr = true;
294    ReadData = true;
295    filename=[f_path,f_name];
296  else
297    ReadHdr = true;
298    ReadData = true;
299  end
300 
301  for ii=1:2:length(varargin)
302    switch lower(varargin{ii})
303     case 'return'
304      if length(varargin)<2
305        DATA=[];
306        if ~Dat.ShowErrors
307          msg_out='"Return" value not specified!';
308        else
309          error('"Return" value not specified!')
310        end
311        return
312      else
313        if varargin{ii+1}==1
314          Dat.ReturnKSpace = false;
315          Dat.ReturnFTData = true;
316        elseif varargin{ii+1}==2
317          Dat.ReturnKSpace = true;
318          Dat.ReturnFTData = false;
319        elseif varargin{ii+1}==3
320          Dat.ReturnKSpace = true;
321          Dat.ReturnFTData = true;
322                elseif varargin{ii+1}==4
323                  Dat.ReturnRawKspace = true;
324                  Dat.ReturnKSpace = true;
325          Dat.ReturnFTData = false;
326        end
327      end
328     
329     case {'dc','dccorrection','dccorr'}
330      if strcmpi(varargin{ii+1},'on')
331        Dat.DCcorrection = true;
332      else
333        Dat.DCcorrection = false;
334      end
335     
336     case 'procpar'
337      procpar=varargin{ii+1};
338     
339     case 'zeropadding'
340      if ischar(varargin{ii+1})
341        if strcmpi(varargin{ii+1},'on')
342          Dat.ZeroPadding = 1; % on
343        elseif strcmpi(varargin{ii+1},'off')
344          Dat.ZeroPadding = 0; % off
345        else
346          Dat.ZeroPadding = 2; % auto
347        end
348      else
349        % Undocumented
350        Dat.ZeroPadding = 3; % Custom
351        Dat.CustomZeroPadding = varargin{ii+1};
352      end
353     
354     case 'phasetable'
355      Dat.phasetable = varargin{ii+1};
356     
357     case 'sorting'
358          if strcmpi(varargin{ii+1},'on')
359        Dat.UsePhaseTable = true;
360        Dat.Sorting = true;
361      else
362        Dat.UsePhaseTable = false;
363        Dat.Sorting = false;
364          end
365     
366         case 'fastread'
367           if strcmpi(varargin{ii+1},'on')
368                 Dat.FastDataRead = true;
369           else
370                 Dat.FastDataRead = false;
371           end
372           
373     case 'wbar'
374      if strcmpi(varargin{ii+1},'on')
375        Dat.ShowWaitbar = 1;
376      else
377        Dat.ShowWaitbar = 0;
378          end
379         
380         case 'precision'
381           if strcmpi(varargin{ii+1},'single')
382                 Dat.precision = 'single';
383           end
384               
385          case 'flipkspace'
386       
387        flipkspace = varargin{ii+1};
388        if strcmpi(flipkspace,'off')
389          Dat.FlipKspace=0;
390        elseif strcmpi(flipkspace,'LR')
391          Dat.FlipKspace=1;
392        elseif strcmpi(flipkspace,'UD')
393          Dat.FlipKspace=2;
394        elseif strcmpi(flipkspace,'LRUD')
395          Dat.FlipKspace=3;
396        else
397          DATA=[];
398          if ~Dat.ShowErrors
399            msg_out = 'Bad value for property FlipKspace!';
400          else
401            error('Bad value for property FlipKspace!')
402          end
403          return
404        end
405       
406      case 'flipind'
407        Dat.FlipInd = varargin{ii+1};
408       
409      case 'outputfile'
410        Dat.OutputFile = varargin{ii+1};
411       
412      case 'reorientepi'
413        if strcmpi(varargin{ii+1},'on')
414          Dat.ReorientEPI = true;
415        end
416       
417      case 'removeepiphaseim'
418        if strcmpi(varargin{ii+1},'on')
419          Dat.RemoveEPIphaseIm = true;
420        end
421      case 'orientimages'
422        if strcmpi(varargin{ii+1},'off')
423          Dat.OrientImages = false;
424        end
425     otherwise
426      DATA=[];
427      if ~Dat.ShowErrors
428        msg_out = ['Unknown property "' varargin{ii} '"'];
429      else
430        error(['Unknown property "' varargin{ii} '"'])
431      end
432      return
433    end
434  end
435end
436
437% Parse filename
438[fpath,fname,fext]=fileparts(filename);
439if ~strcmpi(fname,'fid')
440  if isempty(fname)
441    fpath = [fpath,filesep];
442  else
443        if isempty(fpath)
444          fpath = [pwd,filesep,fname,fext,filesep];
445        else
446          fpath = [fpath,filesep,fname,fext,filesep];
447        end
448  end
449  fname = 'fid';
450else
451  fpath = [fpath,filesep];
452end
453
454%% Read procpar if not given as input argument
455if isempty(procpar) || nargin~=2
456  [procpar,proc_msg]=aedes_readprocpar([fpath,'procpar']);
457  if isempty(procpar)
458    DATA=[];
459    if ~Dat.ShowErrors
460      msg_out=proc_msg;
461    else
462      error(proc_msg)
463    end
464    return
465  end
466end
467
468%% Read phasetable if necessary
469if isfield(procpar,'petable') && isempty(Dat.phasetable) && ...
470    ~isempty(procpar.petable{1}) && ~strcmpi(procpar.petable{1},'n') && ...
471    Dat.Sorting
472  % Look in preferences for tablib-directory
473  try
474    tabpath = getpref('Aedes','TabLibDir');
475  catch
476    % If the table path was not found in preferences, try to use aedes
477    % directory
478    tmp_path = which('aedes');
479    if ~isempty(tmp_path)
480      aedes_path=fileparts(tmp_path);
481      tabpath = [aedes_path,filesep,'tablib',filesep];
482    else
483      % If all else fails, look in the current directory
484      tabpath = [pwd,filesep,'tablib',filesep];
485    end
486  end
487  [phasetable,msg] = aedes_readphasetable([tabpath,procpar.petable{1}]);
488 
489  % If petable cannot be found, check if it is in procpar...
490  if isempty(phasetable) && isfield(procpar,'pe_table')
491    phasetable = {'t1',procpar.pe_table(:)};
492  end
493 
494  % If the sequence is a fast spin echo, try to construct the phasetable
495  if isempty(phasetable) && isfield(procpar,'petable') && ...
496      strncmpi(procpar.petable{1},'fse',3)
497    phasetable = {'t1',l_CreateFsemsPhaseTable(procpar)};
498  end
499 
500  %% Abort and throw error if phasetable cannot be read and the FID-file
501  % has not been sorted
502  if isempty(phasetable) && ~isfield(procpar,'flash_converted')
503    DATA=[];
504    if ~Dat.ShowErrors
505      msg_out={['Could not find the required phase table "' ...
506                procpar.petable{1} '" in the following folders'],...
507               ['"' tabpath '".']};
508    else
509      error('Could not find the required phase table "%s" in %s',...
510            procpar.petable{1},tabpath)
511    end
512    return
513  elseif ( isempty(phasetable) && isfield(procpar,'flash_converted') ) || ...
514      ~Dat.UsePhaseTable
515    %% If the FID-file has been sorted, the reading can continue but
516    % throw a warning.
517    fprintf(1,'Warning: aedes_readfid: Could not find phasetable "%s" in "%s"!\n',procpar.petable{1},tabpath)
518    Dat.phasetable=[];
519  else
520    Dat.phasetable = phasetable{1,2};
521  end
522end
523
524% Convert phasetable indices to MATLAB indices
525if ~isempty(Dat.phasetable)
526  Dat.phasetable=Dat.phasetable+(-min(min(Dat.phasetable))+1);
527else
528  Dat.UsePhaseTable = false;
529end
530
531%% Open FID-file
532[file_fid,msg]=fopen([fpath,fname],'r','ieee-be');
533if file_fid < 0
534  DATA=[];
535  if ~Dat.ShowErrors
536    msg_out=['Could not open file "' filename '" for reading.'];
537  else
538    error('Could not open file "%s" for reading.',filename)
539  end
540  return
541end
542
543% Read only header
544if ReadHdr && ~ReadData
545  [hdr,msg_out]=l_ReadDataFileHeader(file_fid);
546  if ~isempty(msg_out)
547    DATA=[];
548    fclose(file_fid);
549    if Dat.ShowErrors
550      error(msg_out)
551    end
552    return
553  else
554    DATA.HDR.FileHeader = hdr.FileHeader;
555    DATA.FTDATA=[];
556    DATA.KSPACE=[];
557    DATA.PROCPAR=[];
558    DATA.PHASETABLE=[];
559  end
560elseif ~ReadHdr && ReadData % Header structure given as input argument
561                            % Read only data.
562  [hdr,data,kspace,msg_out]=l_ReadBlockData(file_fid,hdr,Dat,procpar);
563  if ~isempty(msg_out)
564    DATA=[];
565    fclose(file_fid);
566    if Dat.ShowErrors
567      error(msg_out)
568    end
569    return
570  else
571    DATA.HDR.FileHeader=hdr.FileHeader;
572    DATA.HDR.BlockHeaders = hdr.BlockHeaders;
573    DATA.FTDATA=data;
574    DATA.KSPACE=kspace;
575    DATA.PROCPAR=procpar;
576    DATA.PHASETABLE=Dat.phasetable;
577  end
578elseif ReadHdr && ReadData  % Read headers and data
579  [hdr,msg_out]=l_ReadDataFileHeader(file_fid);
580  [hdr,data,kspace,msg_out]=l_ReadBlockData(file_fid,hdr,Dat,procpar);
581  if ~isempty(msg_out)
582    DATA=[];
583    fclose(file_fid);
584    if Dat.ShowErrors
585      error(msg_out)
586    end
587    return
588  else
589    DATA.HDR.FileHeader=hdr.FileHeader;
590    DATA.HDR.BlockHeaders = hdr.BlockHeaders;
591    DATA.FTDATA=data;
592    DATA.KSPACE=kspace;
593    DATA.PROCPAR=procpar;
594    DATA.PHASETABLE=Dat.phasetable;
595  end
596end
597
598% Set file name and path to the HDR structure
599DATA.HDR.fname=fname;
600DATA.HDR.fpath=fpath;
601
602% Set parameter values
603DATA.HDR.Param.ReturnKSpace = Dat.ReturnKSpace;
604DATA.HDR.Param.ReturnFTData = Dat.ReturnFTData;
605if Dat.ZeroPadding==0
606  DATA.HDR.Param.ZeroPadding = 'off';
607elseif Dat.ZeroPadding==1
608  DATA.HDR.Param.ZeroPadding = 'on';
609else
610  DATA.HDR.Param.ZeroPadding = 'auto';
611end
612if ~Dat.DCcorrection
613  DATA.HDR.Param.DCcorrection = 'off';
614else
615  DATA.HDR.Param.DCcorrection = 'on';
616end
617if Dat.Sorting==0
618  DATA.HDR.Param.Sorting = 'off';
619else
620  DATA.HDR.Param.Sorting = 'on';
621end
622if Dat.FlipKspace==0
623  DATA.HDR.Param.FlipKspace = 'off';
624elseif Dat.FlipKspace==1
625  DATA.HDR.Param.FlipKspace = 'LR';
626elseif Dat.FlipKspace==2
627  DATA.HDR.Param.FlipKspace = 'UD';
628elseif Dat.FlipKspace==3
629  DATA.HDR.Param.FlipKspace = 'LRUD';
630end
631DATA.HDR.Param.FlipInd = Dat.FlipInd;
632
633
634% Close file
635fclose(file_fid);
636
637%% Write slices to NIfTI files
638if ischar(Dat.OutputFile)
639  if isempty(Dat.OutputFile)
640    [fp,fn,fe]=fileparts(DATA.HDR.fpath(1:end-1));
641    fprefix=fn;
642    niipath = [pwd,filesep];
643  else
644    [fp,fn,fe]=fileparts(Dat.OutputFile);
645    if strcmpi(fe,'.nii')
646      fprefix=fn;
647    else
648      fprefix=[fn,fe];
649    end
650    if isempty(fp)
651      niipath = [pwd,filesep];
652    else
653      niipath = [fp,filesep];
654    end
655  end
656 
657  % Create file names
658  filenames={};
659  for ii=1:size(DATA.FTDATA,3)
660    filenames{ii}=sprintf('%s%03d%s',[fprefix,'_'],ii,'.nii');
661  end
662  nFiles = length(filenames);
663   
664  h=aedes_wbar(0,sprintf('Saving slice 1/%d in NIfTI format...',nFiles));
665  for ii=1:nFiles
666    aedes_wbar(ii/nFiles,h,sprintf('Saving slice %d/%d in NIfTI format...',ii, ...
667                             nFiles))
668    [done,msg]=aedes_write_nifti(DATA.FTDATA(:,:,ii),...
669                           [niipath,filenames{ii}],'DataType','single',...
670                           'FileType',2);
671  end
672  delete(h)
673 
674  if ~done
675    warning('Error occurred while writing NIfTI-files. Could not write file(s)!')
676  end
677 
678end
679return
680
681%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
682% Read Data File (Main) Header
683%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
684function [hdr,msg_out]=l_ReadDataFileHeader(file_fid)
685
686msg_out='';
687%% Read Data File Header
688try
689  FH.nblocks = fread(file_fid,1,'long');   % Number of blocks in file
690  FH.ntraces = fread(file_fid,1,'long');   % Number of traces per block
691  FH.np = fread(file_fid,1,'long');        % Number of elements per trace
692  FH.ebytes = fread(file_fid,1,'long');    % Number of bytes per element
693  FH.tbytes = fread(file_fid,1,'long');    % Number of bytes per trace
694  FH.bbytes = fread(file_fid,1,'long');    % Number of bytes per block
695  FH.vers_id = fread(file_fid,1,'short');  % Software version, file_id status bits
696  FH.status = fread(file_fid,1,'short');   % Status of whole file
697  FH.nbheaders = fread(file_fid,1,'long'); % Number of block headers per block
698 
699  hdr.FileHeader = FH;
700 
701  %% Parse status bits
702  hdr.FileHeader.status=[];
703  tmp_str = {'S_DATA',...          % 0 = no data, 1 = data
704             'S_SPEC',...          % 0 = FID, 1 = spectrum
705             'S_32',...            % 0 = 16 bit, 1 = 32 bit integer
706             'S_FLOAT',...         % 0 = integer, 1 = floating point
707             'S_COMPLEX',...       % 0 = real, 1 = complex
708             'S_HYPERCOMPLEX',...  % 1 = hypercomplex
709             '',...                % Unused bit
710             'S_ACQPAR',...        % 0 = not Acqpar, 1 = Acqpar
711             'S_SECND',...         % 0 = first FT, 1 = second FT
712             'S_TRANSF',...        % 0 = regular, 1 = transposed
713             '',...                % Unused bit
714             'S_NP',...            % 1 = np dimension is active
715             'S_NF',...            % 1 = nf dimension is active
716             'S_NI',...            % 1 = ni dimension is active
717             'S_NI2',...           % 1 = ni2 dimension is active
718             ''...                 % Unused bit
719            };
720  status_bits = fliplr(double(dec2bin(FH.status,16))==49);
721  for ii=1:length(tmp_str)
722    if ~isempty(tmp_str{ii})
723      hdr.FileHeader.status.(tmp_str{ii}) = status_bits(ii);
724    end
725  end
726catch
727  hdr=[];
728  msg_out=['Error occurred while reading file header from "' filename '".'];
729  return
730end
731
732
733%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
734% Read Block Headers and Data
735%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
736function [hdr,data,kspace,msg_out]=l_ReadBlockData(file_fid,hdr,Dat,procpar)
737
738hdr.BlockHeaders = [];
739%hdr.HypercmplxBHeaders = [];
740data=[];
741kspace=[];
742count = [];
743msg_out='';
744
745if isfield(procpar,'seqcon')
746  procpar.seqcon=procpar.seqcon{1};
747else
748  procpar.seqcon='nnnnn';
749end
750
751%% Determine acquisition type from seqcon parameter
752if all(procpar.seqcon=='n')          % 1D spectroscopy
753  Dat.AcqType=1;
754elseif all(procpar.seqcon(4:5)=='n') % 2D imaging
755  Dat.AcqType=2;
756elseif procpar.seqcon(5)=='n'        % 3D imaging
757  Dat.AcqType=3;
758else                         % 4D imaging
759  Dat.AcqType=4;
760end
761
762%% Double-check that AcqType is not 1D spectral
763if isfield(procpar,'nv') && procpar.nv==0
764  Dat.AcqType=1;
765end
766
767%% Use some heuristical approach to "triple-check" that the data is not
768%  1D spectral
769if ~isempty(strfind(procpar.seqfil{1},'STEAM')) || ...
770      ~isempty(strfind(procpar.seqfil{1},'steam')) || ...
771      ~isempty(strfind(procpar.seqfil{1},'LASER')) || ...
772      ~isempty(strfind(procpar.seqfil{1},'laser')) || ...
773      ~isempty(strfind(procpar.seqfil{1},'PRESS')) || ...
774      ~isempty(strfind(procpar.seqfil{1},'press')) || ...
775      ~isempty(strfind(procpar.seqfil{1},'1PULSE')) || ...
776      ~isempty(strfind(procpar.seqfil{1},'1pulse')) || ...
777      ~isempty(strfind(procpar.seqfil{1},'2PULSE')) || ...
778      ~isempty(strfind(procpar.seqfil{1},'2pulse'))
779  Dat.AcqType=1;
780end
781
782UsePhaseTable=Dat.UsePhaseTable;
783
784
785%% If the data has been converted with flashc, the seqcon parameter needs
786% to be changed
787if isfield(procpar,'flash_converted')
788  if isfield(procpar,'ni') && procpar.ni>1
789    procpar.seqcon(3)='s';
790  elseif ((procpar.seqcon(2)=='c') && (procpar.seqcon(3)=='c'))
791    procpar.seqcon(2)='s';
792  end
793  UsePhaseTable=false; % Do not try to order data if flashc has been run
794end
795
796%% Set number of transients
797if ~isfield(procpar,'nt')
798  nt=1;
799else
800  nt=procpar.nt;
801end
802
803%% Determine if the arrayed acquisition was used
804if isfield(procpar,'array') && ~isempty(procpar.array{1})
805 
806  if length(procpar.array)==1 && ~iscell(procpar.array{1}) && ...
807      strcmp(procpar.array{1},'pad') && all(procpar.pad==0)
808    % Skip the array parsing if the array is a dummy "pad"-array...
809    Dat.isAcqArrayed = false;
810    Dat.ArrayLength = 1;
811  else
812    Dat.isAcqArrayed = true;
813    Dat.ArrayLength = [];
814   
815    % Determine array length
816    for ii=1:length(procpar.array)
817      if iscell(procpar.array{ii})
818        Dat.ArrayLength(ii) = length(procpar.(procpar.array{ii}{1}));
819      else
820        Dat.ArrayLength(ii) = length(procpar.(procpar.array{ii}));
821      end
822    end
823    Dat.ArrayLength = prod(Dat.ArrayLength);
824  end
825else
826  Dat.isAcqArrayed = false;
827  Dat.ArrayLength = 1;
828end
829
830%% Determine if the data is EPI data
831if ( isfield(procpar,'readres') && isfield(procpar,'phaseres') ) || ...
832    ( isfield(procpar,'apptype') && strcmp(procpar.apptype{1},'imEPI') )
833  Dat.isEPIdata = true;
834else
835  Dat.isEPIdata = false;
836end
837
838BlockHeadStatusLabels = {'S_DATA',...       % 0 = no data, 1 = data
839                    'S_SPEC',...          % 0 = FID, 1 = spectrum
840                    'S_32',...            % 0 = 16 bit, 1 = 32 bit integer
841                    'S_FLOAT',...         % 0 = integer, 1 = floating point
842                    'S_COMPLEX',...       % 0 = real, 1 = complex
843                    'S_HYPERCOMPLEX',...  % 1 = hypercomplex
844                    '',...                % Unused bit
845                    'MORE_BLOCKS',...     % 0 = absent, 1 = present
846                    'NP_CMPLX',...        % 0 = real, 1 = complex
847                    'NF_CMPLX',...        % 0 = real, 1 = complex
848                    'NI_CMPLX',...        % 0 = real, 1 = complex
849                    'NI2_CMPLX',...       % 0 = real, 1 = complex
850                    '',...                % Unused bit
851                    '',...                % Unused bit
852                    '',...                % Unuesd bit
853                    ''...                 % Unused bit
854                   };
855
856BlockHeadModeLabels = {'NP_PHMODE',...   % 1 = ph mode
857                    'NP_AVMODE',...    % 1 = av mode
858                    'NP_PWRMODE',...   % 1 = pwr mode
859                    '',...             % Unused bit
860                    'NF_PHMODE',...    % 1 = ph mode
861                    'NF_AVMODE',...    % 1 = av mode
862                    'NF_PWRMODE',...   % 1 = pwr mode
863                    '',...             % Unused bit
864                    'NI_PHMODE',...    % 1 = ph mode
865                    'NI_AVMODE',...    % 1 = av mode
866                    'NI_PWRMODE',...   % 1 = pwr mode
867                    '',...             % Unused bit
868                    'NI2_PHMODE',...   % 1 = ph mode
869                    'NI2_AVMODE',...   % 1 = av mode
870                    'NI2_PWRMODE',...  % 1 = pwr mode
871                    ''...              % Unused bit
872                   };
873
874
875% The nbheaders -field is not correct in some cases. Thus, this field
876% cannot be trusted and the real nbheaders has to be calculated from the
877% byte counts.
878tmp_bytes=hdr.FileHeader.bbytes-hdr.FileHeader.tbytes*hdr.FileHeader.ntraces;
879header_bytes=28;
880if rem(tmp_bytes,header_bytes)~=0
881  msg_out = 'Block header byte count does not match with file header';
882  return
883else
884  nbheaders = tmp_bytes/28;
885end
886%nbheaders = hdr.FileHeader.nbheaders;
887
888%% Allocate space for k-space
889% kspace=zeros(hdr.FileHeader.np/2,...
890%              hdr.FileHeader.ntraces,hdr.FileHeader.nblocks);
891
892if ~Dat.FastDataRead
893  if any(Dat.AcqType==[1 2])
894    switch procpar.seqcon(2:3)
895      case {'cc','sc'}
896        kspace = zeros(hdr.FileHeader.np/2,...
897          hdr.FileHeader.ntraces,...
898          hdr.FileHeader.nblocks,Dat.precision);
899      otherwise
900        kspace = zeros(hdr.FileHeader.np/2,...
901          hdr.FileHeader.nblocks,...
902          hdr.FileHeader.ntraces,Dat.precision);
903    end
904  else
905    kspace = zeros(hdr.FileHeader.np/2,...
906      hdr.FileHeader.ntraces,...
907      hdr.FileHeader.nblocks,Dat.precision);
908  end
909else
910  kspace = [];
911end
912
913%% - The older robust (but also slower) way for reading the data.
914%% When the blocksize is relatively small, this is also quite fast.
915if ~Dat.FastDataRead
916
917  % Initialize waitbar
918  if Dat.ShowWaitbar
919        wb_h = aedes_wbar(0/hdr.FileHeader.nblocks,...
920          {['Reading ',num2str(Dat.AcqType),'D VNMR data (seqcon: "' procpar.seqcon '")'],...
921          ['(Processing data block ' ...
922          num2str(0) '/' num2str(hdr.FileHeader.nblocks) ')']});
923  end
924
925  %% Read data and block headers
926  for ii=1:hdr.FileHeader.nblocks
927        %% Update waitbar
928        if Dat.ShowWaitbar
929          aedes_wbar(ii/hdr.FileHeader.nblocks,...
930                wb_h,...
931                {['Reading ',num2str(Dat.AcqType),'D VNMR data (seqcon: "' procpar.seqcon '")'],...
932                ['(Processing data block ' ...
933                num2str(ii) '/' num2str(hdr.FileHeader.nblocks) ')']})
934        end
935
936        %% Read block header and hypercomplex header
937        for kk=1:nbheaders
938          %% Read block header
939          if kk==1
940                hdr.BlockHeaders.scale = fread(file_fid,1,'short');  % Scaling factor
941                tmp_status = fread(file_fid,1,'short'); % Status of data in block
942                hdr.BlockHeaders.status = [];
943                hdr.BlockHeaders.index = fread(file_fid,1,'short');  % Block index
944                tmp_mode = fread(file_fid,1,'short');   % Mode of data in block
945                hdr.BlockHeaders.mode = [];
946                hdr.BlockHeaders.ctcount = fread(file_fid,1,'long'); % ct value for FID
947                hdr.BlockHeaders.lpval = fread(file_fid,1,'float');  % f2 (2D-f1) left phase in phasefile
948                hdr.BlockHeaders.rpval = fread(file_fid,1,'float');  % f2 (2D-f1) right phase in phasefile
949                hdr.BlockHeaders.lvl = fread(file_fid,1,'float');    % level drift correction
950                hdr.BlockHeaders.tlt = fread(file_fid,1,'float');    % tilt drift correction
951
952                %% Parse status and mode bits
953                status_bits = fliplr(double(dec2bin(tmp_status,16))==49);
954                mode_bits = fliplr(double(dec2bin(tmp_mode,16))==49);
955                for tt=1:length(BlockHeadStatusLabels)
956                  if ~isempty(BlockHeadStatusLabels{tt})
957                        hdr.BlockHeaders.status.(BlockHeadStatusLabels{tt}) = status_bits(tt);
958                  end
959                  if ~isempty(BlockHeadModeLabels{tt})
960                        hdr.BlockHeaders.mode.(BlockHeadModeLabels{tt}) = mode_bits(tt);
961                  end
962                end
963
964
965          else %% Read hypercomplex header
966                fread(file_fid,1,'short'); % Spare
967                hdr.BlockHeaders.HCHstatus = fread(file_fid,1,'short');
968                fread(file_fid,1,'short'); % Spare
969                fread(file_fid,1,'short'); % Spare
970                fread(file_fid,1,'long'); % Spare
971                hdr.BlockHeaders.HCHlpval1 = fread(file_fid,1,'float');
972                hdr.BlockHeaders.HCHrpval1 = fread(file_fid,1,'float');
973                fread(file_fid,1,'float'); % Spare
974                fread(file_fid,1,'float'); % Spare
975          end
976        end
977       
978        %% Check block index to be sure about the data type
979        if hdr.BlockHeaders.index~=ii
980          fprintf(1,'Warning: Index mismatch in "%s" block %d\n',fopen(file_fid),ii);
981         
982          % Use information from the file header instead of the BlockHeader if
983          % there is a mismatch in blockheader index...
984          useFileHeader = true;
985        else
986          useFileHeader = false;
987        end
988       
989        %% Determine data precision
990        if useFileHeader
991          if hdr.FileHeader.status.S_FLOAT==1
992                prec_str = ['single=>',Dat.precision];
993          elseif hdr.FileHeader.status.S_32==1 ...
994                  && hdr.FileHeader.status.S_FLOAT==0
995                prec_str = ['int32=>',Dat.precision];
996          elseif hdr.FileHeader.status.S_32==0 ...
997                  && hdr.FileHeader.status.S_FLOAT==0
998                prec_str = ['int16=>',Dat.precision];
999          end
1000         
1001        else
1002          if hdr.BlockHeaders.status.S_FLOAT==1
1003                prec_str = ['single=>',Dat.precision];
1004          elseif hdr.BlockHeaders.status.S_32==1 ...
1005                  && hdr.BlockHeaders.status.S_FLOAT==0
1006                prec_str = ['int32=>',Dat.precision];
1007          elseif hdr.BlockHeaders.status.S_32==0 ...
1008                  && hdr.BlockHeaders.status.S_FLOAT==0
1009                prec_str = ['int16=>',Dat.precision];
1010          end
1011        end
1012
1013        % Read k-space
1014        tmp=fread(file_fid,...
1015          [hdr.FileHeader.np,hdr.FileHeader.ntraces],...
1016          prec_str);
1017
1018
1019        % Store complex block and perform DC correction
1020        if ~Dat.DCcorrection || ( nt(1)>1 )
1021          complex_block = complex(tmp(1:2:end,:),tmp(2:2:end,:));
1022        else
1023          complex_block = complex(tmp(1:2:end,:)-hdr.BlockHeaders.lvl,...
1024                tmp(2:2:end,:)-hdr.BlockHeaders.tlt);
1025        end
1026
1027
1028        %% Store and order k-space values
1029        if any(Dat.AcqType==[1 2])
1030          switch procpar.seqcon(2:3)
1031                case {'cc','sc'}
1032                  kspace(:,:,ii) = complex_block;
1033                otherwise
1034                  kspace(:,ii,:) = complex_block;
1035          end
1036        else
1037          kspace(:,:,ii) = complex_block;
1038        end
1039
1040        % Do not save blockheaders by default. When reading data files with a lot of
1041        % blocks (e.g. over 1000) the processing of the DATA structure can be
1042        % slowed down considerably. If you for some reason want to save also the
1043        % block headers in the DATA structure comment out the code line below.
1044        hdr.BlockHeaders = [];
1045  end % for ii=1:hdr.
1046
1047  if Dat.ShowWaitbar
1048        delete(wb_h)
1049  end
1050 
1051else
1052  %% -------------------------------------------------------------------
1053  %% Fast Method for reading data. This may fail with some datas and can
1054  %% also require a relatively large amount of memory. This
1055  %% method should be used for EPI datas that contain a large number
1056  %% of block headers...
1057 
1058  % Check the size of the FID-file
1059  d=dir(fopen(file_fid));
1060  file_sz = d.bytes/1024/1024; % File size in MB
1061  nBlocks = ceil(file_sz/500); % Read data in 500 MB blocks
1062 
1063  % Initialize waitbar
1064  if Dat.ShowWaitbar
1065        wb_h = aedes_calc_wait(['Reading ',num2str(Dat.AcqType),...
1066          'D VNMR data (seqcon: "' procpar.seqcon '")']);
1067  end
1068 
1069  % The first block header is read and it is assumed that the values in
1070  % the other block headers don't change. 
1071  hdr.BlockHeaders.scale = fread(file_fid,1,'short');  % Scaling factor
1072  tmp_status = fread(file_fid,1,'short'); % Status of data in block
1073  hdr.BlockHeaders.status = [];
1074  hdr.BlockHeaders.index = fread(file_fid,1,'short');  % Block index
1075  tmp_mode = fread(file_fid,1,'short');   % Mode of data in block
1076  hdr.BlockHeaders.mode = [];
1077  hdr.BlockHeaders.ctcount = fread(file_fid,1,'long'); % ct value for FID
1078  hdr.BlockHeaders.lpval = fread(file_fid,1,'float');  % f2 (2D-f1) left phase in phasefile
1079  hdr.BlockHeaders.rpval = fread(file_fid,1,'float');  % f2 (2D-f1) right phase in phasefile
1080  hdr.BlockHeaders.lvl = fread(file_fid,1,'float');    % level drift correction
1081  hdr.BlockHeaders.tlt = fread(file_fid,1,'float');    % tilt drift correction
1082 
1083  %% Parse status and mode bits
1084  status_bits = fliplr(double(dec2bin(tmp_status,16))==49);
1085  mode_bits = fliplr(double(dec2bin(tmp_mode,16))==49);
1086  for tt=1:length(BlockHeadStatusLabels)
1087    if ~isempty(BlockHeadStatusLabels{tt})
1088      hdr.BlockHeaders.status.(BlockHeadStatusLabels{tt}) = status_bits(tt);
1089    end
1090    if ~isempty(BlockHeadModeLabels{tt})
1091      hdr.BlockHeaders.mode.(BlockHeadModeLabels{tt}) = mode_bits(tt);
1092    end
1093  end
1094 
1095  %% Determine data precision
1096  if hdr.BlockHeaders.status.S_FLOAT==1
1097    prec_str = ['single=>',Dat.precision];
1098    prec = 4; % Precision in bytes
1099  elseif hdr.BlockHeaders.status.S_32==1 ...
1100      && hdr.BlockHeaders.status.S_FLOAT==0
1101    prec_str = ['int32=>',Dat.precision];
1102    prec = 4;
1103  elseif hdr.BlockHeaders.status.S_32==0 ...
1104      && hdr.BlockHeaders.status.S_FLOAT==0
1105    prec_str = ['int16=>',Dat.precision];
1106    prec = 2;
1107  end
1108 
1109  % Seek the file back to the beginning of the first block header
1110  fseek(file_fid,-28,0);
1111 
1112  % Determine the number of values that will result from block header(s)
1113  nVals = (nbheaders*28)/prec;
1114 
1115 
1116 
1117  % Read the whole data including block headers etc...
1118  kspace = fread(file_fid,inf,prec_str);
1119  kspace=reshape(kspace,nVals+hdr.FileHeader.np*hdr.FileHeader.ntraces,[]);
1120 
1121  % Remove block headers from the data
1122  kspace(1:nVals,:)=[];
1123  %kspace=kspace(nVals+1:end,:);
1124 
1125  % Transform to complex values
1126  kspace = reshape(kspace,hdr.FileHeader.np,...
1127        hdr.FileHeader.ntraces,hdr.FileHeader.nblocks);
1128 
1129  % Do DC-correction if necessary
1130  if ~Dat.DCcorrection || ( nt(1)>1 )
1131    kspace=complex(kspace(1:2:end,:,:),kspace(2:2:end,:,:));
1132  else
1133    kspace=complex(kspace(1:2:end,:,:)-hdr.BlockHeaders.lvl,...
1134      kspace(2:2:end,:,:)-hdr.BlockHeaders.tlt);
1135  end
1136 
1137  %% Store and order k-space values
1138  if any(Dat.AcqType==[1 2])
1139    switch procpar.seqcon(2:3)
1140      case {'cc','sc'}
1141        %kspace(:,:,ii) = complex_block;
1142      otherwise
1143        %kspace(:,ii,:) = complex_block;
1144        kspace = permute(kspace,[1 3 2]);
1145    end
1146  else
1147    %kspace(:,:,ii) = complex_block;
1148  end
1149 
1150  if Dat.ShowWaitbar
1151        delete(wb_h)
1152  end
1153 
1154end
1155
1156% Remove singleton dimensions from kspace
1157kspace = squeeze(kspace);
1158
1159% Check if raw kspace should be returned
1160if Dat.ReturnRawKspace
1161  %% Delete waitbar
1162  if Dat.ShowWaitbar && ishandle(wb_h)
1163        delete(wb_h)
1164  end
1165  return
1166end
1167
1168%% Support for RASER sequence ---------------------------
1169if isfield(procpar,'teType')
1170 
1171  if strcmpi(procpar.sing_sh,'y') && strcmpi(procpar.teType,'c')
1172       
1173    % Separate reference scans from the data
1174    if isfield(procpar,'refscan') && strcmp(procpar.refscan,'y')
1175      kspace=permute(reshape(kspace,procpar.np/2,procpar.ne/2,2,[]),[1 2 4 3]);
1176      noise = kspace(:,:,:,1);
1177      kspace = kspace(:,:,:,2);
1178      % DC-correction
1179      dc_level = squeeze(mean(mean(noise)));
1180      for ii=1:size(kspace,3)
1181        kspace(:,:,ii)=kspace(:,:,ii)-dc_level(ii);
1182      end
1183    end
1184   
1185    if strcmpi(procpar.readType,'s')
1186      sw = procpar.sw;
1187      dwell = cumsum(ones(1,size(kspace,1))*(1/sw));
1188    else
1189      error('This feature has not been implemented yet!!!')
1190    end
1191    dwell = dwell*1000;
1192    %kspace = permute(kspace,[2 1 3]);
1193   
1194   
1195   
1196    % Phase correction
1197    dims = size(kspace);
1198    nI = size(kspace,3);
1199    nv = size(kspace,4);
1200    ne = size(kspace,2);
1201    np = size(kspace,1);
1202    g = 42.58;
1203    G = procpar.gvox2;
1204    Ds = procpar.vox2/100;
1205    pos2 = procpar.pos2/10;
1206    fudge = 0;
1207    fudge2 = 1;
1208   
1209    tt_dwell=repmat(dwell(:),1,ne);
1210    tt_ne = repmat((1:ne),length(dwell),1);
1211    tt_np = repmat((1:np)',1,ne);
1212   
1213    i=sqrt(-1);
1214    phi = (-2.*pi.*g.*G.*Ds.*tt_dwell.*(tt_ne./ne - 1/2 - pos2/Ds))+fudge.*tt_np;
1215    phi = repmat(phi,[1,1,size(kspace,3)]);
1216    kspace = abs(kspace).*exp(i*(angle(kspace)+phi));
1217   
1218    % Flip every other column
1219    sz(1)=size(kspace,1);
1220    sz(2)=size(kspace,2);
1221    sz(3)=size(kspace,3);
1222    sz(4)=size(kspace,4);
1223    kspace=reshape(kspace,sz(1),prod(sz(2:4)));
1224    kspace(:,1:2:end) = flipud(kspace(:,1:2:end));
1225    kspace = reshape(kspace,sz);
1226   
1227    %kspace = reshape(permute(kspace,[2 1 3]),sz(2),[],1);
1228    %kspace(:,1:2:end) = flipud(kspace(:,1:2:end));
1229    %kspace=permute(reshape(kspace,sz(2),[],sz(3)),[2 1 3]);
1230   
1231  else
1232    data = [];
1233    error('RASER sequence of this type has not been implemeted yet!')
1234  end
1235 
1236  % Reshape into 4D matrix
1237  kspace = reshape(kspace,size(kspace,1),size(kspace,2),[],size(kspace,3));
1238 
1239  % Reorient if requested
1240  if Dat.OrientImages
1241    kspace = flipdim(kspace,2);
1242  end
1243 
1244  data = abs(fftshift(fft(fftshift(fft(kspace,[],3),3),[],1),1));
1245 
1246  % Delete kspace if not returned
1247  if ~Dat.ReturnKSpace
1248    kspace=[];
1249  end
1250 
1251  return
1252 
1253end
1254
1255%% Support for fat/water measurements ----------------------
1256if isfield(procpar,'seqfil') && strcmpi(procpar.seqfil,'ge3d_csi2')
1257 
1258  % Split kspace into fat and water (in 4th dimesion)
1259  kspace=reshape(permute(reshape(kspace,256,2,[]),[1 3 4 2]),256,128,[],2);
1260 
1261  % Fourier transform data
1262  if any(Dat.ZeroPadding==[1 2])
1263    data_sz = [procpar.np/2,procpar.nf,procpar.nv2,2];
1264    data = zeros(data_sz,class(kspace));
1265    data(:,:,:,1) = abs(fftshift(fftn(kspace(:,:,:,1),data_sz(1:3))));
1266    data(:,:,:,2) = abs(fftshift(fftn(kspace(:,:,:,2),data_sz(1:3))));
1267  else
1268    data = zeros(size(kspace),class(kspace));
1269    data(:,:,:,1) = abs(fftshift(fftn(kspace(:,:,:,1))));
1270    data(:,:,:,2) = abs(fftshift(fftn(kspace(:,:,:,2))));
1271  end
1272 
1273  % Delete kspace if not returned
1274  if ~Dat.ReturnKSpace
1275    kspace=[];
1276  end
1277 
1278  return
1279end
1280
1281% Check the number of receivers (PI stuff)
1282if isfield(procpar,'rcvrs') && ~isempty(procpar.rcvrs) && ...
1283    length(procpar.rcvrs{1})>1
1284  % Multiple receivers used
1285  if isfield(procpar,'apptype') && strcmp(procpar.apptype{1},'imEPI')
1286    % Store multiple receiver data in EPI measurements in 5th dimension
1287    % and calculate sum-of-squares image
1288    nRcv = length(find(procpar.rcvrs{1}=='y'));
1289    nVols = size(kspace,3)/nRcv-1;
1290    data = zeros(procpar.nv,procpar.np/2,procpar.ns,nVols+1,'single');
1291    kssz=size(kspace);
1292    blksz = 500; % Process EPI data in 500 volume blocks
1293    nBlocks = ceil((size(kspace,3)/nRcv)/blksz);
1294    lnum = length(num2str(nBlocks));
1295    lnumstr = num2str(lnum);
1296    bsl = lnum*2+1;
1297    fprintf(1,'Processing data in blocks of %d volumes\n',blksz)
1298    fprintf(1,['Processing block...%0',lnumstr,'d/%0',lnumstr,'d'],1,nBlocks);
1299    for ii=1:nBlocks
1300      fprintf(1,repmat('\b',1,bsl));
1301      fprintf(1,['Processing block...%0',lnumstr,'d/%0',lnumstr,'d'],ii,nBlocks);
1302      tmp_data = [];
1303      for kk=1:nRcv
1304        inds = [kk ((ii-1)*blksz*nRcv+kk):nRcv:min((nRcv*ii*blksz),kssz(3))];
1305        if ii==1
1306          % For first block, phase image is in inds twice
1307          inds = inds(2:end);
1308        end
1309        tmp_kspace = l_ReconstructKspace(kspace(:,:,inds),procpar,Dat);
1310        tmp_data(:,:,:,:,kk) = fftshift(fftshift(fft(fft(tmp_kspace,[],1),[],2),1),2);
1311      end
1312      if ii==1
1313        data = sqrt(sum(tmp_data.*conj(tmp_data),5));
1314      elseif ii==nBlocks
1315        data(:,:,:,((ii-1)*blksz+1):(nVols+1)) = sqrt(sum(tmp_data(:,:,:,2:end,:).*conj(tmp_data(:,:,:,2:end,:)),5));
1316      else
1317        data(:,:,:,((ii-1)*blksz+1):(ii*blksz)) = sqrt(sum(tmp_data(:,:,:,2:end,:).*conj(tmp_data(:,:,:,2:end,:)),5));
1318      end
1319    end
1320    fprintf(1,'\n')
1321   
1322%     for kk=1:(size(kspace,3)/nRcv-1)
1323%       for ii=1:nRcv
1324%         tmp_kspace = l_ReconstructKspace(kspace(:,:,[ii kk*nRcv+ii]),procpar,Dat);
1325%         tmp_data(:,:,:,:,ii) = fftshift(fftshift(fft(fft(tmp_kspace,[],1),[],2),1),2);
1326%         
1327%         %tmp_kspace = l_ReconstructKspace(kspace(:,:,ii:nRcv:end),procpar,Dat);
1328%         %kspace2(:,:,:,:,ii)=tmp_kspace;
1329%       end
1330%       if kk==1
1331%         data = sqrt(mean(tmp_data.*conj(tmp_data),5));
1332%       else
1333%         data(:,:,:,kk+1) = sqrt(mean(tmp_data(:,:,:,2,:).*conj(tmp_data(:,:,:,2,:)),5));
1334%       end
1335%       fprintf(1,repmat('\b',1,bsl));
1336%       fprintf(1,['%0',lnumstr,'d/%0',lnumstr,'d'],kk,nVols);
1337%     end
1338%     fprintf(1,'\n')
1339%     %kspace = kspace2;
1340%     %data = fftshift(fftshift(fft(fft(kspace,[],1),[],2),1),2);
1341%     %data = sqrt(mean(data.*conj(data),5));
1342%     %kspace2=[];
1343   
1344    % Remove reference image if requested
1345    if Dat.isEPIdata && Dat.RemoveEPIphaseIm
1346      data = data(:,:,:,2:end);
1347    end
1348   
1349    if Dat.OrientImages && ~isempty(procpar) && ...
1350        isfield(procpar,'orient') && any(Dat.AcqType==[2 3 4])
1351      orient = procpar.orient{1};
1352      if any(strcmpi(orient,{'xyz','trans90','cor90','sag90'}))
1353        data = flipdim(aedes_rot3d(data,1,3),2);
1354      elseif strcmpi(orient,'oblique')
1355        data = flipdim(flipdim(data,1),2);
1356      else
1357        data = flipdim(flipdim(data,1),2);
1358      end
1359    end
1360   
1361  else
1362    nRcv = length(find(procpar.rcvrs{1}=='y'));
1363    data = [];
1364    kspace2 = [];
1365    for ii=1:nRcv
1366      tmp_kspace = l_ReconstructKspace(kspace(:,:,ii),procpar,Dat);
1367      kspace2(:,:,:,ii)=tmp_kspace;
1368      if Dat.ReturnFTData
1369        tmp_data = l_CalculateFFT(tmp_kspace,procpar,Dat);
1370        data(:,:,:,ii) = tmp_data;
1371      end
1372    end
1373    kspace = kspace2;
1374    kspace2=[];
1375  end
1376else
1377  % Only one receiver
1378  kspace = l_ReconstructKspace(kspace,procpar,Dat);
1379  data = l_CalculateFFT(kspace,procpar,Dat);
1380end
1381
1382% Delete kspace if not returned
1383if ~Dat.ReturnKSpace
1384  kspace=[];
1385end
1386
1387%===============================================
1388% Reconstruct kspace for different sequences
1389%===============================================
1390function kspace=l_ReconstructKspace(kspace,procpar,Dat)
1391
1392
1393%% Flip images for certain measurements
1394if Dat.FlipKspace~=0
1395  if ischar(Dat.FlipInd)
1396    if strcmpi(Dat.FlipInd,'all')
1397      flipind = 1:size(kspace,3);
1398    elseif strcmpi(Dat.FlipInd,'alt')
1399      flipind = 2:2:size(kspace,3);
1400    end
1401  else
1402    flipind = Dat.FlipInd;
1403  end
1404 
1405  for ii=flipind
1406    if Dat.FlipKspace==1
1407      kspace(:,:,ii)=fliplr(kspace(:,:,ii));
1408    elseif Dat.FlipKspace==2
1409      kspace(:,:,ii)=flipud(kspace(:,:,ii));
1410    else
1411      kspace(:,:,ii)=flipud(fliplr(kspace(:,:,ii)));
1412    end
1413  end
1414end
1415
1416% Handle arrayed and RARE sequences
1417if Dat.isAcqArrayed && Dat.AcqType~=1 && Dat.Sorting && ~Dat.isEPIdata
1418  %if ~strcmpi(procpar.seqcon(2:3),'cc') && ( isempty(Dat.phasetable) | ...
1419  %        isfield(procpar,'flash_converted') )
1420  if (( isempty(Dat.phasetable) && ~strcmpi(procpar.seqcon(2:3),'sc') ) && ...
1421      ~(strcmpi(procpar.seqcon(2:3),'cc') && Dat.ArrayLength==size(kspace,3))) || ...
1422      isfield(procpar,'flash_converted')
1423                                 
1424    % Sort uncompressed arrayed data
1425    ks_order = 1:procpar.nv*Dat.ArrayLength;
1426    tmp = 0:procpar.nv:(procpar.ne-1)*procpar.nv;
1427    tmp=repmat(tmp,procpar.nv*Dat.ArrayLength,1);
1428    ks_order = reshape(ks_order,Dat.ArrayLength,procpar.nv).';
1429    ks_order = ks_order(:);
1430    ks_order = repmat(ks_order,1,procpar.ne);
1431    ks_order = ks_order+tmp;
1432    ks_order = ks_order.';
1433   
1434    if procpar.ns==1
1435      kspace=kspace(:,ks_order);
1436    else
1437      kspace = kspace(:,ks_order,:);
1438    end
1439   
1440    % Reshape into 3D matrix
1441    kspace=reshape(kspace,[size(kspace,1) procpar.nv Dat.ArrayLength* ...
1442                        procpar.ns]);
1443  else
1444    %% Sort RARE type data
1445    if UsePhaseTable && ~isempty(Dat.phasetable)
1446      %Dat.phasetable = Dat.phasetable';
1447      if Dat.isAcqArrayed && Dat.ArrayLength>1 && strcmpi(procpar.seqcon(2:3),'cs')
1448        kspace = permute(reshape(reshape(kspace,size(kspace,1),[]),size(kspace,1),Dat.ArrayLength,[]),[1 3 2]);
1449      else
1450        Dat.phasetable = Dat.phasetable.';
1451      end
1452      kspace(:,Dat.phasetable(:),:) = kspace;
1453    end
1454  end
1455elseif Dat.isEPIdata
1456  %% Support for EPI-measurements
1457 
1458 
1459  % EPI data is measured with old VNMR
1460  if isfield(procpar,'readres') && isfield(procpar,'phaseres')
1461   
1462    % Number of slices
1463    tmp_ns=length(procpar.pss);
1464   
1465    if isfield(procpar,'navecho') && strcmpi(procpar.navecho{1},'y')
1466      tmp_nv = procpar.nv-procpar.nseg;
1467    else
1468      tmp_nv = procpar.nv;
1469    end
1470    kspace = reshape(kspace,[size(kspace,1) ...
1471      size(kspace,2)/tmp_nv tmp_nv]);
1472    kspace = permute(kspace,[1 3 2]);
1473   
1474    % Reshape to 4D matrix
1475    kspace = reshape(kspace,[size(kspace,1) size(kspace,2) ...
1476      tmp_ns size(kspace,3)/tmp_ns]);
1477   
1478   
1479  elseif isfield(procpar,'apptype') && strcmp(procpar.apptype{1},'imEPI')
1480    % If EPI data is measured with new VNMRj system
1481   
1482    % Number of slices
1483    ns = length(procpar.pss);
1484   
1485    % Reshape kspace to 4D matrix
1486    if isfield(procpar,'fract_ky') && procpar.fract_ky~=procpar.nv/2
1487      kspace = reshape(kspace,procpar.np/2,procpar.nv/2+procpar.fract_ky,...
1488        ns,[]);
1489      kspace(procpar.np/2,procpar.nv,1)=0;
1490    else
1491      kspace = reshape(kspace,procpar.np/2,procpar.nv,...
1492        ns,[]);
1493    end
1494   
1495    % Flip even kspace lines
1496    if ~Dat.FastDataRead
1497      for tt=2:2:size(kspace,2)
1498        kspace(:,tt,:,:) = flipdim(kspace(:,tt,:,:),1);
1499      end
1500    else
1501      kspace(:,2:2:end,:,:) = flipdim(kspace(:,2:2:end,:,:),1);
1502    end
1503   
1504   
1505    % Sort centric measurements
1506    if isfield(procpar,'ky_order') && strcmpi(procpar.ky_order,'c')
1507      kspace(:,Dat.phasetable(:),:,:)=kspace;
1508    end
1509    %kspace = flipdim(kspace,1);
1510   
1511    % Get the reference image(s)
1512    ref_im = kspace(:,:,:,1);
1513   
1514    % Do phase correction.
1515    phase_e = exp(-sqrt(-1)*angle(fft(ref_im,[],1)));
1516    for kk=2:size(kspace,4)
1517      kspace(:,:,:,kk) = ifft(fft(kspace(:,:,:,kk),[],1).*phase_e,[],1);
1518    end
1519  end
1520 
1521else
1522  % This section contains various "chewing gum and ironwire" type
1523  % patches that hopefully work...
1524 
1525  if strcmp(procpar.seqcon,'nncnn')
1526    kspace = permute(kspace,[1 3 2]);
1527  elseif strcmp(procpar.seqcon,'nccnn') && length(size(kspace))==2 && ...
1528      procpar.ns>=1 && Dat.AcqType~=1
1529    if ~isempty(Dat.phasetable)
1530      kssz = size(kspace);
1531      phsz = size(Dat.phasetable);
1532      kspace=permute(reshape(kspace,procpar.np/2,...
1533        phsz(2),...
1534        kssz(2)/phsz(2)),[1 3 2]);
1535      kspace = permute(reshape(kspace,...
1536        procpar.np/2,procpar.ns,kssz(2)/procpar.ns),[1 3 2]);
1537      if Dat.Sorting
1538        kspace(:,Dat.phasetable(:),:)=kspace;
1539      end
1540    else
1541      kspace = reshape(kspace,...
1542        [procpar.np/2 procpar.ns ...
1543        size(kspace,2)/procpar.ns]);
1544      kspace=permute(kspace,[1 3 2]);
1545    end
1546   
1547  elseif strcmp(procpar.seqcon,'nscsn') && length(size(kspace))==3 && ...
1548          Dat.AcqType~=1
1549        %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1550        % Support for 3D fast spin-echo
1551        %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1552        if ~isempty(Dat.phasetable)
1553          for ii=1:size(kspace,3)
1554                tmp = kspace(:,:,ii);
1555                kssz = size(tmp);
1556                phsz = size(Dat.phasetable);
1557                tmp=permute(reshape(tmp,procpar.np/2,...
1558                  phsz(2),...
1559                  kssz(2)/phsz(2)),[1 3 2]);
1560                tmp = permute(reshape(tmp,...
1561                  procpar.np/2,procpar.ns,kssz(2)/procpar.ns),[1 3 2]);
1562                if Dat.Sorting
1563                  tmp(:,Dat.phasetable(:),:)=tmp;
1564                end
1565                kspace(:,:,ii)=tmp;
1566          end
1567        end
1568       
1569       
1570  elseif Dat.AcqType~=1 && isfield(procpar,'nv')
1571    if length(size(kspace))==2 && ...
1572              ( size(kspace,1)~=(procpar.np/2) || size(kspace,2)~=procpar.nv )
1573      %% Reshape the kspace to the appropriate size
1574      kspace=reshape(kspace,[procpar.np/2 procpar.nv size(kspace,2)/ ...
1575                          procpar.nv]);
1576    elseif length(size(kspace))==3
1577      kspace = reshape(kspace,procpar.np/2,procpar.nv,[]);
1578      if Dat.Sorting && ~isempty(Dat.phasetable)
1579        kspace(:,Dat.phasetable(:),:) = kspace;
1580      end
1581    end
1582  end
1583 
1584 
1585  %%% Support for Teemu's ASE3D-data
1586  %if strcmpi(procpar.seqcon,'ncccn')
1587  %  %% Reshape the kspace to the appropriate size
1588  %  kspace=reshape(kspace,[procpar.np/2 procpar.nv size(kspace,2)/procpar.nv]);
1589  %end
1590end
1591
1592
1593
1594%=========================================
1595% Fourier Transform Data
1596%=========================================
1597function data=l_CalculateFFT(kspace,procpar,Dat)
1598data=[];
1599
1600% Return image/spectral data --------------------------------
1601if Dat.ReturnFTData
1602  %% Fourier transform spectral data
1603  if Dat.AcqType==1
1604        wb_h = aedes_wbar(0,'Fourier transforming spectral data');
1605    %data=zeros(size(kspace),'single');
1606        data=kspace;
1607    sz=size(kspace,2)*size(kspace,3);
1608    count=1;
1609    for kk=1:size(kspace,3)
1610      for ii=1:size(kspace,2)
1611        %% Update waitbar
1612        if Dat.ShowWaitbar
1613          aedes_wbar(count/sz,...
1614               wb_h,...
1615               {'Fourier transforming spectral data',...
1616                ['(Processing spectrum ' num2str(count) '/' num2str(sz) ')']})
1617                end
1618        data(:,ii,kk) = abs(fftshift(fft(data(:,ii,kk))));
1619        count=count+1;
1620      end
1621    end
1622 
1623  %% Fourier transform image data
1624  else
1625   
1626    %% Zeropadding auto
1627    if Dat.ZeroPadding==2
1628     
1629      if Dat.isEPIdata && isfield(procpar,'readres') && isfield(procpar,'phaseres')
1630       
1631        %% Determine the image size for EPI data for procpar "readres"
1632        %% and "phaseres" fields
1633        data_sz = [procpar.readres procpar.phaseres];
1634        if isequal(data_sz,[size(kspace,1),size(kspace,2)])
1635          DoZeroPadding=false;
1636        else
1637          DoZeroPadding=true;
1638        end
1639        data_sz = [procpar.readres ...
1640          procpar.phaseres size(kspace,3) size(kspace,4)];
1641      else
1642       
1643        %% Check if zeropadding is necessary.
1644        ks_sz_sorted = sort([size(kspace,1),size(kspace,2)]);
1645        fov_sz_sorted = sort([procpar.lro,procpar.lpe]);
1646        sliceRelativeDim = ks_sz_sorted(2)/ks_sz_sorted(1);
1647        FOVrelativeDim = fov_sz_sorted(2)/fov_sz_sorted(1);
1648        if FOVrelativeDim~=sliceRelativeDim
1649          ind=find([size(kspace,1),size(kspace,2)]==ks_sz_sorted(1));
1650          data_sz = size(kspace);
1651          data_sz(ind) = round((fov_sz_sorted(1)/fov_sz_sorted(2))*ks_sz_sorted(2));
1652          DoZeroPadding=true;
1653        else
1654          data_sz = size(kspace);
1655          DoZeroPadding=false;
1656        end
1657      end
1658     
1659      %% Force zeropadding on. Force images to be square.
1660    elseif Dat.ZeroPadding==1
1661      ks_sz_max = max(size(kspace,1),size(kspace,2));
1662      data_sz = size(kspace);
1663      data_sz(1:2)=ks_sz_max;
1664      DoZeroPadding=true;
1665     
1666      %% Force zeropadding off
1667    else
1668      data_sz = size(kspace);
1669      DoZeroPadding=false;
1670    end
1671   
1672    %% Fourier transform 2D and EPI image data
1673    if Dat.AcqType==2 || Dat.isEPIdata
1674      sz=size(kspace,3);
1675     
1676      if DoZeroPadding
1677        data=zeros(data_sz,class(kspace));
1678        data(1:size(kspace,1),1:size(kspace,2),:,:)=kspace;
1679      else
1680        data=kspace;
1681      end
1682      if ~Dat.ReturnKSpace
1683        kspace = [];
1684      end
1685      if Dat.ShowWaitbar
1686        [wb_h,txh]=aedes_calc_wait('Fourier transforming image data...');
1687      end
1688     
1689      %data=permute(fftshift(fftshift(abs(fft(permute(fft(data),[2 1 3 4]))),1),2),[2 1 3 4]);
1690      if ~Dat.FastDataRead
1691        for tt=1:size(data,4)
1692          data(:,:,:,tt)=fftshift(fftshift(abs(fft(fft(data(:,:,:,tt),[],1),[],2)),1),2);
1693        end
1694      else
1695        data=fftshift(fftshift(abs(fft(fft(data,[],1),[],2)),1),2);
1696      end
1697    else
1698      %% Fourier transform 3D image data
1699      if Dat.ShowWaitbar
1700        [wb_h,txh]=aedes_calc_wait('Fourier transforming 3D image data...');
1701      end
1702     
1703      if DoZeroPadding
1704        % Check zeropadding in the 3rd dimension if zeropadding is set to
1705        % "auto"
1706        if Dat.ZeroPadding==2
1707          if isfield(procpar,'lpe2') && isfield(procpar,'lpe')
1708            data_sz(3) = max(1,round((procpar.lpe2/procpar.lpe)*data_sz(2)*Dat.ArrayLength));
1709          end
1710        end
1711        data=zeros(data_sz,class(kspace));
1712        data = abs(fftshift(fftn(kspace,data_sz)));
1713      else
1714        data=zeros(data_sz,class(kspace));
1715        data = abs(fftshift(fftn(kspace)));
1716      end
1717    end
1718   
1719    % Remove reference image if requested
1720    if Dat.isEPIdata && Dat.RemoveEPIphaseIm
1721      data = data(:,:,:,2:end);
1722    end
1723   
1724    % Reorient images and remove the reference image if requested
1725    if Dat.OrientImages && ~isempty(procpar) && ...
1726        isfield(procpar,'orient') && any(Dat.AcqType==[2 3 4])
1727      orient = procpar.orient{1};
1728      if any(strcmpi(orient,{'xyz','trans90','cor90','sag90'}))
1729        data = flipdim(aedes_rot3d(data,1,3),2);
1730      elseif strcmpi(orient,'oblique')
1731        data = flipdim(flipdim(data,1),2);
1732      else
1733        data = flipdim(flipdim(data,1),2);
1734      end
1735    end
1736   
1737   
1738   
1739% $$$   %% Fourier transform 4D image data
1740% $$$   elseif Dat.AcqType==4
1741% $$$     data = abs(fftshift(fftshift(fft2(kspace),2),1));
1742  end
1743 
1744  %% Delete waitbar
1745  if Dat.ShowWaitbar && ishandle(wb_h)
1746    delete(wb_h)
1747  end
1748end
1749
1750
1751
1752
1753
1754%========================================================
1755% A function for creating phasetables for fse and fsems
1756%========================================================
1757function phasetable=l_CreateFsemsPhaseTable(procpar)
1758
1759phasetable = [];
1760if ~isfield(procpar,'etl') || ~isfield(procpar,'kzero')
1761  return
1762end
1763etl = procpar.etl;
1764kzero = procpar.kzero;
1765nv = procpar.nv;
1766
1767t = (-nv/2+1):(nv/2);
1768t = t(:);
1769tt = flipud(t);
1770tt = tt(:);
1771
1772phasetable = [reshape(t(1:nv/2),[],etl);...
1773  flipud(reshape(tt(1:nv/2),[],etl))];
1774phasetable = circshift(fliplr(phasetable),[0 kzero-1]);
1775
1776
1777%% - EOF - %%
1778return
Note: See TracBrowser for help on using the repository browser.

Powered by Trac 1.0.9.Copyright © Juha-Pekka Niskanen 2008