Home > chronux_1_50 > pointtimes > mtspectrumtrigpt.m

mtspectrumtrigpt

PURPOSE ^

Multi-taper time-frequency spectrum - point process times

SYNOPSIS ^

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

DESCRIPTION ^

 Multi-taper time-frequency spectrum - point process times

 Usage:

 [S,f,R,Serr]=mtspectrumtrigpt(data,E,win,params,fscorr)
 Input: 
       data        (structure array of one channel of spike times; also accepts 1d column vector of spike times) -- required
       E           (event times) - required
       win         (in the form [winl winr] i.e window around each event)--
                                                 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) -
           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       (triggered spectrum in form frequency x events if trialave=0; function of frequency if trialave=1)
       f       (frequencies)
       R       (spike rate)
       Serr    (error bars) - only for err(1)>=1

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

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

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