Home > chronux_1_15 > 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. Defaults to 0.  
                       e.g. For N = 500, if PAD = 0, we pad the FFT 
                       to 512 points; if PAD = 2, we pad the FFT
                       to 2048 points, etc.
           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. Defaults to 0.
0017 %                       e.g. For N = 500, if PAD = 0, we pad the FFT
0018 %                       to 512 points; if PAD = 2, we pad the FFT
0019 %                       to 2048 points, etc.
0020 %           Fs   (sampling frequency) - optional. Default 1.
0021 %           fpass    (frequency band to be used in the calculation in the form
0022 %                                   [fmin fmax])- optional.
0023 %                                   Default all frequencies between 0 and Fs/2
0024 %           err  (error calculation [1 p] - Theoretical error bars; [2 p] - Jackknife error bars
0025 %                                   [0 p] or 0 - no error bars) - optional. Default 0.
0026 %           trialave (average over events when 1, don't average when 0) -
0027 %           default 0
0028 %       fscorr   (finite size corrections, 0 (don't use finite size corrections) or 1 (use finite size corrections) - optional
0029 %                (available only for spikes). Defaults 0.
0030 %
0031 % Output:
0032 %       S       (triggered spectrum in form frequency x events if trialave=0; function of frequency if trialave=1)
0033 %       f       (frequencies)
0034 %       R       (spike rate)
0035 %       Serr    (error bars) - only for err(1)>=1
0036 
0037 if nargin < 3; error('Need data, events and window parameters'); end;
0038 if nargin < 2; params=[]; end;
0039 [tapers,pad,Fs,fpass,err,trialave,params]=getparams(params);
0040 clear tapers pad Fs fpass trialave
0041 if nargin < 5 || isempty(fscorr); fscorr=0; end;
0042 if nargout > 3 && err(1)==0; error('Cannot compute errors if err(1)=0'); end;
0043 data=createdatamatpt(data,E,win);
0044 if nargout==4; 
0045     [S,f,R,Serr]=mtspectrumpt(data,params,fscorr);
0046 else
0047     [S,f,R]=mtspectrumpt(data,params,fscorr);
0048 end;

Generated on Tue 15-Aug-2006 22:51:57 by m2html © 2003