forked from fieldtrip/fieldtrip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ft_interpolatenan.m
130 lines (114 loc) · 6.89 KB
/
ft_interpolatenan.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
function dataout = ft_interpolatenan(cfg, datain)
% FT_INTERPOLATENAN interpolates data that contains segments of nans
% obtained by replacing artifactual data with nans using, for example, FT_REJECTARTIFACT,
% or by redefining trials with FT_REDEFINETRIAL resulting in trials with
% gaps.
%
% Use as
% outdata = ft_interpolatenan(cfg, indata)
% where indata is data as obtained from FT_PREPROCESSING
% and cfg is a configuratioun structure that should contain
%
% cfg.method = string, interpolation method, see HELP INTERP1 (default = 'linear')
% cfg.prewindow = value, length of data prior to interpolation window, in seconds (default = 1)
% cfg.postwindow = value, length of data after interpolation window, in seconds (default = 1)
%
%
% To facilitate data-handling and distributed computing with the peer-to-peer
% module, this function has the following options:
% cfg.inputfile = ...
% cfg.outputfile = ...
% If you specify one of these (or both) the input data will be read from a *.mat
% file on disk and/or the output data will be written to a *.mat file. These mat
% files should contain only a single variable, corresponding with the
% input/output structure.
%
% See also FT_REJECTARTIFACT, FT_REDEFINETRIAL
% Copyright (C) 2003-2011, Jan-Mathijs Schoffelen & Robert Oostenveld
%
% This file is part of FieldTrip, see http://www.ru.nl/neuroimaging/fieldtrip
% 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$
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% the initial part deals with parsing the input options and data
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
revision = '$Id$';
% do the general setup of the function
ft_defaults % this ensures that the path is correct and that the ft_defaults global variable is available
ft_preamble init % this will reset warning_once and show the function help if nargin==0 and return an error
ft_preamble provenance % this records the time and memory usage at the beginning of the function
ft_preamble trackconfig % this converts the cfg structure in a config object, which tracks the cfg options that are being used
ft_preamble debug % this allows for displaying or saving the function name and input arguments upon an error
ft_preamble loadvar datain % this reads the input data in case the user specified the cfg.inputfile option
% the abort variable is set to true or false in ft_preamble_init
if abort
return
end
% check if the input data is valid for this function
datain = ft_checkdata(datain, 'datatype', {'raw+comp', 'raw'}, 'feedback', 'yes', 'hassampleinfo', 'yes');
% check if the input is valid
cfg = ft_checkconfig(cfg, 'allowedval',{'method','nearest','linear','spline','pchip','cubic','v5cubic'});
cfg = ft_checkopt(cfg, 'prewindow', 'numericscalar');
cfg = ft_checkopt(cfg, 'postwindow', 'numericscalar');
% get the options
method = ft_getopt(cfg, 'method', 'linear'); % default is linear
prewindow = ft_getopt(cfg, 'prewindow', 1); % default is 1 second
postwindow = ft_getopt(cfg, 'postwindow', 1); % default is 1 seconds
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% the actual computation is done in the middle part
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
dataout = datain;
ntrl = numel(datain.trial);
prewindow = round(prewindow * datain.fsample); % Express window in samples
postwindow = round(postwindow * datain.fsample); % Express window in samples
% Let users know that the interpolation will start and initialize the
% progress indicator
fprintf('Initializing %s interpolation of %d trials\n',method,ntrl);
ft_progress('init', 'etf');
for i=1:ntrl
ft_progress(i/ntrl, 'Processing trial %d out of %d',i,ntrl);
nchan = size(datain.trial{i},1);
replace = isnan(datain.trial{i}); % Find samples that have been replaced by nans
if any(replace(:)) % Check whether any values should be interpolated
[idx_start_r, idx_start_c] = find(diff(replace,[],2)==1); % Determine onset of nan-chunk
[dum, idx_end_c] = find(diff(replace,[],2)==-1); % Determine offset of nan-chunk
idx_start_c = idx_start_c + 1; % correct for shift due to using diff
% Loop across found nan-chunks
for j=1:size(idx_start_c,1)
sample_window = [idx_start_c(j)-prewindow:idx_start_c(j)-1 idx_end_c(j)+1:idx_end_c(j)+postwindow]; % Indices of time-points used for interpolation
if any(sample_window<1) || any(sample_window>size(datain.trial{i},2)) % Check whether sampling window falls within data range
warning_once('Sample window partially outside of data-range, using less samples');
sample_window(sample_window<1|sample_window>size(datain.trial{i},2))=[];
elseif any(isnan(datain.trial{i}(idx_start_r(j),sample_window))) % Check whether sampling window overlaps with other chunk of nans
error('Sample window overlaps with other chunk of nans');
end;
fill_window = idx_start_c(j):idx_end_c(j); % Indices of time-points that will be interpolated
fill = interp1(sample_window, datain.trial{i}(idx_start_r(j),sample_window),fill_window,method); % Interpolation
dataout.trial{i}(idx_start_r(j),fill_window)=fill; % Add interpolated segments to dataout
end;
end;
end; % i=1:ntrl
ft_progress('close');
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Cleanup
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
ft_postamble debug % this clears the onCleanup function used for debugging in case of an error
ft_postamble trackconfig % this converts the config object back into a struct and can report on the unused fields
ft_postamble provenance % this records the time and memory at the end of the function, prints them on screen and adds this information together with the function name and MATLAB version etc. to the output cfg
ft_postamble previous datain % this copies the datain.cfg structure into the cfg.previous field. You can also use it for multiple inputs, or for "varargin"
ft_postamble history dataout % this adds the local cfg structure to the output data structure, i.e. dataout.cfg = cfg
ft_postamble savevar dataout % this saves the output data structure to disk in case the user specified the cfg.outputfile option