# 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 one of the following
                        forms:
                       (1) A numeric vector [TW K] where TW is the
                           time-bandwidth product and K is the number of
                           tapers to be used (less than or equal to
                           2TW-1).
                       (2) A numeric vector [W T p] where W is the
                           bandwidth, T is the duration of the data and p
                           is an integer such that 2TW-p tapers are used. In
                           this form there is no default i.e. to specify
                           the bandwidth, you have to specify T and p as
                           well. Note that the units of W and T have to be
                           consistent: if W is in Hz, T must be in seconds
                           and vice versa. Note that these units must also
                           be consistent with the units of params.Fs: W can
                           be in Hz if and only if params.Fs is in Hz.
                           The default is to use form 1 with TW=3 and K=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:

- change_row_to_column Helper routine to transform 1d arrays into column vectors that are needed
- getparams Helper function to convert structure params to variables used by the
- createdatamatpb
- mtspectrumpb Multi-taper spectrum - binned point process

This function is called by:

- testscript function testscript(pname,direction,movingwin,segave,params,fscorr)

## 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 one of the following
    0018 %                    forms:
    0019 %                   (1) A numeric vector [TW K] where TW is the
    0020 %                       time-bandwidth product and K is the number of
    0021 %                       tapers to be used (less than or equal to
    0022 %                       2TW-1).
    0023 %                   (2) A numeric vector [W T p] where W is the
    0024 %                       bandwidth, T is the duration of the data and p
    0025 %                       is an integer such that 2TW-p tapers are used. In
    0026 %                       this form there is no default i.e. to specify
    0027 %                       the bandwidth, you have to specify T and p as
    0028 %                       well. Note that the units of W and T have to be
    0029 %                       consistent: if W is in Hz, T must be in seconds
    0030 %                       and vice versa. Note that these units must also
    0031 %                       be consistent with the units of params.Fs: W can
    0032 %                       be in Hz if and only if params.Fs is in Hz.
    0033 %                       The default is to use form 1 with TW=3 and K=5
    0034 %
    0035 %            pad            (padding factor for the FFT) - optional (can take values -1,0,1,2...).
    0036 %                    -1 corresponds to no padding, 0 corresponds to padding
    0037 %                    to the next highest power of 2 etc.
    0038 %                       e.g. For N = 500, if PAD = -1, we do not pad; if PAD = 0, we pad the FFT
    0039 %                       to 512 points, if pad=1, we pad to 1024 points etc.
    0040 %                       Defaults to 0.
    0041 %           Fs   (sampling frequency) - optional. Default 1.
    0042 %           fpass    (frequency band to be used in the calculation in the form
    0043 %                                   [fmin fmax])- optional.
    0044 %                                   Default all frequencies between 0 and Fs/2
    0045 %           err  (error calculation [1 p] - Theoretical error bars; [2 p] - Jackknife error bars
    0046 %                                   [0 p] or 0 - no error bars) - optional. Default 0.
    0047 %           trialave (average over events when 1, don't average when 0) -
    0048 %           optional. Default 0
    0049 %       fscorr   (finite size corrections, 0 (don't use finite size corrections) or
    0050 %                1 (use finite size corrections) - optional
    0051 %                (available only for spikes). Defaults 0.
    0052 % Output:
    0053 %       S       (triggered spectrum in form frequency x events for trialave=0,
    0054 %               or as a function of frequency for trialave=1)
    0055 %       f       (frequencies)
    0056 %       R       (spike rate)
    0057 %       Serr    (error bars) - only for err(1)>=1
    0058
    0059 if nargin < 3; error('Need data, events and window parameters'); end;
    0060 if nargin < 2; params=[]; end;
    0061 [tapers,pad,Fs,fpass,err,trialave,params]=getparams(params);
    0062 clear tapers pad fpass trialave
    0063 if nargin < 5 || isempty(fscorr); fscorr=0; end;
    0064 if nargout > 3 && err(1)==0;
    0065 %   Cannot compute errors if err(1)=0. Need to change params and run again.
    0066     error('When Serr is desired, err(1) has to be non-zero.');
    0067 end;
    0068 data=change_row_to_column(data);
    0069 data=createdatamatpb(data,E,Fs,win);
    0070 if nargout==4; [S,f,R,Serr]=mtspectrumpb(data,params,fscorr);
    0071 else [S,f,R]=mtspectrumpb(data,params,fscorr);end