ITE / code / H_I_D / meta_estimators / Icomplex_initialization.m

Full commit
function [co] = Icomplex_initialization(mult)
%Initialization of the complex "meta" mutual information estimator. The estimator is
%   1)constructed from a real-valued (vector) mutual information estimator.
%   2)treated as a cost object (co). 

%Here, we make use of the naming convention 'I<name>_estimation', to ease embedding new mutual information estimation methods.
%   mult: is a multiplicative constant relevant (needed) in the estimation; '=1' means yes, '=0' no.
%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 <>.

%mandatory fields: = 'complex';
    co.mult = mult;
%other fields:    
    co.member_name = 'KCCA'; %you can change it to any mutual information estimator 
    co.member_co = I_initialization(co.member_name,mult);