Home > vbmeg > functions > device > eeg > vb_eeginfo_set_reference.m

vb_eeginfo_set_reference

PURPOSE ^

set reference type to EEGinfo

SYNOPSIS ^

function [eeginfo] = vb_eeginfo_set_reference(eeginfo, reference)

DESCRIPTION ^

 set reference type to EEGinfo
 [usage]
   [eeginfo] = vb_eeginfo_set_reference(eeginfo, reference)
 [input]
     eeginfo : <required> <<struct>> EEGinfo
   reference : <optional> <<string>> reference type []
 [output]
     eeginfo : updated EEGinfo
 [note]
   device dependent data
 [history]
   2011-05-27 (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 [eeginfo] = vb_eeginfo_set_reference(eeginfo, reference)
0002 % set reference type to EEGinfo
0003 % [usage]
0004 %   [eeginfo] = vb_eeginfo_set_reference(eeginfo, reference)
0005 % [input]
0006 %     eeginfo : <required> <<struct>> EEGinfo
0007 %   reference : <optional> <<string>> reference type []
0008 % [output]
0009 %     eeginfo : updated EEGinfo
0010 % [note]
0011 %   device dependent data
0012 % [history]
0013 %   2011-05-27 (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('eeginfo', 'var'), eeginfo = []; end
0020 if ~exist('reference', 'var'), reference = ''; end
0021 [eeginfo, reference] = inner_check_arguments(eeginfo, reference);
0022 
0023 % --- MAIN PROCEDURE --------------------------------------------------------- %
0024 %
0025 eeginfo.device_info.Reference = reference;
0026 return;
0027 %
0028 % --- END OF MAIN PROCEDURE -------------------------------------------------- %
0029 
0030 % --- INNER FUNCTIONS -------------------------------------------------------- %
0031 %
0032 % --- inner_check_arguments()
0033 %
0034 function [eeginfo, reference] = inner_check_arguments(eeginfo, reference)
0035 func_ = mfilename;
0036 if isempty(eeginfo)
0037   error('(%s) eeginfo is a required parameter', func_);
0038 end
0039 return;
0040 %
0041 % --- end of inner_check_arguments()
0042 %
0043 % --- END OF INNER FUNCTIONS ------------------------------------------------- %
0044 
0045 %--- END OF FILE ---%

Generated on Mon 22-May-2023 06:53:56 by m2html © 2005