mfbox_hnmf_run.m

toolbox for spm 5 for data, model free analysis

function [params,A,W,S]=mfbox_hNMF_run(X,mask,params,runflag)
% run hyperspace NMF
%
% Usage:
%  [params,A,W,S]=mfbox_hNMF_run(X,mask,params,runflag)
%
%  X       - (NxT) data
%  mask    - data mask (XxYxZ) with sum(mask(:))==N
%  params  - struct with
%            numComponents - number of components
%            tolerance     - tolerance
%            restart       - restart count
%  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','hnmf', ...
    struct('numComponents',5,'numComponents_min',1, ...
    'numComponents_max',20,'numComponents_type','int', ...
    'tolerance',0,'tolerance_min',0,'tolerance_max',2, ...
    'tolerace_type','float','restart',5,'restart_min',0, ...
    'restart_max',10,'restart_type','int'));

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

if (runflag>0 && isstruct(params))
    n = params.numComponents;
    [S,A,W] = mfbox_hnmf(double(X'),'pcadim',n, ...
        'extractdim',n,'restart',params.restart, ...
        'tolerance',params.tolerance);
    S = S';
end