/
ft_inverse_dipolefit.m
381 lines (338 loc) · 15.7 KB
/
ft_inverse_dipolefit.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
function [estimate] = ft_inverse_dipolefit(sourcemodel, sens, headmodel, dat, varargin)
% FT_INVERSE_DIPOLEFIT performs an equivalent current dipole fit with a single
% or a small number of dipoles to explain an EEG or MEG scalp topography.
%
% Use as
% [estimate] = ft_inverse_dipolefit(sourcemodel, sens, headmodel, dat, ...)
% where
% sourcemodel is the input source model with a single or a few dipoles
% sens is the gradiometer or electrode definition, see FT_DATATYPE_SENS
% headmodel is the volume conductor definition, see FT_PREPARE_HEADMODEL
% dat is the data matrix with the ERP or ERF
% and
% estimate contains the estimated source parameters
%
% Additional input arguments should be specified as key-value pairs and can include
% 'display' = Level of display [ off | iter | notify | final ]
% 'optimfun' = Function to use [fminsearch | fminunc ]
% 'maxiter' = Maximum number of function evaluations allowed [ positive integer ]
% 'constr' = Structure with constraints
% 'metric' = Error measure to be minimised [ rv | var | abs ]
% 'checkinside' = Boolean flag to check whether dipole is inside source compartment [ 0 | 1 ]
% 'mleweight' = weight matrix for maximum likelihood estimation, e.g. inverse noise covariance
%
% These options influence the forward computation of the leadfield
% 'reducerank' = 'no' or number (default = 3 for EEG, 2 for MEG)
% 'backproject' = 'yes' or 'no', in the case of a rank reduction this parameter determines whether the result will be backprojected onto the original subspace (default = 'yes')
% 'normalize' = 'no', 'yes' or 'column' (default = 'no')
% 'normalizeparam' = parameter for depth normalization (default = 0.5)
% 'weight' = number or Nx1 vector, weight for each dipole position to compensate for the size of the corresponding patch (default = 1)
%
% The constraints on the source model are specified in a structure
% constr.symmetry = boolean, dipole positions are symmetrically coupled to each other
% constr.fixedori = boolean, keep dipole orientation fixed over whole data window
% constr.rigidbody = boolean, keep relative position of multiple dipoles fixed
% constr.mirror = vector, used for symmetric dipole models
% constr.reduce = vector, used for symmetric dipole models
% constr.expand = vector, used for symmetric dipole models
% constr.sequential = boolean, fit different dipoles to sequential slices of the data
%
% The maximum likelihood estimation implements
% - Lutkenhoner B. "Dipole source localization by means of maximum likelihood
% estimation I. Theory and simulations" Electroencephalogr Clin Neurophysiol. 1998
% Apr;106(4):314-21.
%
% See also FT_DIPOLEFITTING, FT_SOURCEANALYSIS, FT_PREPARE_HEADMODEL, FT_PREPARE_SOURCEMODEL
% Copyright (C) 2003-2016, Robert Oostenveld
%
% This file is part of FieldTrip, see http://www.fieldtriptoolbox.org
% for the documentation and details.
%
% FieldTrip 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.
%
% FieldTrip 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 FieldTrip. If not, see <http://www.gnu.org/licenses/>.
%
% $Id$
% It is necessary to provide backward compatibility support for the old function call
% in case people want to use it in conjunction with EEGLAB and the dipfit1 plugin.
% old style: function [estimate] = ft_inverse_dipolefit(sourcemodel, dat, sens, headmodel, constr), where constr is optional
% new style: function [estimate] = ft_inverse_dipolefit(sourcemodel, sens, headmodel, dat, varargin), where varargin is in key-value pairs
if nargin==4 && ~isstruct(sens) && isstruct(dat)
% looks like old style, the order of the input arguments has to be changed
ft_warning('converting from old style input\n');
olddat = sens;
oldsens = headmodel;
oldhdm = dat;
dat = olddat;
sens = oldsens;
headmodel = oldhdm;
elseif nargin==5 && ~isstruct(sens) && isstruct(dat)
% looks like old style, the order of the input arguments has to be changed
% furthermore the additional constraint has to be fixed
ft_warning('converting from old style input\n');
olddat = sens;
oldsens = headmodel;
oldhdm = dat;
dat = olddat;
sens = oldsens;
headmodel = oldhdm;
varargin = {'constr', varargin{1}}; % convert into a key-value pair
else
% looks like new style, i.e. with optional key-value arguments
% this is dealt with below
end
% get the optional input arguments, or use defaults
% these are for the optimization function
display = ft_getopt(varargin, 'display', 'iter');
optimfun = ft_getopt(varargin, 'optimfun' ); if isa(optimfun, 'char'), optimfun = str2func(optimfun); end
maxiter = ft_getopt(varargin, 'maxiter' );
% these are for the error function
constr = ft_getopt(varargin, 'constr' ); % default is not to have constraints
metric = ft_getopt(varargin, 'metric', 'rv' );
checkinside = ft_getopt(varargin, 'checkinside', false);
mleweight = ft_getopt(varargin, 'mleweight' ); % for maximum likelihood estimation
% these options are passed to OPTIMFUN and DIPFIT_ERROR, which pass them on to FT_COMPUTE_LEADFIELD
reducerank = ft_getopt(varargin, 'reducerank');
backproject = ft_getopt(varargin, 'backproject');
normalize = ft_getopt(varargin, 'normalize');
normalizeparam = ft_getopt(varargin, 'normalizeparam');
weight = ft_getopt(varargin, 'weight');
if isfield(constr, 'mirror')
% for backward compatibility
constr.symmetry = true;
end
constr.symmetry = ft_getopt(constr, 'symmetry', false);
constr.fixedori = ft_getopt(constr, 'fixedori', false);
constr.rigidbody = ft_getopt(constr, 'rigidbody', false);
constr.sequential = ft_getopt(constr, 'sequential', false);
if isempty(optimfun)
% determine whether the MATLAB Optimization toolbox is available and can be used
if ft_hastoolbox('optim')
optimfun = @fminunc;
else
optimfun = @fminsearch;
end
end
if isempty(maxiter)
% set a default for the maximum number of iterations, depends on the optimization function
if isequal(optimfun, @fminunc)
maxiter = 1000;
else
maxiter = 3000;
end
end
% determine whether it is EEG or MEG
iseeg = ft_senstype(sens, 'eeg');
ismeg = ft_senstype(sens, 'meg');
if ismeg && iseeg
% this is something that I might implement in the future
ft_error('simultaneous EEG and MEG not supported');
elseif iseeg
% ensure that the potential data is average referenced, just like the model potential
dat = avgref(dat);
end
% ensure correct dipole position and moment specification
sourcemodel = fixdipole(sourcemodel);
% convert the dipole model parameters into the non-linear parameter vector that will be optimized
[param, constr] = dipolemodel2param(sourcemodel.pos, sourcemodel.mom, constr);
% determine the scale for a typical step size of 1 cm
scale = ft_scalingfactor('cm', sens.unit);
% 'DiffMaxChange',scale*100,...
% 'DiffMinChange',scale/100,...
% set the parameters for the optimization function
if isequal(optimfun, @fminunc)
options = optimset(...
'TolFun',1e-9,...
'TypicalX',scale*ones(size(param)),...
'LargeScale','off',...
'HessUpdate','bfgs',...
'MaxIter',maxiter,...
'MaxFunEvals',2*maxiter*length(param),...
'Display',display);
elseif isequal(optimfun, @fminsearch)
options = optimset(...
'MaxIter',maxiter,...
'MaxFunEvals',2*maxiter*length(param),...
'Display',display);
else
ft_warning('unknown optimization function "%s", using default parameters', func2str(optimfun));
end
% perform the optimization with either the fminsearch or fminunc function
[param, fval, exitflag, output] = optimfun(@dipfit_error, param, options, dat, sens, headmodel, constr, metric, checkinside, mleweight, reducerank, normalize, normalizeparam, weight, backproject);
if exitflag==0
ft_error('Maximum number of iterations exceeded before reaching the minimum, please try with another initial guess.')
end
% do the linear optimization of the dipole moment parameters
% the error is not interesting any more, only the dipole moment is relevant
[err, mom] = dipfit_error(param, dat, sens, headmodel, constr, metric, checkinside, mleweight, reducerank, normalize, normalizeparam, weight, backproject);
% convert the non-linear parameter vector into the dipole model parameters
[pos, ori] = param2dipolemodel(param, constr);
% return the optimal dipole parameters
estimate.pos = pos;
% return the optimal dipole moment and (optionally) the orientation
if ~isempty(ori)
estimate.mom = ori; % dipole orientation as vector
estimate.ampl = mom; % dipole strength
else
estimate.mom = mom; % dipole moment as vector or matrix, which represents both the orientation and strength as vector
end
% ensure correct specification of dipole position and moment
estimate = fixdipole(estimate);
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% DIPOLEMODEL2PARAM takes the initial guess for the diople model and converts it
% to a set of parameters that needs to be optimized
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
function [param, constr] = dipolemodel2param(pos, ori, constr)
% reformat the position parameters in case of multiple dipoles, this
% should result in the matrix changing from [x1 y1 z1; x2 y2 z2] to
% [x1 y1 z1 x2 y2 z2] for the constraints to work
param = reshape(pos', 1, numel(pos));
% add the orientation to the nonlinear parameters
if constr.fixedori
numdip = size(pos,1);
for i=1:numdip
% add the orientation to the list of parameters
[th, phi, r] = cart2sph(ori(1,i), ori(2,i), ori(3,i));
param = [param th phi];
end
end
if constr.symmetry && constr.rigidbody
ft_error('simultaneous symmetry and rigidbody constraints are not supported')
elseif constr.symmetry
% reduce the number of parameters to be fitted according to the constraints
% select a subset, the other sources will be re-added by the const.mirror field
param = param(constr.reduce);
elseif constr.rigidbody
constr.coilpos = param; % store the head localizer coil positions
param = [0 0 0 0 0 0]; % start with an initial translation and rotation of zero
end
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% PARAM2DIPOLEMODEL takes the parameters and constraints and converts them into a
% diople model for which the leadfield and residual error can be computed
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
function [pos, ori] = param2dipolemodel(param, constr)
if constr.symmetry && constr.rigidbody
ft_error('simultaneous symmetry and rigidbody constraints are not supported')
elseif constr.symmetry
param = constr.mirror .* param(constr.expand);
elseif constr.rigidbody
numdip = numel(constr.coilpos)/3;
pos = reshape(constr.coilpos, 3, numdip); % convert from vector into 3xN matrix
pos(4,:) = 1;
transform = rigidbody(param); % this is a 4x4 homogenous transformation matrix
pos = transform * pos; % apply the homogenous transformation matrix
param = reshape(pos(1:3,:), 1, 3*numdip);
clear pos % the actual pos will be constructed from param further down
end
if constr.fixedori
numdip = numel(param)/5;
ori = zeros(3,numdip);
for i=1:numdip
th = param(end-(2*i)+1);
phi = param(end-(2*i)+2);
[ori(1,i), ori(2,i), ori(3,i)] = sph2cart(th, phi, 1);
end
pos = reshape(param(1:(numdip*3)), 3, numdip)'; % convert into a Ndip*3 matrix
else
numdip = numel(param)/3;
pos = reshape(param, 3, numdip)'; % convert into a Ndip*3 matrix
ori = [];
end
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% DIPFIT_ERROR computes the error between measured and model data
% and can be used for non-linear fitting of dipole position
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
function [err, mom] = dipfit_error(param, dat, sens, headmodel, constr, metric, checkinside, mleweight, reducerank, normalize, normalizeparam, weight, backproject)
% flush pending graphics events, ensure that fitting is interruptible
drawnow;
if ~isempty(get(0, 'currentfigure')) && strcmp(get(gcf, 'tag'), 'stop')
% interrupt the fitting
close;
ft_error('USER ABORT');
end
% convert the non-linear parameter vector into the dipole model parameters
[pos, ori] = param2dipolemodel(param, constr);
if checkinside
% check whether the dipole is inside the source compartment
isinside = ft_inside_headmodel(pos, headmodel);
isinside = all(isinside);
else
% assume that the dipole is inside the source compartment
isinside = true;
end
% construct the leadfield matrix for all dipoles
lf = ft_compute_leadfield(pos, sens, headmodel, 'reducerank', reducerank, 'normalize', normalize, 'normalizeparam', normalizeparam, 'weight', weight, 'backproject', backproject);
if ~isempty(ori)
lf = lf * ori;
end
if ~isinside
% set the leadfield to zero, this will cause the error to be as large as it can be
lf(:) = 0;
end
% compute the optimal dipole moment and the model error
if ~isempty(mleweight)
% maximum likelihood estimation using the weigth matrix
if constr.sequential
ft_error('not supported');
else
mom = pinv(lf'*mleweight*lf)*lf'*mleweight*dat; % Lutkenhoner equation 5
dif = dat - lf*mom;
end
% compute the generalized goodness-of-fit measure
switch metric
case 'rv' % relative residual variance
num = dif' * mleweight * dif;
denom = dat' * mleweight * dat;
err = sum(num(:)) ./ sum(denom(:)); % Lutkenhonner equation 7, except for the gof=1-rv
case 'var' % residual variance
num = dif' * mleweight * dif;
err = sum(num(:));
otherwise
ft_error('Unsupported error metric for maximum likelihood dipole fitting');
end
else
% ordinary least squares, this is the same as MLE with mleweight=eye(nchans,nchans)
if constr.sequential
% the number of slices is the same as the number of dipoles
% each slice has a number of frames (time points) in it
% so the data can be nchan*ndip or nchan*(ndip*nframe)
numdip = numel(pos)/3;
numframe = size(dat,2)/numdip;
% do a sainty check on the number of frames, see http://bugzilla.fieldtriptoolbox.org/show_bug.cgi?id=3119
assert(numframe>0 && numframe==round(numframe), 'the number of frames should be a positive integer');
mom = zeros(3*numdip, numdip*numframe);
for i=1:numdip
dipsel = (1:3) + 3*(i-1); % 1:3 for the first dipole, 4:6 for the second dipole, ...
framesel = (1:numframe) + numframe*(i-1); % 1:numframe for the first, (numframe+1):(2*numframe) for the second, ...
mom(dipsel,framesel) = pinv(lf(:,dipsel))*dat(:,framesel);
end
else
mom = pinv(lf)*dat;
end
dif = dat - lf*mom;
% compute the ordinary goodness-of-fit measures
switch metric
case 'rv' % relative residual variance
err = sum(dif(:).^2) / sum(dat(:).^2);
case 'var' % residual variance
err = sum(dif(:).^2);
case 'abs' % absolute difference
err = sum(abs(dif));
otherwise
ft_error('Unsupported error metric for dipole fitting');
end
end
if ~isreal(err)
% this happens for complex valued data, i.e. when fitting a dipole to spectrally decomposed data
% the error function should return a positive valued real number, otherwise fminunc fails
err = abs(err);
end