Home > bml > io > bml_read_header.m

bml_read_header

PURPOSE ^

BML_READ_HEADER reads header of a file

SYNOPSIS ^

function hdr = bml_read_header(cfg)

DESCRIPTION ^

 BML_READ_HEADER reads header of a file

 Use as
   hdr = bml_read_header(cfg)
   hdr = bml_read_header(cfg.roi)

 cfg.roi - table of height 1 with folder and name variables
 cfg.name - string: filename
 cfg.folder - string: path to file

 returns fieldtrip header

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function hdr = bml_read_header(cfg)
0002 
0003 % BML_READ_HEADER reads header of a file
0004 %
0005 % Use as
0006 %   hdr = bml_read_header(cfg)
0007 %   hdr = bml_read_header(cfg.roi)
0008 %
0009 % cfg.roi - table of height 1 with folder and name variables
0010 % cfg.name - string: filename
0011 % cfg.folder - string: path to file
0012 %
0013 % returns fieldtrip header
0014 
0015 if istable(cfg)
0016   assert(height(cfg)==1,"Only one row tables allowed as cfg");
0017 elseif isstruct(cfg)
0018   if ismember('roi',fieldnames(cfg)) && istable(cfg.roi) && height(cfg.roi)==1
0019     cfg = cfg.roi;
0020   end
0021 else
0022   cfg=struct('name',cfg);
0023 end
0024 
0025 name    = bml_getopt_single(cfg,'name');
0026 folder  = bml_getopt_single(cfg,'folder');
0027 
0028 assert(~isempty(name),"cfg.name required")
0029 if isempty(folder); folder = '.'; end
0030 
0031 hdr = ft_read_header(fullfile(folder,name),'chantype','chaninfo');

Generated on Tue 25-Sep-2018 10:08:19 by m2html © 2005