Home > chronux_1_50 > pointbinned > mtspectrumpb.m

mtspectrumpb

PURPOSE ^

Multi-taper spectrum - binned point process

SYNOPSIS ^

function [S,f,R,Serr]=mtspectrumpb(data,params,fscorr)

DESCRIPTION ^

 Multi-taper spectrum - binned point process

 Usage:

 [S,f,R,Serr]=mtspectrumpb(data,params,fscorr)
 Input: 
       data (in form samples x channels/trials or a single vector) -- required
       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 (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 channels/trials 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       (spectrum in form frequency x channels/trials if trialave=0; as a function of frequency if trialave=1)
       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,f,R,Serr]=mtspectrumpb(data,params,fscorr)
0002 % Multi-taper spectrum - binned point process
0003 %
0004 % Usage:
0005 %
0006 % [S,f,R,Serr]=mtspectrumpb(data,params,fscorr)
0007 % Input:
0008 %       data (in form samples x channels/trials or a single vector) -- required
0009 %       params: structure with fields tapers, pad, Fs, fpass, err, trialave
0010 %       - optional
0011 %           tapers (precalculated tapers from dpss, or in the form [NW K] e.g [3 5]) -- optional. If not
0012 %                                                 specified, use [NW K]=[3 5]
0013 %            pad            (padding factor for the FFT) - optional (can take values -1,0,1,2...).
0014 %                    -1 corresponds to no padding, 0 corresponds to padding
0015 %                    to the next highest power of 2 etc.
0016 %                       e.g. For N = 500, if PAD = -1, we do not pad; if PAD = 0, we pad the FFT
0017 %                       to 512 points, if pad=1, we pad to 1024 points etc.
0018 %                       Defaults to 0.
0019 %           Fs   (sampling frequency) - optional. Default 1.
0020 %           fpass    (frequency band to be used in the calculation in the form
0021 %                                   [fmin fmax])- optional.
0022 %                                   Default all frequencies between 0 and Fs/2
0023 %           err  (error calculation [1 p] - Theoretical error bars; [2 p] - Jackknife error bars
0024 %                                   [0 p] or 0 - no error bars) - optional. Default 0.
0025 %           trialave (average over channels/trials when 1, don't average when 0) - optional. Default 0
0026 %       fscorr   (finite size corrections, 0 (don't use finite size corrections) or 1 (use finite size corrections) - optional
0027 %                (available only for spikes). Defaults 0.
0028 % Output:
0029 %       S       (spectrum in form frequency x channels/trials if trialave=0; as a function of frequency if trialave=1)
0030 %       f       (frequencies)
0031 %       R       (spike rate)
0032 %       Serr    (error bars) - only for err(1)>=1
0033 
0034 if nargin < 1; error('Need data'); end;
0035 if nargin < 2; params=[]; end;
0036 [tapers,pad,Fs,fpass,err,trialave,params]=getparams(params);
0037 clear params
0038 if nargout > 3 && err(1)==0; 
0039 %   Cannot compute error bars with err(1)=0. Need to change params and run again
0040     error('When Serr is desired, err(1) has to be non-zero.');
0041 end;
0042 if nargin < 3 || isempty(fscorr); fscorr=0;end;
0043 data=change_row_to_column(data);
0044 N=size(data,1);
0045 nfft=max(2^(nextpow2(N)+pad),N);
0046 [f,findx]=getfgrid(Fs,nfft,fpass);
0047 
0048 tapers=dpsschk(tapers,N,Fs); % check tapers
0049 [J,Msp,Nsp]=mtfftpb(data,tapers,nfft);  
0050 J=J(findx,:,:);
0051 S=squeeze(mean(conj(J).*J,2));
0052 if trialave; S=squeeze(mean(S,2)); Msp=mean(Msp);end;
0053 R=Msp*Fs;
0054 if nargout==4;
0055    if fscorr==1;
0056       Serr=specerr(S,J,err,trialave,Nsp);
0057    else
0058       Serr=specerr(S,J,err,trialave);
0059    end;
0060 end;

Generated on Mon 09-Oct-2006 00:54:52 by m2html © 2003