Home > chronux_1_50 > pointtimes > mtspecgramtrigpt.m

mtspecgramtrigpt

PURPOSE ^

Multi-taper event triggered time-frequency spectrum - point process times

SYNOPSIS ^

function [S,t,f,R,Serr]=mtspecgramtrigpt(data,E,win,movingwin,params,fscorr)

DESCRIPTION ^

 Multi-taper event triggered time-frequency spectrum - point process times

 Usage:

 [S,t,f,R,Serr]=mtspecgramtrigpt(data,E,win,movingwin,params,fscorr)
 Input: 
       data        (univariate spike data -1d structure array of spike times; also accepts 1d array of spike times) -- required
       E           (event times) - required
       win         (in the form [winl,winr] i.e window around each event
                                                 required
       movingwin         (in the form [window winstep] i.e length of moving
                                                 window and step size) -
                                                 required
       params: structure with fields tapers, pad, Fs, fpass, err, trialave
       - optional
           tapers (precalculated tapers from dpss, or in the form [NW K] e.g [3 5]) -- optional. If not 
                                                 specified, use [NW K]=[3 5]
            pad            (padding factor for the FFT) - optional (can take values -1,0,1,2...). 
                    -1 corresponds to no padding, 0 corresponds to padding
                    to the next highest power of 2 etc.
                       e.g. For N = 500, if PAD = -1, we do not pad; if PAD = 0, we pad the FFT
                       to 512 points, if pad=1, we pad to 1024 points etc.
                       Defaults to 0.
           Fs   (sampling frequency) - optional. Default 1.
           fpass    (frequency band to be used in the calculation in the form
                                   [fmin fmax])- optional. 
                                   Default all frequencies between 0 and Fs/2
           err  (error calculation [1 p] - Theoretical error bars; [2 p] - Jackknife error bars
                                   [0 p] or 0 - no error bars) - optional. Default 0.
           trialave (average over events when 1, don't average when 0) - optional. Default 0
       fscorr   (finite size corrections, 0 (don't use finite size corrections) or 1 (use finite size corrections) - optional
                (available only for spikes). Defaults 0.

 Output:
       S       (Spectrogram with dimensions time x frequency x events if trialave=0; dimensions time x frequency if trialave=1)
       t       (times)
       f       (frequencies)
       R       (spike rate)
       Serr    (error bars)-only if err(1)>=1

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [S,t,f,R,Serr]=mtspecgramtrigpt(data,E,win,movingwin,params,fscorr)
0002 % Multi-taper event triggered time-frequency spectrum - point process times
0003 %
0004 % Usage:
0005 %
0006 % [S,t,f,R,Serr]=mtspecgramtrigpt(data,E,win,movingwin,params,fscorr)
0007 % Input:
0008 %       data        (univariate spike data -1d structure array of spike times; also accepts 1d array of spike times) -- required
0009 %       E           (event times) - required
0010 %       win         (in the form [winl,winr] i.e window around each event
0011 %                                                 required
0012 %       movingwin         (in the form [window winstep] i.e length of moving
0013 %                                                 window and step size) -
0014 %                                                 required
0015 %       params: structure with fields tapers, pad, Fs, fpass, err, trialave
0016 %       - optional
0017 %           tapers (precalculated tapers from dpss, or in the form [NW K] e.g [3 5]) -- optional. If not
0018 %                                                 specified, use [NW K]=[3 5]
0019 %            pad            (padding factor for the FFT) - optional (can take values -1,0,1,2...).
0020 %                    -1 corresponds to no padding, 0 corresponds to padding
0021 %                    to the next highest power of 2 etc.
0022 %                       e.g. For N = 500, if PAD = -1, we do not pad; if PAD = 0, we pad the FFT
0023 %                       to 512 points, if pad=1, we pad to 1024 points etc.
0024 %                       Defaults to 0.
0025 %           Fs   (sampling frequency) - optional. Default 1.
0026 %           fpass    (frequency band to be used in the calculation in the form
0027 %                                   [fmin fmax])- optional.
0028 %                                   Default all frequencies between 0 and Fs/2
0029 %           err  (error calculation [1 p] - Theoretical error bars; [2 p] - Jackknife error bars
0030 %                                   [0 p] or 0 - no error bars) - optional. Default 0.
0031 %           trialave (average over events when 1, don't average when 0) - optional. Default 0
0032 %       fscorr   (finite size corrections, 0 (don't use finite size corrections) or 1 (use finite size corrections) - optional
0033 %                (available only for spikes). Defaults 0.
0034 %
0035 % Output:
0036 %       S       (Spectrogram with dimensions time x frequency x events if trialave=0; dimensions time x frequency if trialave=1)
0037 %       t       (times)
0038 %       f       (frequencies)
0039 %       R       (spike rate)
0040 %       Serr    (error bars)-only if err(1)>=1
0041 
0042 if nargin < 4; error('Need data, events and parameters for the windows'); end;
0043 if nargin < 5; params=[]; end;
0044 [tapers,pad,Fs,fpass,err,trialave,params]=getparams(params);
0045 clear tapers pad Fs fpass err trialave
0046 if nargin < 6 || isempty(fscorr); fscorr=0; end;
0047 
0048 data=createdatamatpt(data,E,win);
0049 if nargout==5; 
0050     [S,t,f,R,Serr]=mtspecgrampt(data,movingwin,params,fscorr);
0051 else 
0052     [S,t,f,R]=mtspecgrampt(data,movingwin,params,fscorr);
0053 end;

Generated on Mon 09-Oct-2006 00:54:52 by m2html © 2003