Home > chronux_code > exploratory > correlations > continuous > coherencyc.m

coherencyc

PURPOSE ^

Multi-taper coherency,cross-spectrum and individual spectra - continuous process

SYNOPSIS ^

function [C,phi,S12,S1,S2,f,confC,phierr,Cerr]=coherencyc(data1,data2,tapers,pad,Fs,fpass,err,trialave)

DESCRIPTION ^

 Multi-taper coherency,cross-spectrum and individual spectra - continuous process

 Usage:
 [C,phi,S12,S1,S2,f,confC,phierr,Cerr]=coherencyc(data1,data2,tapers,pad,Fs,fpass,err,trialave)
 Input: 
 Note units have to be consistent. See chronux.m for more information.
       data1 (in form samples x trials) -- required
       data2 (in form samples x trials) -- required
       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. Defaults to 0.  
                       e.g. For N = 500, if PAD = 0, we pad the FFT 
                       to 512 points; if PAD = 2, we pad the FFT
                       to 2048 points, etc.
       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 when 1, don't average when 0) - optional. Default 0
 Output:
       C (abs of coherency - frequencies x trials for no trial averaging)
       phi (phase of coherency - frequencies x trials for no trial averaging)
       S12 (cross spectrum - frequencies x trials for no trial averaging)
       S1 (spectrum 1- frequencies x trials for no trial averaging)
       S2 (spectrum 2- frequencies x trials for no trial averaging)
       f (frequencies)
       confC (confidence level for C at 1-p %)
       phierr (error bars for phi)
       Cerr  (Jackknife error bars for C - use only for Jackknife)

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [C,phi,S12,S1,S2,f,confC,phierr,Cerr]=coherencyc(data1,data2,tapers,pad,Fs,fpass,err,trialave)
0002 % Multi-taper coherency,cross-spectrum and individual spectra - continuous process
0003 %
0004 % Usage:
0005 % [C,phi,S12,S1,S2,f,confC,phierr,Cerr]=coherencyc(data1,data2,tapers,pad,Fs,fpass,err,trialave)
0006 % Input:
0007 % Note units have to be consistent. See chronux.m for more information.
0008 %       data1 (in form samples x trials) -- required
0009 %       data2 (in form samples x trials) -- required
0010 %       tapers (precalculated tapers from dpss, or in the form [NW K] e.g [3 5]) -- optional. If not
0011 %                                                 specified, use [NW K]=[3 5]
0012 %        pad            (padding factor for the FFT) - optional. Defaults to 0.
0013 %                       e.g. For N = 500, if PAD = 0, we pad the FFT
0014 %                       to 512 points; if PAD = 2, we pad the FFT
0015 %                       to 2048 points, etc.
0016 %       Fs   (sampling frequency) - optional. Default 1.
0017 %       fpass    (frequency band to be used in the calculation in the form
0018 %                                   [fmin fmax])- optional.
0019 %                                   Default all frequencies between 0 and Fs/2
0020 %       err  (error calculation [1 p] - Theoretical error bars; [2 p] - Jackknife error bars
0021 %                                   [0 p] or 0 - no error bars) - optional. Default 0.
0022 %       trialave (average over trials when 1, don't average when 0) - optional. Default 0
0023 % Output:
0024 %       C (abs of coherency - frequencies x trials for no trial averaging)
0025 %       phi (phase of coherency - frequencies x trials for no trial averaging)
0026 %       S12 (cross spectrum - frequencies x trials for no trial averaging)
0027 %       S1 (spectrum 1- frequencies x trials for no trial averaging)
0028 %       S2 (spectrum 2- frequencies x trials for no trial averaging)
0029 %       f (frequencies)
0030 %       confC (confidence level for C at 1-p %)
0031 %       phierr (error bars for phi)
0032 %       Cerr  (Jackknife error bars for C - use only for Jackknife)
0033 if nargin < 2; error('Need data1 and data2'); end;
0034 if nargin < 3; tapers=[3 5]; end;
0035 if nargin < 4;pad=0;end;
0036 if nargin < 5; Fs=1; end;
0037 if nargin < 6; fpass=[0 Fs/2]; end;
0038 if nargin<7; err=0; end;
0039 if nargin<8; trialave=0;end;
0040 if nargout > 8 & err(1)~=2; 
0041     error('Cerr computed only for Jackknife. Correct inputs and run again');
0042 end;
0043 
0044 if isempty(tapers); tapers=[3 5]; end;
0045 if isempty(pad);pad=0;end;
0046 if isempty(Fs); Fs=1; end;
0047 if isempty(fpass); fpass=[0 Fs/2]; end;
0048 if isempty(err); err=0; end;
0049 if isempty(trialave); trialave=0;end;
0050 [N1,C1,N2,C2]=check_consistency(data1,data2);
0051 N=N1;
0052 nfft=2^(nextpow2(N)+pad);
0053 [f,findx]=getfgrid(Fs,nfft,fpass); 
0054 tapers=dpsschk(tapers,N,Fs); % check tapers
0055 J1=mtfftc(data1,tapers,nfft,Fs);
0056 J2=mtfftc(data2,tapers,nfft,Fs);
0057 J1=J1(findx,:,:); J2=J2(findx,:,:);
0058 S12=squeeze(mean(conj(J1).*J2,2));
0059 S1=squeeze(mean(conj(J1).*J1,2));
0060 S2=squeeze(mean(conj(J2).*J2,2));
0061 if trialave; S12=squeeze(mean(S12,2)); S1=squeeze(mean(S1,2)); S2=squeeze(mean(S2,2)); end;
0062 C12=S12./sqrt(S1.*S2);
0063 C=abs(C12); 
0064 phi=angle(C12);
0065 if nargout==9; 
0066      [confC,phierr,Cerr]=coherr(C,J1,J2,err,trialave);
0067 elseif nargout==8;
0068      [confC,phierr]=coherr(C,J1,J2,err,trialave);
0069 end;

Generated on Tue 07-Jun-2005 12:20:32 by m2html © 2003