coherencyc.m 4.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. function [C,phi,S12,S1,S2,f,confC,phistd,Cerr]=coherencyc(data1,data2,params)
  2. % Multi-taper coherency,cross-spectrum and individual spectra - continuous process
  3. %
  4. % Usage:
  5. % [C,phi,S12,S1,S2,f,confC,phistd,Cerr]=coherencyc(data1,data2,params)
  6. % Input:
  7. % Note units have to be consistent. See chronux.m for more information.
  8. % data1 (in form samples x trials) -- required
  9. % data2 (in form samples x trials) -- required
  10. % params: structure with fields tapers, pad, Fs, fpass, err, trialave
  11. % - optional
  12. % tapers : precalculated tapers from dpss or in the one of the following
  13. % forms:
  14. % (1) A numeric vector [TW K] where TW is the
  15. % time-bandwidth product and K is the number of
  16. % tapers to be used (less than or equal to
  17. % 2TW-1).
  18. % (2) A numeric vector [W T p] where W is the
  19. % bandwidth, T is the duration of the data and p
  20. % is an integer such that 2TW-p tapers are used. In
  21. % this form there is no default i.e. to specify
  22. % the bandwidth, you have to specify T and p as
  23. % well. Note that the units of W and T have to be
  24. % consistent: if W is in Hz, T must be in seconds
  25. % and vice versa. Note that these units must also
  26. % be consistent with the units of params.Fs: W can
  27. % be in Hz if and only if params.Fs is in Hz.
  28. % The default is to use form 1 with TW=3 and K=5
  29. %
  30. % pad (padding factor for the FFT) - optional (can take values -1,0,1,2...).
  31. % -1 corresponds to no padding, 0 corresponds to padding
  32. % to the next highest power of 2 etc.
  33. % e.g. For N = 500, if PAD = -1, we do not pad; if PAD = 0, we pad the FFT
  34. % to 512 points, if pad=1, we pad to 1024 points etc.
  35. % Defaults to 0.
  36. % Fs (sampling frequency) - optional. Default 1.
  37. % fpass (frequency band to be used in the calculation in the form
  38. % [fmin fmax])- optional.
  39. % Default all frequencies between 0 and Fs/2
  40. % err (error calculation [1 p] - Theoretical error bars; [2 p] - Jackknife error bars
  41. % [0 p] or 0 - no error bars) - optional. Default 0.
  42. % trialave (average over trials when 1, don't average when 0) - optional. Default 0
  43. % Output:
  44. % C (magnitude of coherency - frequencies x trials if trialave=0; dimension frequencies if trialave=1)
  45. % phi (phase of coherency - frequencies x trials if trialave=0; dimension frequencies if trialave=1)
  46. % S12 (cross spectrum - frequencies x trials if trialave=0; dimension frequencies if trialave=1)
  47. % S1 (spectrum 1 - frequencies x trials if trialave=0; dimension frequencies if trialave=1)
  48. % S2 (spectrum 2 - frequencies x trials if trialave=0; dimension frequencies if trialave=1)
  49. % f (frequencies)
  50. % confC (confidence level for C at 1-p %) - only for err(1)>=1
  51. % phistd - theoretical/jackknife (depending on err(1)=1/err(1)=2) standard deviation for phi.
  52. % Note that phi + 2 phistd and phi - 2 phistd will give 95% confidence
  53. % bands for phi - only for err(1)>=1
  54. % Cerr (Jackknife error bars for C - use only for Jackknife - err(1)=2)
  55. if nargin < 2; error('Need data1 and data2'); end;
  56. data1=change_row_to_column(data1);
  57. data2=change_row_to_column(data2);
  58. if nargin < 3; params=[]; end;
  59. [tapers,pad,Fs,fpass,err,trialave]=getparams(params);
  60. if nargout > 8 && err(1)~=2;
  61. error('Cerr computed only for Jackknife. Correct inputs and run again');
  62. end;
  63. if nargout > 6 && err(1)==0;
  64. % Errors computed only if err(1) is nonzero. Need to change params and run again.
  65. error('When errors are desired, err(1) has to be non-zero.');
  66. end;
  67. N=check_consistency(data1,data2);
  68. nfft=max(2^(nextpow2(N)+pad),N);
  69. [f,findx]=getfgrid(Fs,nfft,fpass);
  70. tapers=dpsschk(tapers,N,Fs); % check tapers
  71. J1=mtfftc(data1,tapers,nfft,Fs);
  72. J2=mtfftc(data2,tapers,nfft,Fs);
  73. J1=J1(findx,:,:); J2=J2(findx,:,:);
  74. S12=squeeze(mean(conj(J1).*J2,2));
  75. S1=squeeze(mean(conj(J1).*J1,2));
  76. S2=squeeze(mean(conj(J2).*J2,2));
  77. if trialave; S12=squeeze(mean(S12,2)); S1=squeeze(mean(S1,2)); S2=squeeze(mean(S2,2)); end;
  78. C12=S12./sqrt(S1.*S2);
  79. C=abs(C12);
  80. phi=angle(C12);
  81. if nargout>=9;
  82. [confC,phistd,Cerr]=coherr(C,J1,J2,err,trialave);
  83. elseif nargout==8;
  84. [confC,phistd]=coherr(C,J1,J2,err,trialave);
  85. end;