Home > functions > leadfield > head > vb_headinfo_set_sigma.m

vb_headinfo_set_sigma

PURPOSE ^

setter Headinfo.Sigma

SYNOPSIS ^

function Headinfo = vb_headinfo_set_sigma(headinfo, sigma)

DESCRIPTION ^

 setter Headinfo.Sigma
 [usage]
   Headinfo = vb_headinfo_set_sigma(headinfo, sigma)
 [input]
   headinfo : <optional> <<struct>> Headinfo
            :  if it is not specified or is empty, Headinfo will be created
      sigma : <optional> value of Sigma
            :  if it is not specified or is empty, [] will be set
 [output]
    Headinfo : <<struct>> updated Headinfo
 [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 Headinfo = vb_headinfo_set_sigma(headinfo, sigma)
0002 % setter Headinfo.Sigma
0003 % [usage]
0004 %   Headinfo = vb_headinfo_set_sigma(headinfo, sigma)
0005 % [input]
0006 %   headinfo : <optional> <<struct>> Headinfo
0007 %            :  if it is not specified or is empty, Headinfo will be created
0008 %      sigma : <optional> value of Sigma
0009 %            :  if it is not specified or is empty, [] will be set
0010 % [output]
0011 %    Headinfo : <<struct>> updated Headinfo
0012 % [note]
0013 %
0014 % [history]
0015 %   2007-04-06 (Sako) initial version
0016 %
0017 % Copyright (C) 2011, ATR All Rights Reserved.
0018 % License : New BSD License(see VBMEG_LICENSE.txt)
0019 
0020 % --- CHECK ARGUMENTS --- %
0021 if ~exist('headinfo', 'var') headinfo = []; end;
0022 if ~exist('sigma', 'var')    sigma = []; end;
0023 [Headinfo, sigma] = inner_check_arguments(headinfo, sigma);
0024 
0025 % --- MAIN PROCEDURE --------------------------------------------------------- %
0026 %
0027 Headinfo.Sigma = sigma;
0028 if nargout ~= 1
0029   error('!!! You must receive updated Headinfo !!!');
0030 end
0031 %
0032 % --- END OF MAIN PROCEDURE -------------------------------------------------- %
0033 
0034 % --- INNER FUNCTIONS -------------------------------------------------------- %
0035 %
0036 % --- inner_check_arguments()
0037 %
0038 function [headinfo, sigma] = inner_check_arguments(headinfo, sigma)
0039 % especially do nothing
0040 return;
0041 %
0042 % --- end of inner_check_arguments()
0043 
0044 %%% END OF FILE %%%

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