ITE / code / IPA / demos / estimate_complex_ISA_C.m

function [e_hat,W_hat,de_hat] = estimate_complex_ISA_C(x,ICA_method,opt_type,cost_type,cost_name,unknown_dimensions,de)
%Estimates the complex ISA model. Method: complex ICA + clustering of the complex ICA elements (=complex ISA separation theorem).
%   x: x(:,t) is the observation at time t.
%   ICA_method: the name of the ICA method applied, see 'estimate_ICA.m'.
%   cost_type, cost_name, opt_type: cost type, cost name, optimization  type. Example: cost_type = 'sumH', cost_name = 'Renyi_kNN_1tok', opt_type = 'greedy' means that we use an entropy sum ISA formulation ('sumH'), where the entropies are estimated Renyi entropies via kNN methods ('Renyi_kNN_1tok') and the optimization is greedy; see also 'demo_ISA.m'
%   unknown_dimensions: '0' means 'the subspace dimensions are known'; '1' means 'the number of the subspaces are known' (but the individual dimensions are unknown).
%   de: 
%       1)in case of 'unknown_dimensions = 0': 'de' contains the subspace dimensions.
%       2)in case of 'unknown_dimensions = 1': the length of 'de' must be equal to the number of subspaces, but the coordinates of the vector can be arbitrary.
%   e_hat: e_hat(:,t) is the estimated ISA source at time t.
%   W_hat: estimated ISA demixing matrix.
%   de_hat: in case of known subspace dimensions ('unknown_dimensions = 0') de_hat = de; else it contains the estimated subspace dimensions; ordered increasingly.
%   Zoltan Szabo, Barnabas Poczos, and Andras Lorincz. Undercomplete Blind Subspace Deconvolution. Journal of Machine Learning Research 8(May):1063-1095, 2007.
%Copyright (C) 2012 Zoltan Szabo ("", "szzoli (at) cs (dot) elte (dot) hu")
%This file is part of the ITE (Information Theoretical Estimators) Matlab/Octave toolbox.
%ITE is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
%the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
%This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
%MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
%You should have received a copy of the GNU General Public License along with ITE. If not, see <>.

disp('Complex ISA estimation: started.');

%complex ICA step (e_ICA,W_ICA):
    [e_ICA,W_ICA] = estimate_complex_ICA(x,ICA_method);

%clustering of the ICA elements (=permutation search; perm_ICA):
    switch unknown_dimensions
        case 0
            perm_ICA = clustering_UD0(e_ICA,de,opt_type,cost_type,cost_name);%'UD0': unknown_dimensions=0
            de_hat = de;%it is given
        case 1
            if strcmp(cost_type,'Ipairwise1d')
                [perm_ICA,de_hat] = clustering_UD1(e_ICA,num_of_comps,opt_type,cost_name);%'UD1': unknown_dimensions=1                    
                [de_hat,per] = sort_subspaces_dimensions(de_hat);%sort the subspaces in increasing order with respect to their dimensions.
                perm_ICA = perm_ICA(per);%apply permutation 'perm_ICA' and then permutation 'per'
                disp('Error: cost type=?');
            disp('Error: unknown dimensions=?');
%estimated ISA source(e_hat), ISA demixing matrix (W_hat):        
    e_hat = e_ICA(perm_ICA,:);
    W_hat = W_ICA(perm_ICA,:); 
disp('Complex ISA estimation: ready.');