function [c,t,i,CC,LL] = interferogram(c, width, timestep, masterIdx)
   
   % C = INTERFEROGRAM(C)
   % This function calculates an interferogram from the waveforms in a
   % correlation object against the a single "master" trace.
   %
   % The routine interatively selects a narrow time window on all traces,
   % carries out a cross-correlation, and stores the maximum correlation value
   % and the time lag necessary to acheive this best fit for each time window.
   % All cross correlations include sub-sample interpolation of lag values
   % (see HELP XCORR for details). The results are two matrices of correlation
   % value and lag time. These can be plotted with the C-INTERFER and
   % L-INTERFER options in correlation plot.
   %
   % [C,TIME,INDEX,MAXCORR,LAG] = INTERFEROGRAM(C,...) In addition to the
   % correlation object, this use returns a vector of window center times
   % relative to trigger times (1xM), a vector of trace indices (Nx1), a
   % matrix of maximum correlation values (NxM), and a matrix of optimum lag
   % times (NxM). These values can be used to generate a custom interferogram
   % figure, for example:
   %    imagesc(TIME,INDEX,MAXCORR)
   %
   % [C ...] = INTERFEROGRAM(C,WIDTH) Specify the half width of the time window
   % explicitly. Default value is 1/20 of the mean trace length.
   %
   % [C ...] = INTERFEROGRAM(C,WIDTH,TIMESTEP) Specify the timestep interval
   % explicitly. If TIMESTEP is a scalar, it is treated as the interval
   % between adjacent time windows. If TIMESTEP is a vector, the values are
   % treated as the specific center time times of each window.
   %
   % [C ...] = INTERFEROGRAM(C,WIDTH,TIMESTEP,TRACENUM) Specify which trace
   % should be treated as the master trace against which all correlation
   % values will be based.
   %
   % ** NOTE ABOUT DATA STORAGE **
   % The interferogram routine by default places the four output terms
   % (TIME,INDEX,MAXCORR and LAG) into supplimental fields in the waveform
   % object which holds the first trace. This is embarassingly clunky. However
   % it works and allows the data to be passed directly to the plotting
   % routine. These terms can always be accessed by extracting them from the
   % first waveform using the field names INTERFEROGRAM_TIME,
   % INTERFEROGRAM_INDEX, INTERFEROGRAM_MAXCORR, INTERFEROGRAM_LAG. Because of
   % this ad hoc structure though, in many cases it may be better to simply
   % save the data straight out of the routine and handle it yourself. It is
   % automatically placed in the first waveform however to fascilitate a quick
   % plotting option. INTERFEROGRAM_TIME is given in units of seconds relative
   % to the trigger time.
   
   % Author: Michael West, Geophysical Institute, Univ. of Alaska Fairbanks
   % $Date$
   % $Revision$
   
   
   % GET INPUT PARAMETERS
   
   
   % TEST FOR ALIGNED TRACES
   if ~check(c,'OFFSET')
      disp('Data not uniformly aligned around triggers. Consider using CROP function.');
   end
   
   
   % SET WINDOW WIDTH
   srt_offset = ( c.traces.firstsampletime() - c.trig ) * 86400;
   end_offset = ( c.traces.lastsampletime() - c.trig ) * 86400;
   
   if ~exist('width','var') || isempty(width)
      width = ( mean(end_offset)-mean(srt_offset) ) / 20;
   end
   
   
   if ~exist('timestep','var') || isempty('length')
      timestep = ( mean(end_offset)-mean(srt_offset) ) / 50;
   end
   
   if length(timestep)  > 1
      % user specified center time for each window
      t = timestep;
   else
      t = mean(srt_offset) : timestep : mean(end_offset);
   end
   
   if ~exist('masterIdx','var')
      masterIdx = c.ntraces; % last trace
   end
   
   fprintf('Time step: %4.3f    Window width: %4.3f    Reference trace no.: %2d\n', timestep, width, masterIdx); 
   
   % CALC INTERFEROGRAM VOLUME
   CC = [];
   LL = [];
   times = [];
   for i = 1:length(t);
      times = cat(1,times,t(i));
      if (mod(i,10)==1)
         disp(['Center of time window: ' num2str(t(i),'%4.3f') ' ...']);
      end
      ctmp = c.crop(t(i)-width,t(i)+width);
      ctmp = xcorr(ctmp,'row',masterIdx);
      corr = ctmp.corrmatrix;
      lag  = ctmp.lags;
      CC(:,i) = corr(:,masterIdx);
      LL(:,i) = lag(:,masterIdx);
   end;
   
   
   % PLACE OUTPUT INTO FIRST WAVEFORM FIELD
   i = [1:c.ntraces]';
   T = c.traces(1);
   T.userdata.interferogram_index = i;
   T.userdata.interferogram_time = t;
   T.userdata.interferogram_maxcorr = CC;
   T.userdata.interferogram_lag = LL;
   c.traces(1) = T;
end

geoscience-community-codes
github-repos/MATLAB/geoscience-community-codes-GISMO/GISMO-a4eafca9d2ac85079253510005ef00aa9998d030/core/dev/@NewCorrelation/interferogram.m
GISMO
github-repos/MATLAB/geoscience-community-codes-GISMO
a4eafca9d2ac85079253510005ef00aa9998d030