mtspectrumpt.m 4.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. function [S,f,R,Serr]=mtspectrumpt(data,params,fscorr,t)
  2. % Multi-taper spectrum - point process times
  3. %
  4. % Usage:
  5. %
  6. % [S,f,R,Serr]=mtspectrumpt(data,params,fscorr,t)
  7. % Input:
  8. % data (structure array of spike times with dimension channels/trials;
  9. % also accepts 1d array of spike times) -- 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 channels/trials when 1, don't average when 0) - optional. Default 0
  43. % fscorr (finite size corrections, 0 (don't use finite size corrections) or
  44. % 1 (use finite size corrections) - optional
  45. % (available only for spikes). Defaults 0.
  46. % t (time grid over which the tapers are to be calculated:
  47. % this argument is useful when calling the spectrum
  48. % calculation routine from a moving window spectrogram
  49. % calculation routine). If left empty, the spike times
  50. % are used to define the grid.
  51. % Output:
  52. % S (spectrum with dimensions frequency x channels/trials if trialave=0;
  53. % dimension frequency if trialave=1)
  54. % f (frequencies)
  55. % R (rate)
  56. % Serr (error bars) - only if err(1)>=1
  57. if nargin < 1; error('Need data'); end;
  58. if nargin < 2; params=[]; end;
  59. [tapers,pad,Fs,fpass,err,trialave,params]=getparams(params);
  60. clear params
  61. data=change_row_to_column(data);
  62. if nargout > 3 && err(1)==0; error('cannot compute error bars with err(1)=0; change params and run again'); end;
  63. if nargin < 3 || isempty(fscorr); fscorr=0;end;
  64. if nargin < 4 || isempty(t);
  65. [mintime,maxtime]=minmaxsptimes(data);
  66. dt=1/Fs; % sampling time
  67. t=mintime-dt:dt:maxtime+dt; % time grid for prolates
  68. end;
  69. N=length(t); % number of points in grid for dpss
  70. nfft=max(2^(nextpow2(N)+pad),N); % number of points in fft of prolates
  71. [f,findx]=getfgrid(Fs,nfft,fpass); % get frequency grid for evaluation
  72. tapers=dpsschk(tapers,N,Fs); % check tapers
  73. [J,Msp,Nsp]=mtfftpt(data,tapers,nfft,t,f,findx); % mt fft for point process times
  74. S=squeeze(mean(conj(J).*J,2));
  75. if trialave; S=squeeze(mean(S,2));Msp=mean(Msp);end;
  76. R=Msp*Fs;
  77. if nargout==4;
  78. if fscorr==1;
  79. Serr=specerr(S,J,err,trialave,Nsp);
  80. else
  81. Serr=specerr(S,J,err,trialave);
  82. end;
  83. end;