mfbox_hrfica_run.m

toolbox for spm 5 for data, model free analysis

function [params,A,W,S]=mfbox_hrfica_run(X,mask,params,runflag)
% run hrf adjusted ica
%
% Usage:
%  [params,A,W,S]=mfbox_hrfica_run(X,mask,params,runflag)
%
%  X       - (NxT) data
%  mask    - data mask (XxYxZ) with sum(mask(:))==N
%  params  - struct with
%            numComponents - number of components
%            timestep      - hrf scaling
%            maxiter       - maxiter
%            delta         - delta
%            alpha         - alpha
%  runflag - -1 get default parameter
%             0 interactive ask parameters
%             1 interactive ask parameters and run
%             2 run
%
% Copyright by Peter Gruber and Fabian J. Theis
% Signal Processing & Information Theory group
% Institute of Biophysics, University of Regensburg, Germany
% Homepage: http://research.fabian.theis.name
%           http://www-aglang.uni-regensburg.de
%
% This file is free software, subject to the 
% GNU GENERAL PUBLIC LICENSE, see gpl.txt

error(nargchk(1,4,nargin));
error(nargchk(1,4,nargout));

A = [];
W = [];
S = [];

s = size(X);
dim = s(1:(end-1));
if (length(dim)==1), dim = [dim,1]; end
n = s(end);

if (nargin<2), mask = logical(ones(dim)); end
if (nargin<3), params = []; end
if (nargin<4), runflag = 1; end

params = mfbox_checkparam(params,'mf','hrfica', ...
    struct('numComponents',10,'numComponents_min',1, ...
    'numComponents_max',20,'numComponents_type','int', ...
    'timestep',2','timestep_min',1,'timestep_max',10, ...
    'timestep_type','int','maxiter',500,'maxiter_min',100, ...
    'maxiter_max',1000,'maxiter_type','int','delta',0.01, ...
    'delta_min',0.0001,'delta_max',0.1,'delta_type','float', ...
    'alpha',0.25,'alpha_min',0.1,'alpha_max',0.5,'alpha_type', ...
    'float'),'experimental');

if (abs(runflag-0.5)<1)
    if (exist('OCTAVE_HOME')~=5)% matlab
        params = mfbox_hrficag(X,mask,params,runflag);
    elseif (exist('OCTAVE_HOME')==5) %octave
        [params,runflag] = mfbox_getparam(params,runflag);
    end
end

if (runflag>0 && isstruct(params))
    hrf = mfbox_hrf(params.timestep);
    plotting = 'on'; if (runflag>2), plotting = 'off'; end
    [S,A,W] = mfbox_constraintica(X,'lasteig', ...
        params.numComponents,'constraint',hrf(1:min(n,length(hrf))), ...
        'maxiter',params.maxiter,'delta',params.delta,'alpha', ...
        params.alpha,'verbose',plotting);
    if (strcmp(plotting,'on')), close(f); end
end