JiscMail Logo
Email discussion lists for the UK Education and Research communities

Help for SPM Archives


SPM Archives

SPM Archives


SPM@JISCMAIL.AC.UK


View:

Message:

[

First

|

Previous

|

Next

|

Last

]

By Topic:

[

First

|

Previous

|

Next

|

Last

]

By Author:

[

First

|

Previous

|

Next

|

Last

]

Font:

Monospaced Font

LISTSERV Archives

LISTSERV Archives

SPM Home

SPM Home

SPM  2006

SPM 2006

Options

Subscribe or Unsubscribe

Subscribe or Unsubscribe

Log In

Log In

Get Password

Get Password

Subject:

Re: SPM5 update to "LMGS" detrending

From:

Paul Macey <[log in to unmask]>

Reply-To:

Paul Macey <[log in to unmask]>

Date:

Tue, 11 Apr 2006 19:27:41 +0100

Content-Type:

multipart/mixed

Parts/Attachments:

Parts/Attachments

text/plain (426 lines)

Thanks to Marko Wilke, I've added a couple of features to the lmgs
detrending function I emailed earlier.

1) you can run multiple sessions
2) you can scale the detrended time-series to a grand mean
3) if you run "cspm_lmgs" without any input arguments, it runs in
interactive mode (you get a couple of options on the SPM GUI).
4) you can see the before/after timetrends in raw units and percent change

Hope this is useful!

Best wishes,
Paul


--6S8Jjwbn-jQjVu2JVLFVxrVJ:+Zjmf?kU-HtG?iE3jTat'thhFNRktl.Vt5U:62Vl1QKoA
Content-Transfer-Encoding: 7bit
Content-Type: TEXT/PLAIN;
 name="cspm_lmgs.m"

function cspm_lmgs(Pin,overwrite,prefix,display,GM)
% CSPM_LMGS - Detrend fMRI image series using LMGS method.
% CSPM_LMGS(P, OVERWRITE, PREFIX, DISPLAY, GRANDMEAN )
% P is array of images returned by spm, e.g. (SPM2):
% P = spm_get(Inf, '.img',{'Please select images for detrending'});
% You will be prompted for the files if the argument is omitted.
% To pass multiple sessions, set P as a cell array with each cell the
% files for one session, i.e. (SPM5):
% P{1} = = spm_select([3 Inf],'image','Select images for detrending (1st session)');
% P{2} = = spm_select([3 Inf],'image','Select images for detrending (2nd session)');
% P{3} = = spm_select([3 Inf],'image','Select images for detrending (3rd session)');
% OVERWRITE (optional) - defaults to true; if false and detrended
% images exist, detrending is skipped.
% PREFIX (optional) - prefix for detrended files; defaults to "d".
% DISPLAY (optional) - if true, global trends of raw and detrended
% data are plotted; defaults to false.
% GRANDMEAN (optional) - scale series to this mean (e.g., 100); default 0 (no scaling);
%
% The procedure applies the detrending to the time-series of files P, and writes
% detrended files prepended with PREFIX (defaults to "d").
%
% To run in interactive mode, type
% >>cspm_lmgs
% Interactive mode defaults to overwrite TRUE and prefix "d".
%
% If at least one input argument is provided (P), the routine will run in batch
% mode and use the defaults of any arguments not passed.
%
%
% LMGS (Linear Model of Global Signal) detrending is described in:
% P.M. Macey, K.E. Macey, R. Kumar, and R.M. Harper. A method for removal of
% global effects from fMRI time series. NeuroImage 22 (2004) 360-366.
%
% Works with SPM5 and SPM2.
%

% @(#)cspm_lmgs.m 1.2 Paul Macey 2006-04-11
% Thanks to marko Wilke for the bactch mode and grand mean scaling suggestions.

disp('========================================================================')
disp('LMGS-Detrending')
disp(' ')

% Check inputs
% Images
if nargin == 0
    overwrite = 1;
    prefix = 'd';
    num_sessions = spm_input('Number of sessions to detrend', 1, 'e', 1);
    for i = 1:num_sessions
        if strcmp(spm('ver'),'SPM5')
            Pall{i} = spm_select([3 Inf],'image',['Select images for detrending (session ',...
                int2str(i),')']);
        else
            Pall{i} = spm_get(Inf, '.img',['Select images for detrending (session ',...
                int2str(i),')']);
        end
        
        % Couple of checks
        if isempty(Pall{i}), return, end
        if length(Pall{i}) < 3
            msgbox('Detrending requires a time-series of images (multiple volumes)',...
                'LMGS',...
                'warn')
            i = i-1;
        end
        
    end
    display = spm_input('Show graphical results ?','+1','b',(' Yes| No'),[1 0],0);
    GM = spm_input('Grand mean session scaling (0 = none)', '+1', 'e', 0);

else
    % batch or silent mode
    if iscell(Pin)
        % Check case of cell array of filenames (i.e., one session)
        if min(size(Pin{1})) == 1
            Pall{1} = char(Pin);
        else
            Pall = Pin;
        end
    else
        % One session only
        Pall{1} = Pin;
    end
    num_sessions = length(Pall);
    % Flags, etc.
    if nargin < 2 || isempty(overwrite)
        overwrite = 1;
    end
    if nargin < 3 || isempty(prefix)
        prefix = 'd';
    else
        if ~ischar(prefix)
            msgbox('Invalid "Prefix" argument - need character',...
                'LMGS','warn')
            help cspm_lmgs
            return
        end
    end
    if nargin < 4
        display = 0;
    end
    if nargin < 5
        GM = 0;
    end
end


for i = 1:num_sessions
    if num_sessions > 1
        disp(['Detrending session ',int2str(i)])
    end
    detrend_onesession(Pall{i},overwrite,prefix,display,GM,i,num_sessions)
end

disp(' ')
disp('LMGS-Detrending complete.')
disp(' ')

% =========================================================================
function detrend_onesession(P,overwrite,prefix,display,GM,sn,num_sessions)

% Number of scans
nscan = size(P,1);

% Finish now if overwrite flag is false and files exist
if ~overwrite
    skip = 1;
    % Check for existing files
    for i = 1:nscan

        [pth,nm,ext] = fileparts(P(i,:));

        % Detrended
        newfname = [pth,'\',prefix,nm,ext];

        if ~exist(newfname,'file')
            skip = 0;
            break
        end
    end
    if skip, return, end
end

% Map volumes
V = spm_vol(P);
% Check similar dimensions, etc. (Taken from spm_imcalc_ui.)
if (strcmp(spm('ver'),'SPM5') && any(any(diff(cat(1,V.dim),1,1),1))) || ...
        (~strcmp(spm('ver'),'SPM5') && any(any(diff(cat(1,V.dim),1,1),1)&[1,1,1,0])) || ...
        any(any(any(diff(cat(3,V.mat),1,3),3)))
    msgbox('Images don''t have same dimmensions, orientation and voxel size - detrending cancelled.',...
        'LMGS','error')
    return
end

% Number of voxels
num_vox = prod(V(1).dim(1:3));

% Initialize - create independent variable X for model
% Global values
gt = cspm_globaltrend(P,0,0,0)';
% Remove offset
X = detrend(gt,'constant');
% Add Constant
X = [X ones(nscan,1)];

% Create output images
for i = 1:nscan
    Vnew = V(i);
    [pth,nm,ext] = fileparts(Vnew.fname);
    Vnew.fname = [pth,filesep,prefix,nm,ext];
    if strcmp(spm('ver'),'SPM99')
        Vout(i) = spm_create_image(Vnew);
    else
        Vout(i) = spm_create_vol(Vnew);
    end
end

adjustcount = 0;
num_vox_per_plane = num_vox / V(1).dim(3);
dim1 = V(1).dim(1);
dim2 = V(1).dim(2);
dim3 = V(1).dim(3);
dim12 = V(1).dim(1:2);
% Loop through planes
fprintf('\n%-60s','Detrending')
for z = 1:dim3
    fprintf('%s%-60s',char(sprintf('\b')*ones(1,60)),['Detrending plane ',int2str(z),' / ',int2str(dim3)])

    % Get raw data for plane across all volumes.
    for i = 1:nscan
        yn(:,:,i) = spm_slice_vol(V(i),spm_matrix([0 0 z]),dim12,0);
    end

    % Use 2-D array to speed processing.
    yadj = reshape(yn,num_vox_per_plane,nscan)';

    warning off
    % Perform detrending voxel-by-voxel in this plane
    for v = 1:num_vox_per_plane
        yvox = yadj(:,v);
        if any(yvox)
            b = regression(yvox,X);
            % The following would require the statistics toolbox:
            % [b,bint,r,rint,stats] = regress(yvox,X,0.05);
            % Test for positive effect - b(1);
            % Test for significance as p-value - - stats(3);
            % Test for correlation (R^2) - stats(1)
            % Optional: skip voxels that do not meet thresholds
            % if b(1) <= 0 | stats(3) > 0.8 | stats(1) < 0.3
            % continue
            % end
            yvoxmodel = b(1)*X(:,1);

            % Adjust time-series
            adjustcount = adjustcount + 1;
            yadj(:,v) = yvox - yvoxmodel;

        end
    end
    warning on
    yadj = reshape(yadj',dim1,dim2,nscan);

    % Write adjusted data
    for i = 1:nscan
        Vout(i) = spm_write_plane(Vout(i),yadj(:,:,i),z);
    end

end % End loop through planes
fprintf('%s%-60s',char(sprintf('\b')*ones(1,60)),'Detrending')
fprintf('%-60s\n','Done')

disp(['Adjusted ', int2str(adjustcount),...
    ' non-zero voxels (',int2str(num_vox),' total).'])
disp(' ')

% Save file names if displaying or scaling
if display || GM > 0
    for i = 1:nscan
        % Pin{i} = V(i).fname;
        Pd{i} = Vout(i).fname;
    end
end

% Close volumes, if SPM2
if strcmp(spm('ver'),'SPM2')
    spm_close_vol(V);
    spm_close_vol(Vout);
end

% Grand mean scaling
if GM > 0
    % Calculate required scale to set session mean to GM
    scale = GM/(mean(cspm_globaltrend(Pd,0,0,0)));
    % Scale each volume by this amount
    for i = 1:nscan
        V = spm_vol(Pd{i});
        V.pinfo(1:2,:) = V.pinfo(1:2,:)*scale;
        V = spm_create_vol(V);
        if strcmp(spm('ver'),'SPM2')
            spm_close_vol(V);
        end
    end
end

% Show in percent change the pre- and post-detrending global timetrends
if display
    
    % Get trends
    t1 = gt'; % Variable gt was calculated earlier.
    t2 = cspm_globaltrend(Pd,0,0,0)';

    b1 = mean(t1(1:end));
    b2 = mean(t2(1:end));

    % Percent change
    t1pc = 100*(t1 - b1)/b1;
    t2pc = 100*(t2 - b2)/b2;
    
    % For x-axis
    x = 1:length(gt);
    
    % Figure
    if num_sessions > 1
        titlestr = ['Effect of adjustment (session ',int2str(sn),')'];
    else
        titlestr = 'Effect of adjustment';
    end
    figure('NumberTitle','off','Name',titlestr)

    subplot(2,1,1)
    plot(x,t1,'b.-',x,t2,'r.-')
    title ('Raw values: Original and detrended images')
    legend('Raw (blue)','Adjusted (red)')
    
    subplot(2,1,2)
    plot(x,t1pc,'b.-',x,t2pc,'r.-')
    title ('Percent change: Original and detrended images (%)')
    legend('Raw (blue)','Adjusted (red)')
end

% =========================================================================
function gt = cspm_globaltrend( P, pc, usespm, display )
% CSPM_GLOBALTREND - Calculate and display global time trend of images.
% T = CSPM_GLOBALTREND( P, PC, SPM, DISPLAY)
% P - cell array of files, e.g.,
% P = spm_get(Inf, '.img',{'Please select images for detrending'});
% PC - flag 1 = percent change relative to mean (default),
% 0 = absolute value
% SPM - flag 1 = use spm_global (all voxels above 1/8 of maximum
% intensity; not very accurate)
% 0 = avearge of all voxels in volume (default)
% DISPLAY - flag 1 = make figure (default)
% 0 = no figure
% Output: T - global time trend

% @(#)cspm_globaltrend.m 1.0 Paul Macey 2005-08-01

% Calculate global trend of series of images
if nargin < 1
    if strcmp(spm('ver'),'SPM5')
        P = spm_select(Inf,'image','Select images for global trend calculation');
    else
        P = spm_get(Inf, '.img','Select images for global trend calculation');
    end
    if isempty(P), return, end
end
if iscell(P)
    P = char(P);
end
if nargin < 2
    pc = 1;
end
if nargin < 3
    usespm = 0;
end
if nargin < 4
    display = 1;
end

V = spm_vol(P);
for i = 1:length(V)
    % Note: spm_global estimates the mean after discounting voxels outside
    % the object using a criteria of greater than > (global mean)/8.
    % However, for large global signal changes, this does not accurately
    % estimate the global signal and LMGS detrending based on spm_global
    % does not remove all gobal components.
    if usespm
        gt(i) = spm_global(V(i));
    else
        Y = spm_read_vols(V(i));
        gt(i) = mean(mean(mean(Y)));
    end
end
if strcmp(spm('ver'),'SPM2')
    spm_close_vol(V);
end

if pc
    bl = mean(gt);
    gt = 100*(gt-bl)/bl;
    pstr = ' (% change)';
else
    pstr = ' (raw)';
end

if display
    figure('Name',['Global timetrend for ',int2str(length(V)),' files',pstr])
    plot(gt)
    ylabel(['Signal Intensity',pstr])
    xlabel('Scan Number')
end

if nargout == 0
    clear gt
end

% =========================================================================
function b = regression(y,X)
% Check that matrix (X) and left hand side (y) have compatible dimensions
% [n,p] = size(X);
% [n1,collhs] = size(y);
% if n ~= n1,
% error('The number of rows in Y must equal the number of rows in X.');
% end
%
% if collhs ~= 1,
% error('Y must be a vector, not a matrix');
% end

% Remove missing values, if any
wasnan = (isnan(y) | any(isnan(X),2));
if (any(wasnan))
    y(wasnan) = [];
    X(wasnan,:) = [];
    %n = length(y);
end

% Find the least squares solution.
[Q, R]=qr(X,0);
b = R\(Q'*y);



--6S8Jjwbn-jQjVu2JVLFVxrVJ:+Zjmf?kU-HtG?iE3jTat'thhFNRktl.Vt5U:62Vl1QKoA--

Top of Message | Previous Page | Permalink

JiscMail Tools


RSS Feeds and Sharing


Advanced Options


Archives

May 2024
April 2024
March 2024
February 2024
January 2024
December 2023
November 2023
October 2023
September 2023
August 2023
July 2023
June 2023
May 2023
April 2023
March 2023
February 2023
January 2023
December 2022
November 2022
October 2022
September 2022
August 2022
July 2022
June 2022
May 2022
April 2022
March 2022
February 2022
January 2022
December 2021
November 2021
October 2021
September 2021
August 2021
July 2021
June 2021
May 2021
April 2021
March 2021
February 2021
January 2021
December 2020
November 2020
October 2020
September 2020
August 2020
July 2020
June 2020
May 2020
April 2020
March 2020
February 2020
January 2020
December 2019
November 2019
October 2019
September 2019
August 2019
July 2019
June 2019
May 2019
April 2019
March 2019
February 2019
January 2019
December 2018
November 2018
October 2018
September 2018
August 2018
July 2018
June 2018
May 2018
April 2018
March 2018
February 2018
January 2018
December 2017
November 2017
October 2017
September 2017
August 2017
July 2017
June 2017
May 2017
April 2017
March 2017
February 2017
January 2017
December 2016
November 2016
October 2016
September 2016
August 2016
July 2016
June 2016
May 2016
April 2016
March 2016
February 2016
January 2016
December 2015
November 2015
October 2015
September 2015
August 2015
July 2015
June 2015
May 2015
April 2015
March 2015
February 2015
January 2015
December 2014
November 2014
October 2014
September 2014
August 2014
July 2014
June 2014
May 2014
April 2014
March 2014
February 2014
January 2014
December 2013
November 2013
October 2013
September 2013
August 2013
July 2013
June 2013
May 2013
April 2013
March 2013
February 2013
January 2013
December 2012
November 2012
October 2012
September 2012
August 2012
July 2012
June 2012
May 2012
April 2012
March 2012
February 2012
January 2012
December 2011
November 2011
October 2011
September 2011
August 2011
July 2011
June 2011
May 2011
April 2011
March 2011
February 2011
January 2011
December 2010
November 2010
October 2010
September 2010
August 2010
July 2010
June 2010
May 2010
April 2010
March 2010
February 2010
January 2010
December 2009
November 2009
October 2009
September 2009
August 2009
July 2009
June 2009
May 2009
April 2009
March 2009
February 2009
January 2009
December 2008
November 2008
October 2008
September 2008
August 2008
July 2008
June 2008
May 2008
April 2008
March 2008
February 2008
January 2008
December 2007
November 2007
October 2007
September 2007
August 2007
July 2007
June 2007
May 2007
April 2007
March 2007
February 2007
January 2007
2006
2005
2004
2003
2002
2001
2000
1999
1998


JiscMail is a Jisc service.

View our service policies at https://www.jiscmail.ac.uk/policyandsecurity/ and Jisc's privacy policy at https://www.jisc.ac.uk/website/privacy-notice

For help and support help@jisc.ac.uk

Secured by F-Secure Anti-Virus CataList Email List Search Powered by the LISTSERV Email List Manager