Home > chronux_1_50 > pointbinned > mtspectrumtrigpb.m

mtspectrumtrigpb

PURPOSE ^

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

SYNOPSIS ^

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

DESCRIPTION ^

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

 Usage:

 [S,f,R,Serr]=mtspectrumtrigpb(data,E,win,params,fscorr)
 Input: 
       data        (single channel data) -- required
       E           (event times) - required
       win         (in the form [winl winr] i.e window around each event
                                                 required
                                                 Note that units here have
                                                 to be consistent with
                                                 units of Fs
       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       (triggered spectrum in form frequency x events for trialave=0, or as a function of frequency for 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]=mtspectrumtrigpb(data,E,win,params,fscorr)
0002 % Multi-taper event triggered time-frequency spectrum - binned point process
0003 %
0004 % Usage:
0005 %
0006 % [S,f,R,Serr]=mtspectrumtrigpb(data,E,win,params,fscorr)
0007 % Input:
0008 %       data        (single channel data) -- required
0009 %       E           (event times) - required
0010 %       win         (in the form [winl winr] i.e window around each event
0011 %                                                 required
0012 %                                                 Note that units here have
0013 %                                                 to be consistent with
0014 %                                                 units of Fs
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) -
0032 %           optional. Default 0
0033 %       fscorr   (finite size corrections, 0 (don't use finite size corrections) or 1 (use finite size corrections) - optional
0034 %                (available only for spikes). Defaults 0.
0035 % Output:
0036 %       S       (triggered spectrum in form frequency x events for trialave=0, or as a function of frequency for trialave=1)
0037 %       f       (frequencies)
0038 %       R       (spike rate)
0039 %       Serr    (error bars) - only for err(1)>=1
0040 
0041 if nargin < 3; error('Need data, events and window parameters'); end;
0042 if nargin < 2; params=[]; end;
0043 [tapers,pad,Fs,fpass,err,trialave,params]=getparams(params);
0044 clear tapers pad fpass trialave
0045 if nargin < 5 || isempty(fscorr); fscorr=0; end;
0046 if nargout > 3 && err(1)==0; 
0047 %   Cannot compute errors if err(1)=0. Need to change params and run again.
0048     error('When Serr is desired, err(1) has to be non-zero.');
0049 end;
0050 data=change_row_to_column(data);
0051 data=createdatamatpb(data,E,Fs,win); 
0052 if nargout==4; [S,f,R,Serr]=mtspectrumpb(data,params,fscorr);
0053 else [S,f,R]=mtspectrumpb(data,params,fscorr);end

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