Home > chronux_code > exploratory > correlations > pointbinned > mtspecgramtrigpb.m

mtspecgramtrigpb

PURPOSE ^

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

SYNOPSIS ^

function [S,t,f,R,Serr]=mtspecgramtrigpb(data,E,win,movingwin,tapers,pad,Fs,fpass,err,trialave,fscorr,t)

DESCRIPTION ^

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

 Usage:

 [S,t,f,R,Serr]=mtspecgramtrigpb(data,E,win,tapers,pad,Fs,fpass,err,trialave,fscorr,t)
 Input: 
       data        (single channel data in a column vector) -- 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
                                                 Note that units for the windows have
                                                 to be consistent with
                                                 units of Fs
       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          (binning 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 trials 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.
       t        (time grid over which data is specified). optional. Default [0:length(data)-1]/Fs
 Output:
       S       (triggered time-frequency spectrum in form time x frequency x channels/trials)
       t       (times)
       f       (frequencies)
       R       (spike rate)
       Serr    (error bars)

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [S,t,f,R,Serr]=mtspecgramtrigpb(data,E,win,movingwin,tapers,pad,Fs,fpass,err,trialave,fscorr,t)
0002 % Multi-taper triggered time-frequency spectrum - binned point process
0003 %
0004 % Usage:
0005 %
0006 % [S,t,f,R,Serr]=mtspecgramtrigpb(data,E,win,tapers,pad,Fs,fpass,err,trialave,fscorr,t)
0007 % Input:
0008 %       data        (single channel data in a column vector) -- 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 %                                                 Note that units for the windows have
0016 %                                                 to be consistent with
0017 %                                                 units of Fs
0018 %       tapers      (precalculated tapers from dpss, or in the form [NW K] e.g [3 5]) -- optional. If not
0019 %                                                 specified, use [NW K]=[3 5]
0020 %        pad            (padding factor for the FFT) - optional. Defaults to 0.
0021 %                         e.g. For N = 500, if PAD = 0, we pad the FFT
0022 %                         to 512 points; if PAD = 2, we pad the FFT
0023 %                         to 2048 points, etc.
0024 %       Fs          (binning frequency) - optional. Default 1.
0025 %       fpass       (frequency band to be used in the calculation in the form
0026 %                                   [fmin fmax])- optional.
0027 %                                   Default all frequencies between 0 and Fs/2
0028 %       err         (error calculation [1 p] - Theoretical error bars; [2 p] Jackknife error bars,
0029 %                                   [0 p] or 0 - no error bars) - optional. Default 0.
0030 %       trialave    (average over trials when 1, don't average when 0) -
0031 %                       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 %       t        (time grid over which data is specified). optional. Default [0:length(data)-1]/Fs
0035 % Output:
0036 %       S       (triggered time-frequency spectrum in form time x frequency x channels/trials)
0037 %       t       (times)
0038 %       f       (frequencies)
0039 %       R       (spike rate)
0040 %       Serr    (error bars)
0041 
0042 if nargin < 4; error('Need data, events and parameters for the windows'); end;
0043 if nargin < 5; tapers=[3 5]; end;
0044 if nargin < 6;pad=0;end;
0045 if nargin < 7; Fs=1; end;
0046 if nargin < 8; fpass=[0 Fs/2]; end;
0047 if nargin < 9; err=0; end;
0048 if nargin < 10; trialave=0;end;
0049 if nargin < 11; fscorr=0; end;
0050 if nargin < 12; t=(0:size(data,1)-1)/Fs;end
0051 
0052 if isempty(tapers); tapers=[3 5]; end;
0053 if isempty(pad);pad=0;end;
0054 if isempty(Fs); Fs=1; end;
0055 if isempty(fpass); fpass=[0 Fs/2]; end;
0056 if isempty(err); err=0; end;
0057 if isempty(fscorr);fscorr=0; end;
0058 if isempty(trialave);trialave=0;end;
0059 if isempty(t); t=(0:size(data,1)-1)/Fs;end
0060 
0061 data=createdatamatpb(data,E,Fs,win,t);
0062 if nargout==5;[S,t,f,R,Serr]=mtspecgrampb(data,movingwin,tapers,pad,Fs,fpass,err,trialave,fscorr);
0063 else;[S,t,f,R]=mtspecgrampb(data,movingwin,tapers,pad,Fs,fpass,err,trialave,fscorr);end;

Generated on Tue 07-Jun-2005 12:20:32 by m2html © 2003