Home > chronux > spectral_analysis > pointbinned > mtspecgramtrigpb.m

# mtspecgramtrigpb

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

## SYNOPSIS function [S,t,f,R,Serr]=mtspecgramtrigpb(data,E,win,movingwin,params,fscorr)

## DESCRIPTION ``` Multi-taper event triggered time-frequency spectrum - binned point process

Usage:

[S,t,f,R,Serr]=mtspecgramtrigpb(data,E,win,movingwin,params,fscorr)
Input:
data        (single channel data 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
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
Note that T has to be equal to movingwin(1).

pad            (padding factor for the FFT) - optional (can take values -1,0,1,2...).
to the next highest power of 2 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 time-frequency spectrum in form time x frequency x events if segave=0;
or in the form time x frequency segave=1)
t       (times)
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,t,f,R,Serr]=mtspecgramtrigpb(data,E,win,movingwin,params,fscorr)
0002 % Multi-taper event triggered time-frequency spectrum - binned point process
0003 %
0004 % Usage:
0005 %
0006 % [S,t,f,R,Serr]=mtspecgramtrigpb(data,E,win,movingwin,params,fscorr)
0007 % Input:
0008 %       data        (single channel data 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 %       params: structure with fields tapers, pad, Fs, fpass, err, trialave
0019 %       - optional
0020 %           tapers : precalculated tapers from dpss or in the one of the following
0021 %                    forms:
0022 %                   (1) A numeric vector [TW K] where TW is the
0023 %                       time-bandwidth product and K is the number of
0024 %                       tapers to be used (less than or equal to
0025 %                       2TW-1).
0026 %                   (2) A numeric vector [W T p] where W is the
0027 %                       bandwidth, T is the duration of the data and p
0028 %                       is an integer such that 2TW-p tapers are used. In
0029 %                       this form there is no default i.e. to specify
0030 %                       the bandwidth, you have to specify T and p as
0031 %                       well. Note that the units of W and T have to be
0032 %                       consistent: if W is in Hz, T must be in seconds
0033 %                       and vice versa. Note that these units must also
0034 %                       be consistent with the units of params.Fs: W can
0035 %                       be in Hz if and only if params.Fs is in Hz.
0036 %                       The default is to use form 1 with TW=3 and K=5
0037 %                   Note that T has to be equal to movingwin(1).
0038 %
0039 %            pad            (padding factor for the FFT) - optional (can take values -1,0,1,2...).
0041 %                    to the next highest power of 2 etc.
0042 %                       e.g. For N = 500, if PAD = -1, we do not pad; if PAD = 0, we pad the FFT
0043 %                       to 512 points, if pad=1, we pad to 1024 points etc.
0044 %                       Defaults to 0.
0045 %           Fs   (sampling frequency) - optional. Default 1.
0046 %           fpass    (frequency band to be used in the calculation in the form
0047 %                                   [fmin fmax])- optional.
0048 %                                   Default all frequencies between 0 and Fs/2
0049 %           err  (error calculation [1 p] - Theoretical error bars; [2 p] - Jackknife error bars
0050 %                                   [0 p] or 0 - no error bars) - optional. Default 0.
0051 %           trialave (average over events when 1, don't average when 0) - optional. Default 0
0052 %       fscorr   (finite size corrections, 0 (don't use finite size corrections) or
0053 %                1 (use finite size corrections) - optional
0054 %                (available only for spikes). Defaults 0.
0055 % Output:
0056 %       S       (triggered time-frequency spectrum in form time x frequency x events if segave=0;
0057 %               or in the form time x frequency segave=1)
0058 %       t       (times)
0059 %       f       (frequencies)
0060 %       R       (spike rate)
0061 %       Serr    (error bars) - only for err(1)>=1
0062
0063 if nargin < 4; error('Need data, events and parameters for the windows'); end;
0064 if nargin < 5; params=[]; end;
0065
0066 if length(params.tapers)==3 & movingwin(1)~=params.tapers(2);
0067     error('Duration of data in params.tapers is inconsistent with movingwin(1), modify params.tapers(2) to proceed')
0068 end
0069