searchindex.js

Search.setIndex({docnames:["api","auto_examples/index","auto_examples/plot_comodulogram","auto_examples/plot_dar_model","auto_examples/plot_grid_search","auto_examples/plot_mne_epoch_masking","auto_examples/plot_peak_locking","auto_examples/plot_phase_delay","auto_examples/plot_spurious_pac","auto_examples/plot_surrogate_analysis","auto_examples/sg_execution_times","generated/pactools.AddDriverDelay","generated/pactools.Comodulogram","generated/pactools.DARSklearn","generated/pactools.DelayEstimator","generated/pactools.ExtractDriver","generated/pactools.MaskIterator","generated/pactools.MultipleArray","generated/pactools.PeakLocking","generated/pactools.dar_model.DAR","generated/pactools.dar_model.StableDAR","generated/pactools.dar_model.extract_driver","generated/pactools.raw_to_mask","generated/pactools.simulate_pac","generated/pactools.utils.fir.BandPassFilter","generated/pactools.utils.fir.LowPassFilter","generated/pactools.utils.peak_finder.peak_finder","generated/pactools.utils.spectrum.Bicoherence","generated/pactools.utils.spectrum.Coherence","generated/pactools.utils.spectrum.Spectrum","getting_started","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":2,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["api.rst","auto_examples/index.rst","auto_examples/plot_comodulogram.rst","auto_examples/plot_dar_model.rst","auto_examples/plot_grid_search.rst","auto_examples/plot_mne_epoch_masking.rst","auto_examples/plot_peak_locking.rst","auto_examples/plot_phase_delay.rst","auto_examples/plot_spurious_pac.rst","auto_examples/plot_surrogate_analysis.rst","auto_examples/sg_execution_times.rst","generated/pactools.AddDriverDelay.rst","generated/pactools.Comodulogram.rst","generated/pactools.DARSklearn.rst","generated/pactools.DelayEstimator.rst","generated/pactools.ExtractDriver.rst","generated/pactools.MaskIterator.rst","generated/pactools.MultipleArray.rst","generated/pactools.PeakLocking.rst","generated/pactools.dar_model.DAR.rst","generated/pactools.dar_model.StableDAR.rst","generated/pactools.dar_model.extract_driver.rst","generated/pactools.raw_to_mask.rst","generated/pactools.simulate_pac.rst","generated/pactools.utils.fir.BandPassFilter.rst","generated/pactools.utils.fir.LowPassFilter.rst","generated/pactools.utils.peak_finder.peak_finder.rst","generated/pactools.utils.spectrum.Bicoherence.rst","generated/pactools.utils.spectrum.Coherence.rst","generated/pactools.utils.spectrum.Spectrum.rst","getting_started.rst","index.rst"],objects:{"pactools.AddDriverDelay":{__init__:[11,1,1,""]},"pactools.Comodulogram":{__init__:[12,1,1,""]},"pactools.DARSklearn":{__init__:[13,1,1,""]},"pactools.DelayEstimator":{__init__:[14,1,1,""]},"pactools.ExtractDriver":{__init__:[15,1,1,""]},"pactools.MaskIterator":{__init__:[16,1,1,""]},"pactools.MultipleArray":{__init__:[17,1,1,""]},"pactools.PeakLocking":{__init__:[18,1,1,""]},"pactools.dar_model":{DAR:[19,0,1,""],StableDAR:[20,0,1,""],extract_driver:[21,2,1,""]},"pactools.dar_model.DAR":{__init__:[19,1,1,""]},"pactools.dar_model.StableDAR":{__init__:[20,1,1,""]},"pactools.utils.fir":{BandPassFilter:[24,0,1,""],LowPassFilter:[25,0,1,""]},"pactools.utils.fir.BandPassFilter":{__init__:[24,1,1,""]},"pactools.utils.fir.LowPassFilter":{__init__:[25,1,1,""]},"pactools.utils.peak_finder":{peak_finder:[26,2,1,""]},"pactools.utils.spectrum":{Bicoherence:[27,0,1,""],Coherence:[28,0,1,""],Spectrum:[29,0,1,""]},"pactools.utils.spectrum.Bicoherence":{__init__:[27,1,1,""]},"pactools.utils.spectrum.Coherence":{__init__:[28,1,1,""]},"pactools.utils.spectrum.Spectrum":{__init__:[29,1,1,""]},pactools:{AddDriverDelay:[11,0,1,""],Comodulogram:[12,0,1,""],DARSklearn:[13,0,1,""],DelayEstimator:[14,0,1,""],ExtractDriver:[15,0,1,""],MaskIterator:[16,0,1,""],MultipleArray:[17,0,1,""],PeakLocking:[18,0,1,""],raw_to_mask:[22,2,1,""],simulate_pac:[23,2,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","function","Python function"]},objtypes:{"0":"py:class","1":"py:method","2":"py:function"},terms:{"0x7fb6f97287c0":9,"0x7fb70a6999d0":[],"0x7fd5ecd21d30":[27,28,29],"1st":7,"2min":4,"2nd":7,"3rd":7,"4th":7,"640x300":5,"boolean":[12,13,14,15,19,20,21,23,24,27,28,29],"case":[7,16,22],"class":[3,11,12,13,14,15,16,17,18,19,20,24,25,27,28,29,30],"default":[3,9,12,14,16,18,22,23,24,25,26],"final":4,"float":[2,8,12,13,14,15,16,18,19,20,21,22,23,24,25,26,27,28,29],"function":[5,8,22,27,28,29],"import":[2,3,4,5,6,7,8,9,11,12,13,15,16,17,22,24,25,30],"int":[2,5,7,8,12,13,14,15,16,19,20,21,22,23,27,28,29],"long":5,"public":30,"return":[5,7,8,9,15,21,22,23,24,26],"true":[3,5,8,9,12,13,14,15,19,20,21,23,24,27,28,29],Adding:9,And:3,Axes:[5,12],For:9,IDs:5,Not:5,One:30,That:4,The:[2,5,6,7,9,13,14,16,21,22,23,26],Then:[2,4,5,9,30],These:[5,9],Use:21,Used:12,Using:4,With:9,__import__:5,__init__:[11,12,13,14,15,16,17,18,19,20,24,25,27,28,29],__name__:5,__package__:5,__path__:5,__spec__:5,_mod:5,_tempdir:5,_unique_:5,a_i:[19,20],a_p:20,aac:12,abov:26,absenc:[8,9],accross:3,accur:[11,12,13,14,15,16,17,18,19,24,25,27,28,29],acknowledg:31,acoust:20,activ:[5,8,30],add:[4,7,11,21],add__delai:[4,11],add_ev:5,adddriverdelai:4,adding:9,addit:23,after:[5,15,16,21,22],agg:[2,3,4,5,6,7,8,9],aic:[19,20],aka:21,alexandr:30,algorithm:26,all:[1,7,16,21,22,30],all_mask:16,along:[16,22],alpha:7,also:[3,5,7,9,18,22,30],altern:5,among:30,amount:[8,26],amplitud:[2,3,4,5,6,7,8,12,13,14,18,19,20,22,23,27,28,29,31],amplitude_channel:5,analysi:[1,10,12,14,30],analyz:18,ani:[4,9,30],annot:7,anr:30,api:31,appli:[5,12],approach:30,arang:[4,5,7,8,12],around:[5,18,22],arrai:[4,5,7,12,16,17,18,21,22,23,26],articl:30,artif:23,artifici:[2,3,4,6,9,23],assum:[9,16,22],attribut:[12,13,17,19,20],author:30,auto:[7,8,12,14,18,19,20,31],auto_exampl:10,auto_examples_jupyt:1,auto_examples_python:1,autoregress:[4,12,13,19,20],autotim:30,avail:5,averag:[5,6,18],avoid:30,ax_logl:7,ax_phas:7,ax_speci:12,axes:[2,8,12],axs:[2,3,7,8,9],axs_:7,back:5,backend:[2,3,4,5,6,7,8,9],band:[2,3,6,9,12,14,18,21,24,30],band_pass_filt:18,bandpass:[4,15,21,24],bandpassfilt:18,bandstop:21,bandwidth:[3,6,7,12,14,15,18,21,23,24,25],bar:[4,12],bartlett:[27,28,29],base:[12,14,20,30],baselin:5,basi:[13,19,20],becaus:5,befor:[5,15,16,21,22],begin:7,behav:22,below:[5,30],best:[4,7,14],best_model_:7,best_params_:4,better:4,between:[4,7,8,9,12,14,23,27,28,29],bic:[3,19,20],bic_arrai:3,bicoher:12,biologi:30,biorxiv:[7,8,14,19],bispectrum:[2,12],bit:5,blackman:[27,28,29],block:[12,27,28,29],block_length:[12,27,28,29],blue:7,both:[4,6,7,15,22],build:[5,8],burst:7,calcul:[16,22],call:[2,9],can:[5,7,8,9,17,18,30],candid:4,cannot:[2,3,4,5,6,7,8,9],canolti:[2,9,12],carrier:5,ce37:30,ceil:[2,8],center:[12,13,15,19,20,21,23,24],ch1:5,channel:[5,22],check:30,check_random_st:8,choos:[4,9,18],circl:7,cite:31,clean_peak_find:7,click:[2,3,4,5,6,7,8,9],close:[5,7,9],code:[1,2,3,4,5,6,7,8,9,26,30],coher:12,coherence_param:12,col:4,col_mean:4,col_std:4,colgin:[2,9,12],color:[5,7,8],column:4,com:30,command:30,comod_:12,comod_arrai:12,comod_max:[8,9],comodulogram:[1,3,5,8,9,10],compar:[4,13,15,21],comparison:30,complex:[15,21,23,24],compon:[7,9,14],comput:[2,3,4,5,8,9,12,13,14,18,27,28,29,30],concurr:4,conda:5,condit:7,confer:20,configur:4,consid:9,constant:[7,14,21],contain:[12,22],contour:8,contour_level:[8,9],contour_method:[8,9],control:23,convers:26,convert:8,convolut:8,core:9,correct:5,correspond:[4,5,7,9,21,23],cortic:8,cos:7,cosph_peak_ind:7,could:5,coupl:[2,3,4,5,7,8,9,12,14,18,19,22,23,31],cours:5,cpu:9,creat:[2,3,4,5,6,7,9,16,20],create_info:5,criterion:[3,19,20],cross:[1,7,8,10,11,13,14,15,17,19,21,22,30],cross_valid:4,cumsum:[7,8],current:[2,3,4,5,6,7,8,9],cut:[5,25],cv_results_:[4,11,13,15],cyan:7,cycl:21,dalal:9,dar:[1,4,5,7,8,9,10,11,12,13,14,15,20,31],dar__ordar:[4,11,15],dar__ordriv:[4,11,15],dar_model:[3,7,14],darsklearn:[4,11,15,17],data:[5,7,16,22,26,30],datafram:4,dataset:5,deep:7,def:[4,5,7,8],defin:[2,4,5,9,12,15,21,23],delai:[1,4,10,11,14,19,23,30],delay_:7,delay_estim:7,delay_point:7,delayestim:7,demonstr:[5,8],densiti:5,deouell:8,depend:[7,12,30],deriv:9,describ:[19,20],design:[20,24,25],desir:26,detail:30,develop:30,deviat:[5,8,9,18],dict:12,dictionari:12,differ:[5,9,13,30],dimens:[4,16,22],direction:12,directli:5,disabl:5,disantangl:7,discuss:9,distinct:7,distribut:9,ditribut:9,divid:[13,19,20],document:30,doe:[9,13],doi:30,don:5,done:[4,5,15,21],donorm:[27,28,29],download:[1,2,3,4,5,6,7,8,9],doyer:[19,30],draw:[2,5,8,21],drawn:12,driven:[12,19,20,31],driver:[4,5,7,11,12,13,15,19,20,21,23],driver__low_fq:[4,15],driver__low_fq_width:4,dtype:5,dupr:[7,8,14,19,20,30,31],duprelatour2017nonlinear:30,duprelatour:[2,3,5,8,9,12],e0167351:8,each:[3,4,5,6,9,16,20,22,27,28,29],easi:[4,30],edu:26,edward:9,eeg:5,effect:[5,6,9],egg:30,either:5,elaps:4,electr:15,empir:9,empti:12,enabl:30,energi:[13,19,20],enf:[15,21],entir:30,env:5,epoch:[4,5],eps_gain:[13,19,20],eps_newton:20,equal:[7,22,27,28,29],erc:30,error:[18,30],est:7,estim:[2,3,4,5,6,7,8,9,12,13,14,19,20,22,27,28,29,30,31],evalu:[4,22],even:8,event:[5,16,22],everyth:[3,30],evok:5,exactli:9,exampl:[2,3,4,5,6,7,8,9,21,22,24,25,27,28,29,31],execut:10,exogen:20,exp:[5,7],expans:[13,19,20],extrac:4,extract:[3,6,7,12,15,21],extract_complex:[3,15,21,24],extract_driv:3,extract_param:12,extractdriv:4,extrema:[7,26],eye:5,fairli:13,fall:5,fals:[2,3,4,5,7,13,15,19,21,22,23,24],far:[9,30],fast:[7,8,14,23,26],featur:30,fft:[12,27,28,29],fft_length:[12,27,28,29],fftconvolv:8,fif:5,fig:[2,3,7,8,9],figsiz:[2,3,7,8,9],figur:[2,3,4,5,6,7,8,9,12,21],file:[5,10],fill:[3,7,15,21],fill_between:7,fill_zon:7,filter:[4,12,14,15,18,21,24,25,30],filter_method:18,find:26,find_ev:5,fine:30,finish:4,fir:18,first:[2,3,4,5,6,7,9,13,26,30],first_samp:5,fit:[1,2,4,5,6,7,8,9,10,11,12,13,14,15,17,19,30],fit_dar_and_plot:7,flag:30,float64:5,fluctuat:[4,9],fmax:5,fold:4,follow:[4,29,30],font_scal:7,fork:31,found:[4,5,26],four:7,frac:20,frang:7,frequenc:[2,3,5,6,7,8,9,12,13,14,15,16,18,19,21,22,23,24,25,27,28,29,30],from:[2,3,4,5,6,7,8,9,11,12,13,14,15,16,17,21,22,24,25,26],full:[2,3,4,5,6,7,8,9,21,23],gain:[13,19,20],galleri:[2,3,4,5,6,7,8,9,31],gamma:[7,9],gamma_:20,gamma_i:20,gamma_peak_ind:7,gap:21,gaussian1d:5,gaussian:[8,9,15,21,23],gca:4,gener:[1,2,3,4,5,6,7,8,9,12,14,15,21,22,23],gerber:8,get:[3,5,31],get_color:7,get_titl:3,git:30,github:[2,3,4,5,6,7,8,9,30,31],give:[3,9,30],given:[2,4,5,9,16,22],goe:5,good:[8,9,30],grabot:[19,30],gramfort:[19,20,30],grant:30,greater:[27,28,29],green:7,grenier:[19,20,30],grid:[1,2,7,9,10,11,13,14,15,17,19,30],grid_search:[4,11,13,15,17],gridsearchcv:[4,11,13,15,17,31],gridsearchcvprogressbar:4,gridspec_kw:7,group:[16,22],gscv:[4,11,13,15,17],gui:[2,3,4,5,6,7,8,9],h5py:30,hagihira:12,half:[8,27,28,29],ham:[27,28,29],handl:[3,17],happen:7,have:[4,9,15,20,21],help:[11,12,13,14,15,16,17,18,19,24,25,27,28,29],here:[2,3,4,5,6,7,8,9],high:[7,8,9,22,30],high_fq:[2,3,4,5,6,7,9,23],high_fq_amp:[7,23],high_fq_rang:[8,12,18],high_fq_width:[12,18],high_sig:[4,5,15,21,22],higher:4,highpass:[4,15],hilbert:[12,30],hline:7,home:[2,3,4,5,6,7,8,9],horizont:7,horizontalalign:7,how:[5,7,8,9],http:30,human:9,hyperparamet:[3,4],icassp:20,ident:[4,7],identifi:26,idex:30,ieee:20,imaginari:[21,24],implement:[30,31],importlib:5,importwarn:5,includ:[16,18,22],incorrect:30,independ:9,independantli:3,index:[4,12,16,17,22,31],indic:[16,22,26],info:5,initi:[7,11,12,13,14,15,16,17,18,19,24,25,26,27,28,29],input:[4,5,21,22],instal:[12,31],instanc:[5,12,14,15,21,22,23],instanci:[2,9],instantan:[7,13,19,20],instead:23,int_:8,interact:[5,8],interfac:[1,4,10,12,13,16,30],intern:20,interv:[5,7],interval_max:8,interval_min:8,ipynb:[2,3,4,5,6,7,8,9],isotrak:5,issu:9,item:5,iter:[5,13,16,19,20],iter_gain:[13,19,20],iter_newton:20,its:[5,13,19,20,30],ixs:[5,22],jiang:12,job:12,join:5,joint:12,journal:30,jupyt:[1,2,3,4,5,6,7,8,9],k_i:20,k_p:20,kaiser:25,keep:[15,21],kfold:4,kind:5,kirsch:9,knight:[8,9],kwarg:20,label:4,laetitia:30,larger:26,last:5,latest:30,lattic:20,learn:[4,12,13,30,31],leav:5,left:20,legend:[3,4],legitim:30,len:[2,5,8,16,22],length:[12,16,27,28,29],let:[2,3,4,5,6,8,9],letter:21,level:[8,9,23],leverag:9,lib:5,librari:30,like:22,likelihood:[4,7,13,14,30],line:[3,7],linear:[7,8,14,19,30],lines_modul:7,lines_theta:7,linestyl:7,linspac:[2,3,5,8,9,12,18],list:[2,9,12,16,17,18,22],locat:5,lock:[1,9,10,18,30],log:[4,8,13,19,20],logl:[19,20],loop:[4,7],low:[2,3,6,8,9,22,25],low_fq:[2,3,4,5,6,7,9,14,15,18,21,23],low_fq_amp:23,low_fq_mod_amp:7,low_fq_mod_fq:7,low_fq_rang:[2,3,5,8,9,12],low_fq_width:[2,3,4,5,6,7,8,9,12,14,15,18,23],low_fq_width_2:12,low_sig:[4,5,15,21,22],low_sigs_imag:21,lucil:30,magnitud:26,mai:[12,14],make:5,mani:[4,9],marker:4,mask:[5,16,22],maskiter:[5,22],match:5,mathrm:7,matlab:26,matplotlib:[2,3,4,5,6,7,8,9,12,30],max:[12,16,22,26],max_delai:14,max_low_fq:[4,15,21],max_ordar:[4,11,13,15,19],maxim:7,maxima:[9,26],maximum:[7,8,9,13,14,15,18,19,20,21,23,25],mean:[5,9,13,18,19,20,24,26],mean_test_scor:4,messag:30,metadata:5,method:[2,3,5,8,9,11,12,13,14,15,16,17,18,19,20,24,25,27,28,29,30],metric:[2,9],middl:7,min:[12,16,22,26],mindtim:30,minima:26,minimum:[7,12,18,25],minimum_shift:12,minut:[2,3,4,5,6,7,8,9],mne:[1,10,12,16,18,22,30],mod_fun:5,mode:[5,7,8],model:[1,4,7,8,10,11,12,13,14,15,17,19,20,21,31],model_select:[11,13,15,17],model_selection_criterions_:3,modul:[3,7,12,23,31],monitor:4,month:30,more:[5,26,30],most:30,multipl:[4,9],multiple_band_pass:18,multiplearrai:[4,11,13,15],must:[16,22],n_channel:[5,22],n_column:[2,8],n_cycl:[21,24],n_decai:11,n_epoch:[4,21],n_event:[5,16,22],n_high:18,n_job:[4,8,9,12],n_line:[2,8],n_mask:[16,22],n_percentil:18,n_point:[2,3,4,5,6,7,8,9,16,21,22,23],n_points_plot:8,n_spikes_max:8,n_surrog:[8,9,12],n_time:[5,22],n_window:[16,22],nagarajan:9,nagashima:12,name:[3,4],nathanael:26,nbest:4,ncol:8,ncyoder:26,ndarrai:17,ndim:[16,22],need:[2,5,9,30],neocortex:9,nest:8,network:15,neural:[7,8,14,19,30,31],newton:20,next:4,nice:4,nois:[8,15,21,23,26],noise_level:[2,3,4,5,6,7,9,23],non:[2,3,4,5,6,7,8,9,14,19,30],none:[3,4,7,8,12,14,15,16,17,19,20,21,22,23,24,26,27,28,29],nor:9,norm:[15,21],normal:[13,15,19,20,21,27,28,29],nota:9,note:[3,4,6,7,26],notebook:[1,2,3,4,5,6,7,8,9],notim:30,notion:7,nrow:8,number:[6,9,12,13,14,15,19,20,21,22,23,24,25,30],numpi:[2,3,4,5,7,8,9,17,30],object:[2,5,9,12,17,18,22],obtain:[9,14],off:[5,25],offset:7,one:[4,5,8,16,22,30],one_mask:[16,22],ones:[5,17,27,28,29],onli:[12,21,22],onset:5,open:5,optim:[3,7,14],option:30,ordar:[3,7,13,15,17,19,20,21],ordar_:3,order:[3,4,13,15,19,20,21],ordriv:[3,7,13,17,19,20],ordriv_:3,org:30,origin:9,ortho:[13,19,20],orthogon:[13,19,20],oscil:[6,7,8,9,14,18,23,24,30],other:[4,5,9],otherwis:[16,22],out:[2,3,4,5,6,7,8,9],output:[4,5,16,22],outsid:22,over:[4,5,7,9,13,15,21,30],overlap:[12,27,28,29],ozkurt:[2,8,9,12],p_valu:[8,9],pac:[1,2,3,4,5,6,9,10,12,14,16,19,22,23,31],pac_exampl:5,packag:[5,30,31],pactool:[2,3,4,5,6,7,8,9],pad:12,page:[30,31],pair:[9,16,22],panda:4,parallel:[4,12],param:4,param_:4,param_grid:[4,11,13,15,17],paramet:[3,4,9,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30],parametr:[19,20],pari:30,part:[21,24],particular:[30,31],pass:[12,14,16,18,22,24,25],passband:25,path:5,pcbi:30,peak:[1,5,7,10,18,26],peak_find:7,peak_ind:7,peak_loc:26,peak_mag:26,peak_or_trough:18,peaklock:6,penni:[2,8,9,12],percentil:[9,18],perfect:7,perform:[3,4],phase:[1,2,3,4,5,8,9,10,12,14,18,19,22,23,31],phase_channel:5,phase_str:7,phenomenon:8,phi:7,phi_0:[7,23],phi_0_:7,pink:8,pink_nois:8,pip:30,pipelin:[4,11,15],pitfal:30,pivot:4,pivot_t:4,pleas:30,plo:[8,30],plot:[2,3,4,5,6,7,8,9,12,18,24,25],plot_comodulogram:[2,10],plot_dar_model:[3,10],plot_fq_rang:7,plot_grid_search:[4,10],plot_mne_epoch_mask:[5,10],plot_peak_lock:[6,10],plot_phase_delai:[7,10],plot_psd:5,plot_result:4,plot_spurious_pac:[8,10],plot_surrogate_analysi:[9,10],plt:[2,3,4,5,6,7,8,9],plug:4,point:[13,23],posit:[8,25],possibl:9,potenti:[3,9,13,15,21],power:[5,9],prefer:23,prepar:[3,4,8],present:[4,9,30,31],print:[2,4,11,13,15,17],probabilist:30,procedur:9,process:20,produc:8,progress:[4,12],progress_bar:[2,3,5,9,12,13,19],project:[5,30],proport:21,provid:[4,16,22,30,31],pseudo:23,publish:30,purdu:26,purpl:7,purpos:5,put:4,py38:5,pyplot:[2,3,4,5,6,7,8,9],python3:5,python:[1,2,3,4,6,7,8,9,10,12,16,30],quantifi:3,randn:7,random:[7,9,12,14,15,21,23],random_st:[2,3,4,5,6,7,8,9,12,14,15,21,23],randomst:[7,12,14,15,21,23],rang:[2,4,5,9,14],raphson:20,ratio:7,ravel:[2,3,8],raw:[5,6,16,22],raw_to_mask:5,rawarrai:5,read:30,readi:5,real:[24,26],recommend:30,recomput:9,recquir:[9,12],red:7,refer:[2,4,9,14,19,20,30],refit:14,regress:[7,8,14,19,20,31],relat:30,reli:5,remov:[4,7,9,15,21],render:5,repeat:26,replac:[15,21],repres:30,represent:[6,18],requir:26,resolv:5,resp:18,respect:7,rest:21,result:[2,4,5,6],return_driv:23,return_train_scor:4,rie:30,right:[7,20],rippl:25,ripple_db:25,rng:[7,8],roll:7,room:5,root:5,rule:[8,9],run:[2,3,4,5,6,7,8,9],runtimewarn:5,saclai:30,sadeh:8,same:[3,8,15,21,22],sampl:[5,12,13,14,15,16,18,21,23,24,25,27,28,29],save:5,scale:[15,21],scheme:[13,15,21],scienc:[9,30],scikit:[4,12,13,30,31],scipi:[8,30],score:[4,9,12,30],script:[2,3,4,5,6,7,8,9],seaborn_palett:7,search:[1,10,11,13,15,17,19,30,31],sec:[5,6,7,8,9,12],second:[2,3,4,5,6,7,8,9,16,18,22],see:[11,12,13,14,15,16,17,18,19,24,25,27,28,29],seed:[12,14,15,21,23],seen:5,sel:7,select:[3,4,5,19,20,22,26,30],self:[11,12,13,14,15,16,17,18,19,20,24,25,27,28,29],sequentialbackend:4,seri:[5,7,8,14,19,30,31],set:[3,4,5,8,27,28,29],set_styl:7,set_titl:[3,7],set_xlabel:[3,7],set_xlim:7,set_xtick:7,set_xticklabel:7,set_ylabel:3,set_ytick:7,set_yticklabel:7,sever:[2,17],sfreq:5,shape:[7,16,18,21,22,23],sharex:8,sharp:[7,23],shift:[1,9,10,12,14,19,30],should:[7,16,21,22,27,28,29,30],show:[2,3,4,5,6,7,8,9,30],shown:[5,12],side:5,sig:[3,7,21],sigdriv:[3,11,13,15,17,19,20],sigdriv_imag:[3,11,13,15,17],sigin:[3,11,13,15,17,19,20],sigl:[2,12],sigma:[5,9,19,20],sigmoid:[7,23],sigmoid_sharp:23,signal:[2,3,4,5,6,7,8,9,12,14,15,17,18,20,21,22,23,24,27,28,29,30],signal_in:[12,24,25],signal_no_pac:5,signal_out:[24,25],signal_pac:5,signatur:[11,12,13,14,15,16,17,18,19,24,25,27,28,29],signific:[8,9],significantli:9,simpl:[9,19],simul:[5,7,8,23],simulate_and_plot:7,simulate_pac:[2,3,4,5,6,9],simulate_spurious_pac:8,simultan:30,sin:7,singl:17,sinusoid:[7,8],site:5,size:[5,8],sklearn:[4,11,13,15,17],slab:30,slice:7,slope:8,slow:[6,7,9,14,18,23,30],soltani:9,some:[8,17],sourc:[1,2,3,4,5,6,7,8,9,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29],spatial:5,special:12,specif:30,specifi:25,spectral:[5,29],spectrum:[3,20,30],speech:20,sphinx:[1,2,3,4,5,6,7,8,9],spike:[1,10,12,30],spike_amp:8,spike_fq:8,spike_fwhm:8,spike_interv:8,spike_interval_jitt:8,spike_posit:8,spike_shap:8,spike_std:8,split:[4,16,22],spuriou:[1,10,12,30],sqrt:8,squar:7,stabl:[4,20,30],standard:[5,8,9,18],start:[4,7,16,22,31],start_idx:7,stationari:7,std:[8,18],std_test_scor:4,stdout:12,ste:18,step:[3,4,11,12,15,21,27,28,29],sti:5,stim:5,stim_channel:5,stop:[7,13,16,19,20,22],stop_idx:7,stopband:25,store:[17,22],strategi:[4,15,21],strenght:30,string:[12,18,19,20,21],subplot:[2,3,7,8,9],subtract:[4,13,19,20,21,24],success:[27,28,29],suffer:9,sum:24,sum_:[19,20],suppli:[16,22],support:30,surrog:[1,10,12,14,30],surround:26,t_plot:[6,7,18],tabl:4,table_mean:4,table_std:4,take:5,tallot:[19,30],tau:7,tau_0:7,taylor:[13,19,20],tempor:[1,10,14,19,30],test:[4,9],text:[3,7],than:[5,30],them:[2,9,17,22],theta:[7,9],theta_peak_ind:7,thi:[2,3,4,5,7,8,9,14,16,17,19,20,22,31],third:[16,22],though:8,thresh:[7,26],threshold:[9,13,19,20],thumb:[8,9],tick:7,ticklabel:7,tight_layout:[5,7,8],time:[2,3,4,5,6,7,8,9,11,12,14,16,18,19,20,22,30,31],titl:[2,4,8,9,30],tmax:[5,16,22],tmin:[5,16,22],tmp:5,tmp_mne_tempdir_1v72636i:5,togeth:[4,16,22],toler:26,tom:[2,3,4,5,6,7,8,9,30],tool:[30,31],top:9,topographi:5,tort:[2,8,9,12],total:[2,3,4,5,6,7,8,9,10],tour:[7,8,14,19,20,30,31],train:[4,8],transax:7,transform:[7,9,11,12,22,24,25,30],trial:5,trial_len:5,trough:18,two:[3,4,7,9,12,14,22,24,30],type:[11,12,13,14,15,16,17,18,19,24,25,27,28,29],typic:30,unchang:[15,21],uniform:8,uniqu:30,unit:[13,15,19,20,21],upgrad:30,url:30,use:[3,4,5,8,9,12,13,16,22,30],use_driver_phas:[13,19,20],used:[2,9,12,14,15,17,19,20,21,22,23,24,27,28,29],useful:5,userwarn:[2,3,4,5,6,7,8,9],uses:[12,14,18,19,20],using:[2,3,4,5,6,7,8,9],usual:8,util:[5,7,8,31],val:30,valeri:30,valid:[1,8,10,11,13,15,17,19,21,30],valu:[4,9,12,26],van:[19,30],vanwijk:[2,12],varepsilon:[19,20],vari:7,vector:[13,19,20,26],verbos:4,version:30,vertic:7,via:30,virgini:30,visual:[4,5],viz:[5,7],vline:7,vmax:12,vmin:12,volum:30,want:5,ward:8,warn:22,warn_gain_estimation_failur:[13,19],wassenhov:[19,30],wave:6,wavelet:[24,25],weitght:[27,28,29],welch:29,wfunc:[27,28,29],when:[7,15,21],where:[2,5,7,22],whether:[15,21],which:[2,3,4,5,6,7,8,9,11,22,23,27,28,29,30],white:[15,21,23],whiten:[15,21],why:4,wide:30,width:8,width_ratio:7,window:[5,12,22,25,27,28,29],without:[3,22],work:[2,3,4,5,6,7,8,9,31],worker:4,would:7,write:5,xlabel:8,xycoord:7,year:30,yellow:7,yerr:4,ylabel:4,yoder:26,you:[5,9,22,30],your:[9,30],ystg:30,yve:30,z_score:9,zero:[5,7,8,9,12,17],zero_mean:24,zeros_lik:7,zip:[1,2,4,7,8]},titles:["API Documentation","Gallery of Examples","Comodulogram","Fitting a DAR model","Grid-search and cross-validation","Interface with MNE-python","Peak-locking","Phase shift and temporal delay in PAC","Spurious PAC with spikes","Surrogate analysis","Computation times","pactools.AddDriverDelay","pactools.Comodulogram","pactools.DARSklearn","pactools.DelayEstimator","pactools.ExtractDriver","pactools.MaskIterator","pactools.MultipleArray","pactools.PeakLocking","pactools.dar_model.DAR","pactools.dar_model.StableDAR","pactools.dar_model.extract_driver","pactools.raw_to_mask","pactools.simulate_pac","pactools.utils.fir.BandPassFilter","pactools.utils.fir.LowPassFilter","pactools.utils.peak_finder.peak_finder","pactools.utils.spectrum.Bicoherence","pactools.utils.spectrum.Coherence","pactools.utils.spectrum.Spectrum","Getting Started with pactools","Welcome to pactools\u2019 documentation!"],titleterms:{acknowledg:30,adddriverdelai:11,amplitud:[0,30],analysi:9,api:0,auto:[0,30],bandpassfilt:24,bicoher:27,cite:30,coher:28,comodulogram:[2,12,30],comput:10,content:31,coupl:[0,30],cross:4,dar:[0,3,19,30],dar_model:[19,20,21,30],darsklearn:13,delai:7,delayestim:14,document:[0,31],driven:[0,30],exampl:[1,11,12,13,14,15,16,17,18,19,30],extract_driv:21,extractdriv:15,fir:[24,25],fit:3,galleri:1,get:30,grid:4,gridsearchcv:0,indic:31,instal:30,interfac:5,learn:0,lock:6,lowpassfilt:25,maskiter:16,mne:5,model:[0,3,30],multiplearrai:17,pac:[0,7,8,30],pactool:[11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31],peak:6,peak_find:26,peaklock:18,phase:[0,7,30],python:5,raw_to_mask:22,refer:[7,8],regress:[0,30],scikit:0,search:4,shift:7,simulate_pac:23,spectrum:[27,28,29],spike:8,spuriou:8,stabledar:20,start:30,surrog:9,tabl:31,tempor:7,thi:30,time:10,using:[11,12,13,14,15,16,17,18,19,30],util:[0,24,25,26,27,28,29],valid:4,welcom:31,work:30}})