Home > chronux_code > exploratory > correlations > continuous > mtspecgramtrigc.m

mtspecgramtrigc

PURPOSE ^

Multi-taper triggered time-frequency spectrum - continuous process

SYNOPSIS ^

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

DESCRIPTION ^

 Multi-taper triggered time-frequency spectrum - continuous process

 Usage:

 [S,t,f,Serr]=mtspecgramtrigc(data,E,win,movingwin,tapers,pad,Fs,fpass,err,trialave)
 Input: 
 Note units have to be consistent. Thus, if movingwin is in seconds, Fs
 has to be in Hz. see chronux.m for more information.
       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          (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 trials when 1, don't average when 0) -
       optional. Default 0
 Output:
       S       (triggered time-frequency spectrum in form time x frequency x channels/trials)
       t       (times)
       f       (frequencies)
       Serr    (error bars)

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [S,t,f,Serr]=mtspecgramtrigc(data,E,win,movingwin,tapers,pad,Fs,fpass,err,trialave)
0002 % Multi-taper triggered time-frequency spectrum - continuous process
0003 %
0004 % Usage:
0005 %
0006 % [S,t,f,Serr]=mtspecgramtrigc(data,E,win,movingwin,tapers,pad,Fs,fpass,err,trialave)
0007 % Input:
0008 % Note units have to be consistent. Thus, if movingwin is in seconds, Fs
0009 % has to be in Hz. see chronux.m for more information.
0010 %       data        (single channel data in a column vector) -- required
0011 %       E           (event times) -- required
0012 %       win         (in the form [winl winr] i.e window around each event)
0013 %                                                 required
0014 %       movingwin         (in the form [window winstep] i.e length of moving
0015 %                                                 window and step size) -
0016 %                                                 required
0017 %                                                 Note that units for the windows have
0018 %                                                 to be consistent with
0019 %                                                 units of Fs
0020 %       tapers      (precalculated tapers from dpss, or in the form [NW K] e.g [3 5]) -- optional. If not
0021 %                                                 specified, use [NW K]=[3 5]
0022 %        pad            (padding factor for the FFT) - optional. Defaults to 0.
0023 %                         e.g. For N = 500, if PAD = 0, we pad the FFT
0024 %                         to 512 points; if PAD = 2, we pad the FFT
0025 %                         to 2048 points, etc.
0026 %       Fs          (sampling frequency) - optional. Default 1.
0027 %       fpass       (frequency band to be used in the calculation in the form
0028 %                                   [fmin fmax])- optional.
0029 %                                   Default all frequencies between 0 and Fs/2
0030 %       err         (error calculation [1 p] - Theoretical error bars; [2 p] Jackknife error bars,
0031 %                                   [0 p] or 0 - no error bars) - optional. Default 0.
0032 %       trialave    (average over trials when 1, don't average when 0) -
0033 %       optional. Default 0
0034 % Output:
0035 %       S       (triggered time-frequency spectrum in form time x frequency x channels/trials)
0036 %       t       (times)
0037 %       f       (frequencies)
0038 %       Serr    (error bars)
0039 
0040 if nargin < 4; error('Need data, events and parameters for the windows'); end;
0041 if nargin < 5; tapers=[3 5]; end;
0042 if nargin < 6;pad=0;end;
0043 if nargin < 7; Fs=1; end;
0044 if nargin < 8; fpass=[0 Fs/2]; end;
0045 if nargin < 9; err=0; end;
0046 if nargin < 10; trialave=0; end;
0047 if isempty(tapers); tapers=[3 5]; end;
0048 if isempty(pad);pad=0;end;
0049 if isempty(Fs); Fs=1; end;
0050 if isempty(fpass); fpass=[0 Fs/2]; end;
0051 if isempty(err); err=0; end;
0052 if isempty(trialave); trialave=0;end;
0053 
0054 data=createdatamatc(data,E,Fs,win);
0055 if nargout==4;
0056     [S,t,f,Serr]=mtspecgramc(data,movingwin,tapers,pad,Fs,fpass,err,trialave);
0057 else
0058     [S,t,f]=mtspecgramc(data,movingwin,tapers,pad,Fs,fpass,err,trialave);
0059 end;

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