https://github.com/epnev/ca_source_extraction
Raw File
Tip revision: 49b7884e93348d50df7173e1619d7499468bb1f6 authored by epnev on 22 August 2019, 14:24:41 UTC
fix bug introduced with 9e524e29f17d35db3c79a87de32209c7dccda186
Tip revision: 49b7884
update_temporal_components_fast.m
function [C,f,P,S,YrA] = update_temporal_components_fast(Y,A,b,Cin,fin,P,options)

% update temporal components and background given spatial components
% For each component a 1-d trace is computed by removing
% the effect of all the other components and then averaging with the corresponding 
% spatial footprint. Then each trace is denoised. This corresponds to a block-coordinate approach
% 4 different 1-d approaches are included, and any custom method
% can be easily incorporated:
% 'constrained_foopsi':     The noise constrained deconvolution approach is used. Time constants can be re-estimated (default)
% 'MCMC':                   A fully Bayesian method (slowest, but usually most accurate)

% INPUTS:
% Y:        raw data ( d X T matrix)
% A:        spatial footprints  (d x nr matrix)
% b:        spatial background  (d x 1 vector)
% Cin:      current estimate of temporal components (nr X T matrix)
% fin:      current estimate of temporal background (1 x T vector)
% P:        struct for neuron parameters
% options:  struct for algorithm parameters

% LD:       Lagrange multipliers (needed only for 'noise_constrained' method).
% 
% OUTPUTS:
% C:        temporal components (nr X T matrix)
% f:        temporal background (1 x T vector)
% P:        struct for neuron parameters
% S:        deconvolved activity

% Written by: 
% Eftychios A. Pnevmatikakis, Simons Foundation, 2016

defoptions = CNMFSetParms;
if nargin < 7 || isempty(options); options = defoptions; end


if isa(Y,'char')
    [~,~,ext] = fileparts(Y);
    ext = ext(2:end);
    if strcmpi(ext,'tif') || strcmpi(ext,'tiff')
        tiffInfo = imfinfo(Y);
        filetype = 'tif';
        T = length(tiffInfo);
        sizY = [tiffInfo(1).Height,tiffInfo(1).Width,T];
    elseif strcmpi(ext,'mat')
        filetype = 'mem';
        Y = matfile(Y,'Writable',true);
        sizY = size(Y);
        T = sizY(end);
    elseif strcmpi(ext,'hdf5') || strcmpi(ext,'h5')
        filetype = 'hdf5';
        fileinfo = hdf5info(Y);
        data_name = fileinfo.GroupHierarchy.Datasets.Name;
        sizY = fileinfo.GroupHierarchy.Datasets.Dims;
        T = sizY(end);
    elseif strcmpi(ext,'raw')
        filetype = 'raw';
        fid = fopen(Y);
        bitsize = 2;
        imsize = d*bitsize;                                                   % Bit size of single frame
        current_seek = ftell(fid);
        fseek(fid, 0, 1);
        file_length = ftell(fid);
        fseek(fid, current_seek, -1);
        T = file_length/imsize;
        if d3 == 1; sizY = [d1,d2,T]; nd = 2; elseif d3 > 1; sizY = [d1,d2,d3,T]; nd = 3; end
        fclose(fid);
    end    
elseif isobject(Y)
    filetype = 'mem';
    sizY = size(Y,'Y');
    T = sizY(end);
else % array loaded in memory
    filetype = 'mat';
    Y = double(Y);
    sizY = size(Y);
    T = sizY(end);
end

options.d1 = sizY(1);
options.d2 = sizY(2);
if length(sizY) > 3
    options.d3 = sizY(3);
end
d1 = options.d1;
d2 = options.d2;
d3 = options.d3;
d = prod([d1,d2,d3]);

if nargin < 6 || isempty(P)
    active_pixels = find(sum(A,2));                                 % pixels where the greedy method found activity
    unsaturated_pixels = find_unsaturatedPixels(Y);                 % pixels that do not exhibit saturation
    options.pixels = intersect(active_pixels,unsaturated_pixels);   % base estimates only on unsaturated, active pixels                
end

if ~isfield(options,'deconv_method') || isempty(options.deconv_method); method = defoptions.deconv_method; else method = options.deconv_method; end  % choose method
if ~isfield(options,'bas_nonneg'); options.bas_nonneg = defoptions.bas_nonneg; end
if ~isfield(options,'fudge_factor'); options.fudge_factor = defoptions.fudge_factor; end

K = size(A,2);
if K == 0    
    C = [];
    if exist('fin','var'); f = fin; else f = []; end
    S = [];
    YrA = [];
    P.b = [];
    P.c1 = [];
    P.neuron_sn = [];
    P.gn = [];
    return
end

ff = find(sum(A)==0);
if ~isempty(ff)
    A(:,ff) = [];
    if exist('Cin','var')
        if ~isempty(Cin)
            Cin(ff,:) = [];
        end
    end
end

% estimate temporal (and spatial) background if they are not present
if nargin < 5 || isempty(fin)           % temporal background missing
    if nargin < 3 || isempty(b)
        fin = mm_fun(ones(d,1),Y);
        fin = fin/norm(fin);
        b = max(mm_fun(fin,Y),0);
        options.nb = 1;
    else
        fin = max(b(bk_pix,:)'*Y(bk_pix,:),0)/(b(bk_pix,:)'*b(bk_pix,:));
    end
end

% construct product A'*Y

K = size(A,2);
nb = size(b,2);

AY = mm_fun([A,double(b)],Y);
bY = AY(K+1:end,:);
AY = AY(1:K,:);

if  nargin < 4 || isempty(Cin)   % estimate temporal components if missing    
    Cin = max((A'*A)\double(AY - (A'*b)*fin),0);  
end

A = [A,double(b)];
S = zeros(size(Cin));
Cin = [Cin;fin];
C = Cin;

AA = (A'*A);
AY = [AY;bY];

if strcmpi(method,'constrained_foopsi')
    P.gn = cell(K,1);
    P.b = num2cell(zeros(K,1));
    P.c1 = num2cell(zeros(K,1));           
    P.neuron_sn = num2cell(zeros(K,1));
end
if strcmpi(method,'MCMC')        
    params.B = 300;
    params.Nsamples = 400;
    params.p = P.p;
    params.bas_nonneg = options.bas_nonneg;
else
    params = [];
end

p = options.p;
%options.p = P.p;
C = double(C);

C = HALS_temporal(AY, A, C, 100, [], options.bas_nonneg, true);
use_OASIS = true;
if p > 0
    YrA = bsxfun(@times, 1./sum(A.^2)',AY - AA*C);
    if options.temporal_parallel
        C = mat2cell(C,ones(size(C,1),1),T);
        YrA = mat2cell(YrA,ones(size(C,1),1),T);
        S = cell(K,1);   
        b = cell(K,1);
        c1 = cell(K,1);
        gn = cell(K,1);
        neuron_sn = cell(K,1);
        
        parfor ii = 1:K+nb
            Ytemp = C{ii} + YrA{ii};
            if ii <= K
                %fprintf(num2str(ii))
                if strcmpi(method,'MCMC')
                    samples_mcmc = deal(struct('lam_', [], 'spiketimes_', [], 'A_', [], 'b_', [], 'C_in', [], 'sg', [], 'g', []));
                end                 
                switch method
                    case 'constrained_foopsi'
                        if use_OASIS
                            if p == 1; model_ar = 'ar1'; elseif p == 2; model_ar = 'ar2'; else error('non supported AR order'); end
                            spkmin = 0.5*GetSn(Ytemp);
                            [cc, spk, opts_oasis] = deconvolveCa(Ytemp,model_ar,'optimize_b',true,'method','thresholded',...
                                    'optimize_pars',true,'maxIter',100,'smin',spkmin);    
                            cb = opts_oasis.b;
                            C{ii} = full(cc(:)' + cb);
                            S{ii} = spk(:)';
                            b{ii} = cb;
                            c1{ii} = 0;
                            neuron_sn{ii} = opts_oasis.sn;
                            gn{ii} = opts_oasis.pars(:)';                            
                        else
                            [cc,b_temp,c1_temp,gn_temp,neuron_sn_temp,spk] = constrained_foopsi(Ytemp,[],[],[],[],options);
                            gd = max(roots([1,-gn_temp']));  % decay time constant for initial concentration
                            gd_vec = gd.^((0:T-1));
                            C{ii} = full(cc(:)' + b_temp + c1_temp*gd_vec);
                            S{ii} = spk(:)';
                            b{ii} = b_temp;
                            c1{ii} = c1_temp;
                            neuron_sn{ii} = neuron_sn_temp;
                            gn{ii} = gn_temp;
                        end
                    case 'MCMC'
                        SAMPLES = cont_ca_sampler(Ytemp,params);
                        ctemp = make_mean_sample(SAMPLES,Ytemp);
                        C{ii} = ctemp(:)';
                        S{ii} = mean(samples_cell2mat(SAMPLES.ss,T));
                        b{ii} = mean(SAMPLES.Cb);
                        c1{ii} = mean(SAMPLES.Cin);
                        neuron_sn{ii} = sqrt(mean(SAMPLES.sn2));
                        gr = mean(exp(-1./SAMPLES.g));
                        gp = poly(gr);
                        gn{ii} = -gp(2:end);
                        samples_mcmc(ii) = SAMPLES; % FN added, a useful parameter to have.
                end                
            else
                C{ii} = max(Ytemp(:),0)';
            end
        end
        C = cell2mat(C);
        S = cell2mat(S);
        %YrA = cell2mat(YrA);
        P.b = b;
        P.c1 = c1;
        P.neuron_sn = neuron_sn;
        P.gn = gn;
    else
        for ii = 1:K+nb
            Ytemp = C(ii,:) + YrA(ii,:);
            if ii <= K
                switch method
                     case 'constrained_foopsi'
                        if use_OASIS
                            if p == 1; model_ar = 'ar1'; elseif p == 2; model_ar = 'ar2'; else error('non supported AR order'); end
                            spkmin = 0.5*GetSn(Ytemp);
                            [cc, spk, opts_oasis] = deconvolveCa(Ytemp,model_ar,'optimize_b',true,'method','thresholded',...
                                    'optimize_pars',true,'maxIter',100,'smin',spkmin);    
                            cb = opts_oasis.b;
                            C(ii,:) = full(cc(:)' + cb);
                            S(ii,:) = spk(:)';
                            P.b{ii} = cb;
                            P.c1{ii} = 0;
                            P.neuron_sn{ii} = opts_oasis.sn;
                            P.gn{ii} = opts_oasis.pars(:)';
                        else
                            try 
                                 if restimate_g
                                    [cc,cb,c1,gn,sn,spk] = constrained_foopsi(Ytemp,[],[],[],[],options);
                                    P.gn{ii} = gn;
                                else
                                    [cc,cb,c1,gn,sn,spk] = constrained_foopsi(Ytemp,[],[],P.g,[],options);
                                 end
                            catch
                                options2 = options;
                                options2.p = 0;
                                [cc,cb,c1,gn,sn,spk] = constrained_foopsi(Ytemp,[],[],0,[],options2);
                                 P.gn{ii} = gn;
                            end
                            gd = max(roots([1,-gn']));  % decay time constant for initial concentration
                            gd_vec = gd.^((0:T-1));
                            C(ii,:) = full(cc(:)' + cb + c1*gd_vec);
                            S(ii,:) = spk(:)';
                            P.b{ii} = cb;
                            P.c1{ii} = c1;           
                            P.neuron_sn{ii} = sn;
                        end
                    case 'MCMC'
                        SAMPLES = cont_ca_sampler(Ytemp,params);
                        ctemp = make_mean_sample(SAMPLES,Ytemp);
                        C(ii,:) = ctemp';
                        S(ii,:) = mean(samples_cell2mat(SAMPLES.ss,T));
                        P.b{ii} = mean(SAMPLES.Cb);
                        P.c1{ii} = mean(SAMPLES.Cin);
                        P.neuron_sn{ii} = sqrt(mean(SAMPLES.sn2));
                        gr = mean(exp(-1./SAMPLES.g));
                        gp = poly(gr);
                        P.gn{ii} = -gp(2:end);
                        P.samples_mcmc(ii) = SAMPLES; % FN added, a useful parameter to have.
                end            
            else
                C(ii,:) = max(Ytemp(:),0)';
            end
        end
    end
else
    warning('No deconvolution is performed. \n');
end

YrA = bsxfun(@times, 1./sum(A.^2)',AY - AA*C);
f = C(K+1:end,:);
C = C(1:K,:);
YrA = YrA(1:K,:);
back to top