Home > functions > leadfield > head > vb_headinfo_get_layertag.m

vb_headinfo_get_layertag

PURPOSE ^

getter of Headinfo.LayerTag

SYNOPSIS ^

function layer_tag = vb_headinfo_get_layertag(Headinfo)

DESCRIPTION ^

 getter of Headinfo.LayerTag
 [usage]
   layer_tag = headinfo_get_layer_tag(Headinfo)
 [input]
   Headinfo : <required> <<struct>>
            :  if this does not have target field, return empty ([]).
 [output]
      layer_tag : Headinfo.LayerTag
 [note]

 [history]
   2007-04-06 (Sako) initial version

 Copyright (C) 2011, ATR All Rights Reserved.
 License : New BSD License(see VBMEG_LICENSE.txt)

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 function layer_tag = vb_headinfo_get_layertag(Headinfo)
0002 % getter of Headinfo.LayerTag
0003 % [usage]
0004 %   layer_tag = headinfo_get_layer_tag(Headinfo)
0005 % [input]
0006 %   Headinfo : <required> <<struct>>
0007 %            :  if this does not have target field, return empty ([]).
0008 % [output]
0009 %      layer_tag : Headinfo.LayerTag
0010 % [note]
0011 %
0012 % [history]
0013 %   2007-04-06 (Sako) initial version
0014 %
0015 % Copyright (C) 2011, ATR All Rights Reserved.
0016 % License : New BSD License(see VBMEG_LICENSE.txt)
0017 
0018 % --- CHECK ARGUMENTS --- %
0019 if ~exist('Headinfo', 'var') Headinfo = []; end;
0020 [Headinfo] = inner_check_arguments(Headinfo);
0021 
0022 % --- MAIN PROCEDURE --------------------------------------------------------- %
0023 %
0024 layer_tag = Headinfo.LayerTag;
0025 %
0026 % --- END OF MAIN PROCEDURE -------------------------------------------------- %
0027 
0028 % --- INNER FUNCTIONS -------------------------------------------------------- %
0029 %
0030 function [Headinfo] = inner_check_arguments(Headinfo)
0031 if isempty(Headinfo)
0032   error('Headinfo is a required parameter');
0033 end
0034 
0035 if ~isfield(Headinfo, 'LayerTag') Headinfo.LayerTag = []; end;
0036 %
0037 % --- END OF INNER FUNCTIONS ------------------------------------------------- %
0038 
0039 %%% END OF FILE %%%

Generated on Tue 27-Aug-2013 11:46:04 by m2html © 2005