Home > chronux_1_1 > continuous > mtspectrumtrigc.m

mtspectrumtrigc

PURPOSE ^

Multi-taper event triggered time-frequency spectrum - continuous process

SYNOPSIS ^

function [S,f,Serr]=mtspectrumtrigc(data,E,win,params)

DESCRIPTION ^

 Multi-taper event triggered time-frequency spectrum - continuous process

 Usage:

 [S,f,Serr]=mtspectrumtrigc(data,E,win,params)
 Input: 
 Note units have to be consistent. See chronux.m for more information.
       data        (single channel) -- 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. 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) - optional. Default 0
 Output:
       S       (triggered spectrum in form frequency x events for trialave=0 - or as a function of frequency for trialave=1)
       f       (frequencies)
       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,Serr]=mtspectrumtrigc(data,E,win,params)
0002 % Multi-taper event triggered time-frequency spectrum - continuous process
0003 %
0004 % Usage:
0005 %
0006 % [S,f,Serr]=mtspectrumtrigc(data,E,win,params)
0007 % Input:
0008 % Note units have to be consistent. See chronux.m for more information.
0009 %       data        (single channel) -- required
0010 %       E           (event times) -- required
0011 %       win         (in the form [winl winr] i.e window around each event
0012 %                                                 required)
0013 %                                                 Note that units here have
0014 %                                                 to be consistent with
0015 %                                                 units of Fs
0016 %       params: structure with fields tapers, pad, Fs, fpass, err, trialave
0017 %       -optional
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   (sampling 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 events when 1, don't average when 0) - optional. Default 0
0031 % Output:
0032 %       S       (triggered spectrum in form frequency x events for trialave=0 - or as a function of frequency for trialave=1)
0033 %       f       (frequencies)
0034 %       Serr    (error bars) only for err(1)>=1
0035 
0036 if nargin < 3; error('Need data, events and window parameters'); end;
0037 if nargin < 4; params=[]; end;
0038 [tapers,pad,Fs,fpass,err,trialave,params]=getparams(params);
0039 clear tapers pad fpass trialave
0040 if nargout > 2 && err(1)==0; 
0041 %   Cannot compute error bars with err(1)=0. Change params and run again.
0042     error('When Serr is desired, err(1) has to be non-zero.');
0043 end;
0044 data=change_row_to_column(data);
0045 data=createdatamatc(data,E,Fs,win);
0046 if nargout==3; 
0047     [S,f,Serr]=mtspectrumc(data,params);
0048 else 
0049     [S,f]=mtspectrumc(data,params);
0050 end;

Generated on Sun 13-Aug-2006 11:49:44 by m2html © 2003