% STD_TOPO - uses TOPOPLOT to get the interpolated Cartesian grid of the
% specified component topo maps. The topo map grids are saved
% into a (.icatopo) file and a pointer to the file is stored
% in the EEG structure. If such a file already exists,
% loads the information from it.
%
% Returns the topo map grids of all the requested components. Also
% returns the EEG sub-structure etc (i.e EEG.etc), which is modified
% with a pointer to the float file and some information about the file.
% Usage:
% >> X = std_topo(EEG, components, option);
%
% % Returns the ICA topo map grid for a dataset.
% % Updates the EEG structure in the Matlab environment and re-saves
% Inputs:
% EEG - an EEG dataset structure.
% components - [numeric vector] components in the EEG structure to compute topo maps
% {default|[] -> all}
%
% Optional inputs
% 'recompute' - ['on'|'off'] force recomputing topo file even if it is
% already on disk.
% 'fileout' - [string] Path of the folder to save output. The default
% is EEG.filepath
% Outputs:
% X - the topo map grid of the requested ICA components, each grid is
% one ROW of X.
%
% File output: [dataset_name].icatopo
%
% Authors: Arnaud Delorme, SCCN, INC, UCSD, January, 2005
%
% See also TOPOPLOT, STD_ERP, STD_ERSP, STD_SPEC, STD_PRECLUST
% Copyright (C) Arnaud Delorme, SCCN, INC, UCSD, October 11, 2004, arno@sccn.ucsd.edu
%
% This file is part of EEGLAB, see http://www.eeglab.org
% for the documentation and details.
%
% Redistribution and use in source and binary forms, with or without
% modification, are permitted provided that the following conditions are met:
%
% 1. Redistributions of source code must retain the above copyright notice,
% this list of conditions and the following disclaimer.
%
% 2. Redistributions in binary form must reproduce the above copyright notice,
% this list of conditions and the following disclaimer in the documentation
% and/or other materials provided with the distribution.
%
% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
% THE POSSIBILITY OF SUCH DAMAGE.
function [X] = std_topo(EEG, comps, varargin)
if nargin < 1
help std_topo;
return;
end
if nargin > 2 && ( strcmpi(varargin{1}, 'none') || strcmpi(varargin{1}, 'gradient') || strcmpi(varargin{1}, 'laplacian') )
fprintf('std_topo: option to return gradient or laplacian is deprecated and ignored\n');
varargin = varargin(2:end);
end
g = finputcheck( varargin, { 'recompute' 'string' { 'on','off' } 'off' ; ...
'trialinfo' 'struct' [] []; ...
'fileout' 'string' [] EEG(1).filepath},...
'std_topo');
if ischar(g), error(g); end
% scan datasets
% -------------
all_topos = [];
for ind1 = 1:length(EEG)
indMatch = [];
for ind2 = 1:ind1-1
if isequal(EEG(ind1).icawinv, EEG(ind2).icawinv)
indMatch = ind2;
end
end
if isempty(comps)
compsToCompute = 1:size(EEG(ind1).icawinv,2);
else
compsToCompute = comps;
end
for k = compsToCompute
if isempty(indMatch)
% compute topo map grid (topoimage)
% ---------------------------------
chanlocs = EEG(ind1).chanlocs(EEG(ind1).icachansind);
if isempty( [ chanlocs.theta ] )
error('Channel locations are required for computing scalp topographies');
end
[~, grid, ~, Xi, Yi] = topoplot( EEG(ind1).icawinv(:,k), chanlocs, ...
'verbose', 'off',...
'electrodes', 'on' ,'style','both',...
'plotrad',0.55,'intrad',0.55,...
'noplot', 'on', 'chaninfo', EEG(ind1).chaninfo);
all_topos = setfield(all_topos, [ 'comp' int2str(k) '_grid' ], { ':' ':' ind1 }, grid);
all_topos = setfield(all_topos, [ 'comp' int2str(k) '_x' ] , Xi(:,1));
all_topos = setfield(all_topos, [ 'comp' int2str(k) '_y' ] , Yi(:,1));
else
grid = getfield(all_topos, [ 'comp' int2str(k) '_grid' ], { ':' ':' indMatch });
all_topos = setfield(all_topos, [ 'comp' int2str(k) '_grid' ], { ':' ':' ind1 }, grid);
end
end
end
% Save topos in file
% ------------------
all_topos.datatype = 'TOPO';
all_topos.trialinfo = g.trialinfo;
tmpfile = fullfile( g.fileout, [ EEG.filename(1:end-3) 'icatopo' ]);
std_savedat(tmpfile, all_topos);
Datasets
Models
