Home > functions > common > loadfunc > vb_load_current.m

vb_load_current

PURPOSE ^

load estimated current

SYNOPSIS ^

function [Jinfo,Jact] =vb_load_current(currfile,curr_type,ave_mode,trial,ix_area,verbose)

DESCRIPTION ^

 load estimated current

 USAGE:
  [Jinfo,Jact] = ...
          vb_load_current(currfile,curr_type,ave_mode,trial,ix_area,verbose)

 --- INPUT:
  currfile  - current file name
 --- Optional INPUT:
  curr_type - current type 
            = 0 : J-current : original vertex current [Default]
            = 1 : Z-current : internal current 
                              correspond to locally spread source
     If currfile is old format, curr_type is neglected
     and Jact is returned
  ave_mode : trial average mode
          = ON  : trial average is done  [Default]
          = OFF : No trial average
  trial   : trial number to load 
            if empty, all trials are loaded  [Default]
  ix_area : (absolute) vertex index to load
            if empty, all vertices are loaded  [Default]
  verbose : verbose mode for trial file loading
            0 (No print) , 1 ('.') , 2 ('session , trial')
 --- OUTPUT:
 Jinfo : structure of current info
    .version   : Version of current file
    .curr_type : 'J-current' or 'Z-current'
    .tindex    : Subsampled indices
    .Lact      : # of current direction at one vertex in active region
    .Wact      : Smoothing filter matrix
    .ix_act    : Vertex index corresponding to Z-current
    .ix_act_ex : Vertex index corresponding to J-current
    .NJact     : # of (J/Z)-current vertices
    .Tsample   : Time sample index for 'Jact'
    .Ntrial    : # of trials
    .Nsession  : # of sessions
    .jactdir   : Current directory
    .SampleFreq: Sample Frequency [Hz]
    .Pretrigger: Pretrigger period
    .Tmsec     : Time in msec
    .trial     : Trial number to load (optional input for this function)
 
 Jact    : current timecourse
   Jact(Nact,Nsample)          for ave_mode = ON 
   Jact(Nact,Nsample,Ntrials)  for ave_mode = OFF
     Nact     = Lact * Nvact,  Nvact = length(ix_act)
     Nsample  : # of time sample, 
     Ntrials  : # of trials in all session]

   Jact( n + Nvact*(i-1), t, :) 
    current at the vertex 'ix_act(n)', 'i-th' direction, time index 't'
    Time sample in MEG data : Tsample(t)
    Time (ms)   in MEG data : Tmsec(t)

 2007-3-5 Masa-aki Sato
 2008-7-9 Masa-aki Sato
  support all file types and old files
 2008-09-30 Taku Yoshioka
  Minor change for variables in Jinfo
 2010-03-01 M. Sato
  modified not to use Jinfo.ix_act_ex

 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:

SOURCE CODE ^

0001 function [Jinfo,Jact] = ...
0002     vb_load_current(currfile,curr_type,ave_mode,trial,ix_area,verbose)
0003 % load estimated current
0004 %
0005 % USAGE:
0006 %  [Jinfo,Jact] = ...
0007 %          vb_load_current(currfile,curr_type,ave_mode,trial,ix_area,verbose)
0008 %
0009 % --- INPUT:
0010 %  currfile  - current file name
0011 % --- Optional INPUT:
0012 %  curr_type - current type
0013 %            = 0 : J-current : original vertex current [Default]
0014 %            = 1 : Z-current : internal current
0015 %                              correspond to locally spread source
0016 %     If currfile is old format, curr_type is neglected
0017 %     and Jact is returned
0018 %  ave_mode : trial average mode
0019 %          = ON  : trial average is done  [Default]
0020 %          = OFF : No trial average
0021 %  trial   : trial number to load
0022 %            if empty, all trials are loaded  [Default]
0023 %  ix_area : (absolute) vertex index to load
0024 %            if empty, all vertices are loaded  [Default]
0025 %  verbose : verbose mode for trial file loading
0026 %            0 (No print) , 1 ('.') , 2 ('session , trial')
0027 % --- OUTPUT:
0028 % Jinfo : structure of current info
0029 %    .version   : Version of current file
0030 %    .curr_type : 'J-current' or 'Z-current'
0031 %    .tindex    : Subsampled indices
0032 %    .Lact      : # of current direction at one vertex in active region
0033 %    .Wact      : Smoothing filter matrix
0034 %    .ix_act    : Vertex index corresponding to Z-current
0035 %    .ix_act_ex : Vertex index corresponding to J-current
0036 %    .NJact     : # of (J/Z)-current vertices
0037 %    .Tsample   : Time sample index for 'Jact'
0038 %    .Ntrial    : # of trials
0039 %    .Nsession  : # of sessions
0040 %    .jactdir   : Current directory
0041 %    .SampleFreq: Sample Frequency [Hz]
0042 %    .Pretrigger: Pretrigger period
0043 %    .Tmsec     : Time in msec
0044 %    .trial     : Trial number to load (optional input for this function)
0045 %
0046 % Jact    : current timecourse
0047 %   Jact(Nact,Nsample)          for ave_mode = ON
0048 %   Jact(Nact,Nsample,Ntrials)  for ave_mode = OFF
0049 %     Nact     = Lact * Nvact,  Nvact = length(ix_act)
0050 %     Nsample  : # of time sample,
0051 %     Ntrials  : # of trials in all session]
0052 %
0053 %   Jact( n + Nvact*(i-1), t, :)
0054 %    current at the vertex 'ix_act(n)', 'i-th' direction, time index 't'
0055 %    Time sample in MEG data : Tsample(t)
0056 %    Time (ms)   in MEG data : Tmsec(t)
0057 %
0058 % 2007-3-5 Masa-aki Sato
0059 % 2008-7-9 Masa-aki Sato
0060 %  support all file types and old files
0061 % 2008-09-30 Taku Yoshioka
0062 %  Minor change for variables in Jinfo
0063 % 2010-03-01 M. Sato
0064 %  modified not to use Jinfo.ix_act_ex
0065 %
0066 % Copyright (C) 2011, ATR All Rights Reserved.
0067 % License : New BSD License(see VBMEG_LICENSE.txt)
0068 
0069 
0070 if ~exist('curr_type','var'), curr_type = 0; end;
0071 if ~exist('ave_mode','var'), ave_mode = ON; end;
0072 if ~exist('trial','var'), trial = []; end;
0073 if ~exist('ix_area','var'), ix_area = []; end;
0074 if ~exist('verbose','var'), verbose = 0; end;
0075 
0076 [J_type, file_type] = vb_load_current_type(currfile);
0077 %  J_type = 0 : J-current
0078 %  J_type = 1 : Z-current
0079 %  file_type = 0: single file
0080 %  file_type = 1: parent file with trial files
0081 
0082 [Jinfo] = vb_load_current_info(currfile);
0083 
0084 if ave_mode==OFF && file_type==1
0085   % trial mode & each trial current file
0086   if J_type==1
0087     [Jact,ix_act] = ...
0088         vb_load_current_z_tr(currfile,curr_type,trial,ix_area,verbose);
0089     Jinfo.curr_type = curr_type;
0090   else
0091     if curr_type==1,
0092       fprintf('No Z-current and J-current is returned\n');
0093     end
0094     [Jact,ix_act] = ...
0095         vb_load_current_j_tr(currfile,trial,ix_area,verbose);
0096     Jinfo.curr_type = 0;
0097   end
0098 else
0099   % single current file
0100   if J_type==1
0101     [Jact,ix_act] = ...
0102         vb_load_current_z(currfile,curr_type,ave_mode,trial,ix_area);
0103     Jinfo.curr_type = curr_type;
0104   else
0105     if curr_type==1,
0106       fprintf('No Z-current and J-current is returned\n');
0107     end
0108     [Jact,ix_act] = ...
0109         vb_load_current_j(currfile,ave_mode,trial,ix_area);
0110     Jinfo.curr_type = 0;
0111   end
0112 end
0113 
0114 Jinfo.trial = trial;
0115 Jinfo.NJact = length(ix_act);
0116

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