Home > chronux_1_50 > continuous > mtspecgramc.m

mtspecgramc

PURPOSE ^

Multi-taper time-frequency spectrum - continuous process

SYNOPSIS ^

function [S,t,f,Serr]=mtspecgramc(data,movingwin,params)

DESCRIPTION ^

 Multi-taper time-frequency spectrum - continuous process

 Usage:
 [S,t,f,Serr]=mtspecgramc(data,movingwin,params)
 Input: 
 Note units have to be consistent. Thus, if movingwin is in seconds, Fs
 has to be in Hz. see chronux.m for more information.
       data        (in form samples x channels/trials) -- 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 - 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 trials/channels when 1, don't average when 0) - optional. Default 0
 Output:
       S       (spectrum in form time x frequency x channels/trials if trialave=0; in the form time x frequency if trialave=1)
       t       (times)
       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,t,f,Serr]=mtspecgramc(data,movingwin,params)
0002 % Multi-taper time-frequency spectrum - continuous process
0003 %
0004 % Usage:
0005 % [S,t,f,Serr]=mtspecgramc(data,movingwin,params)
0006 % Input:
0007 % Note units have to be consistent. Thus, if movingwin is in seconds, Fs
0008 % has to be in Hz. see chronux.m for more information.
0009 %       data        (in form samples x channels/trials) -- required
0010 %       movingwin         (in the form [window winstep] i.e length of moving
0011 %                                                 window and step size)
0012 %                                                 Note that units here have
0013 %                                                 to be consistent with
0014 %                                                 units of Fs - required
0015 %       params: structure with fields tapers, pad, Fs, fpass, err, trialave
0016 %       - optional
0017 %           tapers (precalculated tapers from dpss, or in the form [NW K] e.g [3 5]) -- optional. If not
0018 %                                                 specified, use [NW K]=[3 5]
0019 %            pad            (padding factor for the FFT) - optional (can take values -1,0,1,2...).
0020 %                    -1 corresponds to no padding, 0 corresponds to padding
0021 %                    to the next highest power of 2 etc.
0022 %                       e.g. For N = 500, if PAD = -1, we do not pad; if PAD = 0, we pad the FFT
0023 %                       to 512 points, if pad=1, we pad to 1024 points etc.
0024 %                       Defaults to 0.
0025 %           Fs   (sampling frequency) - optional. Default 1.
0026 %           fpass    (frequency band to be used in the calculation in the form
0027 %                                   [fmin fmax])- optional.
0028 %                                   Default all frequencies between 0 and Fs/2
0029 %           err  (error calculation [1 p] - Theoretical error bars; [2 p] - Jackknife error bars
0030 %                                   [0 p] or 0 - no error bars) - optional. Default 0.
0031 %           trialave (average over trials/channels when 1, don't average when 0) - optional. Default 0
0032 % Output:
0033 %       S       (spectrum in form time x frequency x channels/trials if trialave=0; in the form time x frequency if trialave=1)
0034 %       t       (times)
0035 %       f       (frequencies)
0036 %       Serr    (error bars) only for err(1)>=1
0037 
0038 if nargin < 2; error('Need data and window parameters'); end;
0039 if nargin < 3; params=[]; end;
0040 [tapers,pad,Fs,fpass,err,trialave,params]=getparams(params);
0041 if nargout > 3 && err(1)==0; 
0042 %   Cannot compute error bars with err(1)=0. change params and run again.
0043     error('When Serr is desired, err(1) has to be non-zero.');
0044 end;
0045 data=change_row_to_column(data);
0046 [N,Ch]=size(data);
0047 Nwin=round(Fs*movingwin(1)); % number of samples in window
0048 Nstep=round(movingwin(2)*Fs); % number of samples to step through
0049 nfft=max(2^(nextpow2(Nwin)+pad),Nwin);
0050 f=getfgrid(Fs,nfft,fpass); Nf=length(f);
0051 params.tapers=dpsschk(tapers,Nwin,Fs); % check tapers
0052 
0053 winstart=1:Nstep:N-Nwin+1;
0054 nw=length(winstart); 
0055 
0056 if trialave
0057     S = zeros(nw,Nf);
0058     if nargout==4; Serr=zeros(2,nw,Nf); end;
0059 else
0060     S = zeros(nw,Nf,Ch);
0061     if nargout==4; Serr=zeros(2,nw,Nf,Ch); end;
0062 end
0063 
0064 for n=1:nw;
0065    indx=winstart(n):winstart(n)+Nwin-1;
0066    datawin=data(indx,:);
0067    if nargout==4
0068      [s,f,serr]=mtspectrumc(datawin,params);
0069      Serr(1,n,:,:)=squeeze(serr(1,:,:));
0070      Serr(2,n,:,:)=squeeze(serr(2,:,:));
0071    else
0072      [s,f]=mtspectrumc(datawin,params);
0073    end
0074    S(n,:,:)=s;
0075 end;
0076 S=squeeze(S); 
0077 if nargout==4;Serr=squeeze(Serr);end;
0078 winmid=winstart+round(Nwin/2);
0079 t=winmid/Fs;

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