Home > functions > device > eeg > vb_job_eeg_gateway.m

vb_job_eeg_gateway

PURPOSE ^

This is a gateway function to job_eeg.

SYNOPSIS ^

function vb_job_eeg_gateway(proj_root, meg_parm)

DESCRIPTION ^

 This is a gateway function to job_eeg.
 [usage]
   vb_job_eeg_gateway(proj_root, meg_parm)
 [input]
   proj_root : <required> path for imported VBMEG files ['']
             :  this is not used.
    meg_parm : <required> <<struct>>
             :  .Measurement      : measurement type ['EEG']
             :  .device           : device name ['BIOSEMI']
             :  .measurement_file : input (BDF) file (.bdf)
             :  .pos_file         : position file (.pos.mat)
             :  .output_file      : output file (.eeg.mat)
             :                    : ['(yyyymmdd_HHMMSS).eeg.mat']
             :  .bin_data_dir     : output directory for binary data files
             :                    : this is a relative path from output_file
             :  .eeginfo_version  : version of EEGinfo - unused []
             :  .verbose_swt      : <<boolean>> [false]
 [output]
   none
 [note]
   @see vb_job_meg.m
   @see vb_job_eeg.m
   read_bdf_spec is a struct for the destination function vb_job_eeg
   which has fields as follows
     .bdf_file     : BDF file with valid path
     .pos_file     : POS-MAT file with valid path
     .device       : device name
     .output_dir   : output directory for EEG-MAT files ['.']
     .eeg_file     : ['<date>.eeg.mat'] EEG-MAT file name
     .bin_data_dir : output directory for binary data files
                   : this is a relative path from output_dir
     .eeginfo_version : <optional> [] version of EEGinfo - unused yet
 [history]
   2008-02-14 (Sako) initial version
   2008-02-26 (Sako) supported POS-MAT file
   2008-03-26 (Sako) modified how to apply proj_root
   2008-05-28 (Sako) changed format of meg_parm for EEG
   2010-02-02 (Sako) modified default value of meg_parm.output_file

 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 vb_job_eeg_gateway(proj_root, meg_parm)
0002 % This is a gateway function to job_eeg.
0003 % [usage]
0004 %   vb_job_eeg_gateway(proj_root, meg_parm)
0005 % [input]
0006 %   proj_root : <required> path for imported VBMEG files ['']
0007 %             :  this is not used.
0008 %    meg_parm : <required> <<struct>>
0009 %             :  .Measurement      : measurement type ['EEG']
0010 %             :  .device           : device name ['BIOSEMI']
0011 %             :  .measurement_file : input (BDF) file (.bdf)
0012 %             :  .pos_file         : position file (.pos.mat)
0013 %             :  .output_file      : output file (.eeg.mat)
0014 %             :                    : ['(yyyymmdd_HHMMSS).eeg.mat']
0015 %             :  .bin_data_dir     : output directory for binary data files
0016 %             :                    : this is a relative path from output_file
0017 %             :  .eeginfo_version  : version of EEGinfo - unused []
0018 %             :  .verbose_swt      : <<boolean>> [false]
0019 % [output]
0020 %   none
0021 % [note]
0022 %   @see vb_job_meg.m
0023 %   @see vb_job_eeg.m
0024 %   read_bdf_spec is a struct for the destination function vb_job_eeg
0025 %   which has fields as follows
0026 %     .bdf_file     : BDF file with valid path
0027 %     .pos_file     : POS-MAT file with valid path
0028 %     .device       : device name
0029 %     .output_dir   : output directory for EEG-MAT files ['.']
0030 %     .eeg_file     : ['<date>.eeg.mat'] EEG-MAT file name
0031 %     .bin_data_dir : output directory for binary data files
0032 %                   : this is a relative path from output_dir
0033 %     .eeginfo_version : <optional> [] version of EEGinfo - unused yet
0034 % [history]
0035 %   2008-02-14 (Sako) initial version
0036 %   2008-02-26 (Sako) supported POS-MAT file
0037 %   2008-03-26 (Sako) modified how to apply proj_root
0038 %   2008-05-28 (Sako) changed format of meg_parm for EEG
0039 %   2010-02-02 (Sako) modified default value of meg_parm.output_file
0040 %
0041 % Copyright (C) 2011, ATR All Rights Reserved.
0042 % License : New BSD License(see VBMEG_LICENSE.txt)
0043 
0044 % --- CHECK ARGUMENTS --- %
0045 if ~exist('proj_root', 'var'), proj_root = []; end
0046 if ~exist('meg_parm', 'var'), meg_parm = []; end
0047 [proj_root, meg_parm] = inner_check_arguments(proj_root, meg_parm);
0048 
0049 % --- MAIN PROCEDURE --------------------------------------------------------- %
0050 %
0051 % ----- make read_bdf_spec from meg_parm
0052 read_bdf_spec.bdf_file = meg_parm.measurement_file;
0053 read_bdf_spec.pos_file = meg_parm.pos_file;
0054 read_bdf_spec.device = meg_parm.device;
0055 read_bdf_spec.output_dir = proj_root;
0056 read_bdf_spec.eeg_file = meg_parm.output_file;
0057 read_bdf_spec.bin_data_dir = meg_parm.bin_data_dir;
0058 read_bdf_spec.eeginfo_version = meg_parm.eeginfo_version;
0059 
0060 vb_job_eeg(read_bdf_spec, meg_parm.verbose_swt);
0061 return;
0062 %
0063 % --- END OF MAIN PROCEDURE -------------------------------------------------- %
0064 
0065 % --- INNER FUNCTIONS -------------------------------------------------------- %
0066 %
0067 % --- inner_check_arguments()
0068 %
0069 function [proj_root, meg_parm] = inner_check_arguments(proj_root, meg_parm)
0070 func_ = mfilename;
0071 if isempty(proj_root)
0072   error('(%s)proj_root is a required parameter', func_);
0073 end
0074 
0075 if isempty(meg_parm)
0076   error('(%s)meg_parm is a required parameter', func_);
0077 end
0078 
0079 proj_root = vb_rm_trailing_slash(proj_root);
0080 
0081 % ----- set default values as needed
0082 %    meg_parm : <required> <<struct>>
0083 %             :  .Measurement      : measurement type ['EEG']
0084 %             :  .device           : device name ['BIOSEMI']
0085 %             :  .measurement_file : input (BDF) file (.bdf)
0086 %             :  .pos_file         : position file (.pos.mat)
0087 %             :  .output_file      : output file (.eeg.mat)
0088 %             :  .bin_data_dir     : output directory for binary data files
0089 %             :                    : this is a relative path from output_file
0090 %             :  .eeginfo_version  : version of EEGinfo - unused []
0091 %             :  .verbose_swt      : <<boolean>> [false]
0092 
0093 % if ~isfield(meg_parm, 'Measurement') || isempty(meg_parm.Measurement)
0094 %   meg_parm.Measurement = 'EEG';
0095 % end
0096 
0097 if ~isfield(meg_parm, 'device') || isempty(meg_parm.device)
0098   meg_parm.device = 'BIOSEMI';
0099 end
0100 
0101 if ~isfield(meg_parm, 'measurement_file') || isempty(meg_parm.measurement_file)
0102   error('(%s)meg_parm.measurement_file is a required field', func_);
0103 end
0104 
0105 if ~isfield(meg_parm, 'pos_file') || isempty(meg_parm.pos_file)
0106   meg_parm.pos_file = [];
0107 end
0108 
0109 if ~isfield(meg_parm, 'output_file') || isempty(meg_parm.output_file)
0110   meg_parm.output_file = '';
0111 end
0112 
0113 if ~isfield(meg_parm, 'bin_data_dir') || isempty(meg_parm.bin_data_dir)
0114   meg_parm.bin_data_dir = '';
0115 end
0116 
0117 if ~isfield(meg_parm, 'eeginfo_version')
0118   meg_parm.eeginfo_version = [];
0119 end
0120 
0121 if ~isfield(meg_parm, 'verbose_swt') || isempty(meg_parm.verbose_swt)
0122   meg_parm.verbose_swt = false;
0123 end
0124 return;
0125 %
0126 % --- end of inner_check_arguments()
0127 %
0128 % --- END OF INNER FUNCTIONS ------------------------------------------------- %
0129 
0130 %%% END OF FILE %%%
Generated on Tue 27-Aug-2013 11:46:04 by m2html © 2005