# mtdspecgrampb

## PURPOSE

Multi-taper derivatives of time-frequency spectrum - binned point process

## SYNOPSIS

function [dS,t,f]=mtdspecgrampb(data,movingwin,phi,params)

## DESCRIPTION

     Multi-taper derivatives of time-frequency spectrum - binned point process

     Usage:

     [dS,t,f]=mtdspecgrampb(data,movingwin,phi,params)
     Input:
       Note that all times can be in arbitrary units. But the units have to be
       consistent. So, if E is in secs, win, t have to be in secs, and Fs has to
       be Hz. If E is in samples, so are win and t, and Fs=1. In case of spike
       times, the units have to be consistent with the units of data as well.
           data        (in form samples x channels/trials or a single vector) -- required
           movingwin         (in the form [window winstep] i.e length of moving
                                                     window and step size.
                                                     Note that units here have
                                                     to be consistent with
                                                     units of Fs
           phi         (angle for evaluation of derivative) -- required.
                           e.g. phi=[0,pi/2] giving the time and frequency
                           derivatives
           params: structure with fields tapers, pad, Fs, fpass,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...).
                        -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
               trialave (average over trials when 1, don't average when 0) -
               optional. Default 0
     Output:
           dS      (spectral derivative in form phi x time x frequency x channels/trials if trialave=0;
                   phi x time x frequency if trialave=1)
           t       (times)
           f       (frequencies)

## CROSS-REFERENCE INFORMATION

This function calls:

- change_row_to_column Helper routine to transform 1d arrays into column vectors that are needed
- dpsschk Helper function to calculate tapers and, if precalculated tapers are supplied,
- getfgrid Helper function that gets the frequency grid associated with a given fft based computation
- getparams Helper function to convert structure params to variables used by the
- mtdspectrumpb Multi-taper spectral derivative - binned point process

This function is called by:

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

## SOURCE CODE

    0001 function [dS,t,f]=mtdspecgrampb(data,movingwin,phi,params)
    0002 % Multi-taper derivatives of time-frequency spectrum - binned point process
    0003 %
    0004 % Usage:
    0005 %
    0006 % [dS,t,f]=mtdspecgrampb(data,movingwin,phi,params)
    0007 % Input:
    0008 %   Note that all times can be in arbitrary units. But the units have to be
    0009 %   consistent. So, if E is in secs, win, t have to be in secs, and Fs has to
    0010 %   be Hz. If E is in samples, so are win and t, and Fs=1. In case of spike
    0011 %   times, the units have to be consistent with the units of data as well.
    0012 %       data        (in form samples x channels/trials or a single vector) -- required
    0013 %       movingwin         (in the form [window winstep] i.e length of moving
    0014 %                                                 window and step size.
    0015 %                                                 Note that units here have
    0016 %                                                 to be consistent with
    0017 %                                                 units of Fs
    0018 %       phi         (angle for evaluation of derivative) -- required.
    0019 %                       e.g. phi=[0,pi/2] giving the time and frequency
    0020 %                       derivatives
    0021 %       params: structure with fields tapers, pad, Fs, fpass,trialave
    0022 %       -optional
    0023 %           tapers : precalculated tapers from dpss or in the one of the following
    0024 %                    forms:
    0025 %                    (1) A numeric vector [TW K] where TW is the
    0026 %                        time-bandwidth product and K is the number of
    0027 %                        tapers to be used (less than or equal to
    0028 %                        2TW-1).
    0029 %                    (2) A numeric vector [W T p] where W is the
    0030 %                        bandwidth, T is the duration of the data and p
    0031 %                        is an integer such that 2TW-p tapers are used. In
    0032 %                        this form there is no default i.e. to specify
    0033 %                        the bandwidth, you have to specify T and p as
    0034 %                        well. Note that the units of W and T have to be
    0035 %                        consistent: if W is in Hz, T must be in seconds
    0036 %                        and vice versa. Note that these units must also
    0037 %                        be consistent with the units of params.Fs: W can
    0038 %                        be in Hz if and only if params.Fs is in Hz.
    0039 %                        The default is to use form 1 with TW=3 and K=5
    0040 %                    Note that T has to be equal to movingwin(1).
    0041 %
    0042 %            pad            (padding factor for the FFT) - optional (can take values -1,0,1,2...).
    0043 %                    -1 corresponds to no padding, 0 corresponds to padding
    0044 %                    to the next highest power of 2 etc.
    0045 %                       e.g. For N = 500, if PAD = -1, we do not pad; if PAD = 0, we pad the FFT
    0046 %                       to 512 points, if pad=1, we pad to 1024 points etc.
    0047 %                       Defaults to 0.
    0048 %           Fs   (sampling frequency) - optional. Default 1.
    0049 %           fpass    (frequency band to be used in the calculation in the form
    0050 %                                   [fmin fmax])- optional.
    0051 %                                   Default all frequencies between 0 and
    0052 %                                   Fs/2
    0053 %           trialave (average over trials when 1, don't average when 0) -
    0054 %           optional. Default 0
    0055 % Output:
    0056 %       dS      (spectral derivative in form phi x time x frequency x channels/trials if trialave=0;
    0057 %               phi x time x frequency if trialave=1)
    0058 %       t       (times)
    0059 %       f       (frequencies)
    0060
    0061 if nargin < 3; error('Need data, window parameters and angle'); end;
    0062 if nargin < 4; params=[]; end;
    0063
    0064 if length(params.tapers)==3 & movingwin(1)~=params.tapers(2);
    0065     error('Duration of data in params.tapers is inconsistent with movingwin(1), modify params.tapers(2) to proceed')
    0066 end
    0067
    0068 [tapers,pad,Fs,fpass,err,trialave,params]=getparams(params);
    0069 clear err
    0070 data=change_row_to_column(data);
    0071 [N,Ch]=size(data);
    0072 Nwin=round(Fs*movingwin(1)); % number of samples in window
    0073 Nstep=round(movingwin(2)*Fs); % number of samples to step through
    0074 nfft=max(2^(nextpow2(Nwin)+pad),Nwin);
    0075 f=getfgrid(Fs,nfft,fpass); Nf=length(f);
    0076 params.tapers=dpsschk(tapers,Nwin,Fs); % check tapers
    0077
    0078 winstart=1:Nstep:N-Nwin+1;
    0079 nw=length(winstart);
    0080 if trialave==0; dS=zeros(length(phi),nw,Nf,Ch); else dS=zeros(length(phi),nw,Nf); end;
    0081 for n=1:nw;
    0082    indx=winstart(n):winstart(n)+Nwin-1;
    0083    datawin=data(indx,:);
    0084    [ds,f]=mtdspectrumpb(datawin,phi,params);
    0085    dS(:,n,:,:)=ds;
    0086 end;
    0087 sz=size(ds);
    0088 dS=squeeze(dS);
    0089 % if length(sz)==3;
    0090 %    dS=permute(dS,[2 1 3 4]);
    0091 % elseif length(phi)>1
    0092 %    dS=permute(dS,[2 1 3]);
    0093 % end;
    0094 winmid=winstart+round(Nwin/2);
    0095 t=winmid/Fs;