diff --git a/docs/conf.py b/docs/conf.py index 2bd3422..5b66372 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,6 +36,8 @@ 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', + 'sphinx.ext.todo', + 'sphinx.ext.githubpages', ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle index 1027b01..505b70c 100644 Binary files a/docs/doctrees/environment.pickle and b/docs/doctrees/environment.pickle differ diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo index fe8f712..651120c 100644 --- a/docs/html/.buildinfo +++ b/docs/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 7d83c8e02845da3c34ad294d2f9c3384 +config: 5e41ee917ff6b71b00d615738a2904d4 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/html/.nojekyll b/docs/html/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/html/objects.inv b/docs/html/objects.inv index 6306edc..4d5e360 100644 Binary files a/docs/html/objects.inv and b/docs/html/objects.inv differ diff --git a/docs/html/py-modindex.html b/docs/html/py-modindex.html index 4620db9..ec9186d 100644 --- a/docs/html/py-modindex.html +++ b/docs/html/py-modindex.html @@ -174,6 +174,16 @@

Python Module Index

fuller + + +     + fuller.generator + + + +     + fuller.metrics +     diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js index 590f808..59615a3 100644 --- a/docs/html/searchindex.js +++ b/docs/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["fuller_generator","fuller_metrics","fuller_mrfRec","fuller_utils","index","inst_start"],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:56},filenames:["fuller_generator.rst","fuller_metrics.rst","fuller_mrfRec.rst","fuller_utils.rst","index.rst","inst_start.rst"],objects:{"fuller.utils":{binarize:[3,1,1,""],coeffgen:[3,1,1,""],cut_margins:[3,1,1,""],fexp:[3,1,1,""],findFiles:[3,1,1,""],interpolate2d:[3,1,1,""],loadH5Parts:[3,1,1,""],loadHDF:[3,1,1,""],load_bandstruct:[3,1,1,""],load_calculation:[3,1,1,""],load_multiple_bands:[3,1,1,""],nonneg_sum_decomposition:[3,1,1,""],nzbound:[3,1,1,""],pick_operator:[3,1,1,""],saveHDF:[3,1,1,""],segmod:[3,1,1,""],to_masked:[3,1,1,""],tqdmenv:[3,1,1,""],trim_2d_edge:[3,1,1,""],valrange:[3,1,1,""]},fuller:{mrfRec:[2,0,0,"-"],utils:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:function"},terms:{"class":0,"default":3,"final":0,"float":3,"function":[0,1,4],"int":[0,1,3],"long":0,"return":[0,1,3],"true":[0,3],For:0,The:[0,3,5],abserror:1,absolut:[1,3],absum:3,accord:0,across:0,add:[0,3],add_band:0,addit:[0,1,3],address:[0,3],after:0,against:1,alia:3,alias:3,align:[0,1],all:[0,1,3],along:[0,1,3],altogeth:0,amount:3,amp:3,amplitud:[0,3],angl:0,ani:0,annot:0,anoth:0,api:4,appli:[1,3],approxim:[0,1],argument:[0,1,3],arr:[1,3],arrai:[0,1,3],assign:3,associ:3,assum:0,averag:1,axes:[0,3],axi:[0,1,3],axial:1,backend:0,band:[3,4],band_index:0,bandcut:0,bandcutt:0,bandstack:0,bar:[0,3],base:[0,3],basi:0,basis_kwd:0,basis_typ:0,basisgen:0,baxi:[0,3],befor:0,between:[0,1],beyond:0,binar:3,bind:0,bool:[0,3],bottom:0,bottommost:0,bound:3,boundari:0,brillouin:[0,1],brillouinzon:0,calcul:[1,3],can:5,cband:0,ccw:0,center:0,center_det:0,centroidnn:0,cfs:3,check_axi:0,choos:3,classic:[0,3],coeff:0,coeffgen:[0,3],coeffici:[0,3],collect:3,colum_s:0,column:0,com:5,combin:3,compar:1,complex:3,compos:0,comput:0,conduct:0,construct:0,contain:[0,1,3],content:3,convert:3,coordin:0,cosin:1,could:0,custom:3,cut:0,cut_margin:3,cutedg:0,cutimag:0,cutrang:0,cvd:0,daofind:0,data:[0,3],dco:1,decompos:0,decomposit:[0,3],decomposition_hex2d:0,deform:0,deg:0,degre:0,delim:3,delimit:3,demean:1,depend:[0,5],detect:0,determin:0,diagon:0,dict:[0,1,3],dictionari:[0,1,3],differ:3,dimenion:1,dimens:[0,3],dimension:0,direciton:1,direct:[0,1,3],directori:3,displai:0,distanc:[0,1],distribut:[0,3],dmean:0,draw:3,drop:3,drop_axi:3,drop_po:3,dtyp:3,dtype:3,each:[0,1,3],eband:3,ebandsynthes:0,edg:[0,3],edgepad:0,edir:0,either:0,electron:0,element:[0,3],enabl:0,enam:3,end:3,end_1:3,end_2:3,energi:[0,3],entri:[1,3],env:3,envelop:3,environ:[0,3],equal:3,error:1,execut:3,exist:[0,5],exponenti:3,extra:[1,3],extract:[0,3],fals:0,fdir:3,featur:[0,1],feature_mat:1,fexp:3,field:0,figsiz:0,file:[0,3],filenam:[0,3],filter:0,final_s:0,find:3,findfil:3,findlandmark:0,finer:[0,3],first:[0,3],flat:3,flatten:0,fmetric:1,folder:[0,3],folder_dict:3,folder_nam:3,follow:[3,5],form:[0,3],format:[0,3],four:[0,3],from:[0,1,3,5],fstring:3,ftype:3,fuller:5,gamma:0,gap_id:0,gener:[3,4],generate_data:0,geometr:0,geq:3,git:5,github:5,given:[0,3],global:3,greater:3,grid:[0,3],griddata:0,group:3,h5py:3,hdf5:3,hdf:3,hexagon:0,hexdiag:0,hexfilt:0,hexmask:0,hexpad:0,hextil:0,hierarch:3,hierarchi:3,higher:1,horizont:0,how:4,http:5,ids:0,idx:1,ignor:0,imag:[0,3],imbas:0,img:0,imshift:0,imsid:0,incorpor:3,indaxi:0,independ:0,index:[0,1,3],indic:[0,3],individu:0,inform:3,input:1,instal:4,instruct:4,intens:0,interest:0,intermedi:[0,3],interp_ord:0,interpol:[0,3],interpolate2d:[0,3],intrins:0,irregularli:0,its:5,jupyt:3,kei:1,keyword:[0,1,3],kit:5,kname:3,kval:0,kwarg:[0,1,3],kwd:[0,1,3],landmark:0,latest:5,latter:0,least:[0,1],left:0,legendr:0,length:3,leq:3,less:3,limit:3,line:0,lineshap:0,linewidth:0,list:[0,1,3],load:[0,3],load_addr:3,load_bandstruct:3,load_calcul:3,load_data:0,load_multiple_band:3,loader:3,loadfunc:0,loadh5part:3,loadhdf:3,locat:[0,3],lookahead:0,lower:0,magnitud:0,main:5,manner:3,map:0,map_coordin:0,margin:[0,3],mask:[0,1,3],masked_imag:0,maskgen:0,matelem:0,matrix:[0,1],matrix_el:0,maxid:3,maximum:3,mean:[0,1],meanax:1,method:0,metric:4,miss:0,modul:[0,3],momentum:[0,3],mpe:5,mpesdatagener:0,mrfrec:4,multidimension:0,multipl:3,name:3,namestr:[0,3],nan:0,nanmax:0,natsort:3,nband:0,ncb:0,ndarrai:3,ndimag:0,need:0,newer:3,nkx:3,nky:3,nmax:0,none:[0,1,3],nonneg:3,nonneg_sum_decomposit:3,nonzero:3,notebook:[0,3],npix:0,nterm:0,number:[0,3],numer:[0,3],numpi:[0,1,3],nvb:0,nzbound:3,object:[0,3],obtain:0,off:0,offset:1,offseti:3,offsetx:3,ofs:1,old:3,oldi:3,oldx:3,one:0,onli:0,op_packag:0,oper:[0,3],option:[0,3],order:[0,3],ordinari:3,origin:0,orthogon:0,out:0,outdict:3,output:3,outsid:0,outtyp:3,overrid:0,overwrit:5,pacakg:3,packag:[0,3,5],pad:0,pad_bottom:0,pad_left:0,pad_right:0,pad_top:0,pad_xxx:0,padded_view:0,page:[],pair:1,paramet:[0,1,3],parametr:4,paramt:3,part:3,patch:0,path:3,pattern:0,pbar:0,pbenv:0,per:1,perpendicular:0,photoelectron:0,photoemiss:0,photoemss:0,pick_oper:3,piecewis:0,pip:5,pixel:[0,1,3],plane:0,plot:0,plotli:0,point:[0,3],polydecompos:0,polynomi:0,polyreconstruct:0,polytyp:0,posit:[0,3],previous:1,process:0,progress:[0,3],projectionfilt:0,properti:0,provid:0,quantif:4,quantiti:0,rand_gauss:0,random:3,rang:[0,3],read:3,reconstruct:[0,1,3,4],reconstruction_hex2d:0,rectangular:0,ref:1,refangl:0,refer:[0,1],reflect:0,reflectodeform:0,reflectosymmetr:0,refsym:0,region:0,regular:0,repositori:5,resampl:0,reshap:3,respect:0,respons:0,restor:0,result:[0,1,3],ret:[0,3],retriev:3,rettyp:0,right:0,rotat:0,rotodeform:0,rotosymdetect:0,rotosymmetr:0,rotrang:0,rotsym:0,row:0,row_siz:0,sampl:3,save:[0,3],save_addr:[0,3],save_band:0,save_data:0,save_item:0,savehdf:3,scale:3,scatterkw:0,scipi:0,search:[],see:[0,3],seed:3,segment:0,segmod:3,select:0,select_band:0,select_slic:0,selector:0,separ:0,sequenc:3,set:0,set_amplitud:0,set_band:0,set_eaxi:0,set_energi:0,set_kval:0,set_landmark:0,set_lineshap:0,set_linewidth:0,set_mask:0,set_matrix_el:0,set_nband:0,set_spac:0,set_srfwidth:0,shape:0,should:0,show:0,side:[0,1,3],sigma:0,similar:[1,3],similarity_matrix:1,simul:0,singl:3,sixfold:0,size:[0,3],slice:0,smallest:0,smat:1,softwar:[0,3],space:[0,3],specif:[0,3],specifi:[0,1,3],squar:0,srf:0,sstring:3,stack:0,start:4,start_1:3,start_2:3,state:0,step:0,store:3,str:[0,3],string:3,structur:[3,4],substructur:3,subtract:[0,1],sum:3,summari:0,suppli:0,symmetr:0,symmetri:0,synthes:0,synthesi:0,synthet:0,system:0,term:0,thei:3,three:0,threshold:3,tight:0,tightest:0,tile:0,to_mask:3,top:0,topmost:0,tqdm:3,tqdmenv:3,trace:0,track_ord:3,transdeform:0,translat:0,treat:3,trim:3,trim_2d_edg:3,truncat:0,tupl:[0,1,3],turn:0,two:[0,3],type:[0,3],uniform:3,upgrad:5,use:[0,3],used:[0,3],using:0,util:[0,4],val:3,valenc:0,valrang:3,valu:[0,3],variabl:[0,3],varnam:3,vband:0,vector:1,version:5,vertex:0,vertic:0,visual:0,wai:[3,5],where:3,which:[1,3],width:0,wise:0,within:0,xtran:0,ytran:0,zernik:0,zone:[0,1]},titles:["Band structure parametrization (fuller.generator)","Band structure quantification (fuller.metrics)","Band structure reconstruction (fuller.mrfRec)","Utility functions (fuller.utils)","fuller documentation","How to start"],titleterms:{"function":3,band:[0,1,2],document:4,fuller:[0,1,2,3,4],gener:0,how:5,indic:[],instal:5,metric:1,mrfrec:2,parametr:0,quantif:1,reconstruct:2,start:5,structur:[0,1,2],tabl:[],util:3,welcom:[]}}) \ No newline at end of file +Search.setIndex({docnames:["fuller_generator","fuller_metrics","fuller_mrfRec","fuller_utils","index","inst_start"],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.todo":2,sphinx:56},filenames:["fuller_generator.rst","fuller_metrics.rst","fuller_mrfRec.rst","fuller_utils.rst","index.rst","inst_start.rst"],objects:{"fuller.generator":{BrillouinZoner:[0,1,1,""],EBandSynthesizer:[0,1,1,""],MPESDataGenerator:[0,1,1,""],bandstack:[0,3,1,""],cutedge:[0,3,1,""],decomposition_hex2d:[0,3,1,""],hexfilter:[0,3,1,""],hexmask:[0,3,1,""],hexpad:[0,3,1,""],hextiler:[0,3,1,""],polydecompose:[0,3,1,""],polyreconstruct:[0,3,1,""],projectionfilter:[0,3,1,""],reconstruction_hex2d:[0,3,1,""],reflectodeform:[0,3,1,""],reflectosymmetrize:[0,3,1,""],refsym:[0,3,1,""],restore:[0,3,1,""],rotodeform:[0,3,1,""],rotosymdetect:[0,3,1,""],rotosymmetrize:[0,3,1,""],transdeform:[0,3,1,""]},"fuller.generator.BrillouinZoner":{bandcutter:[0,2,1,""],findlandmarks:[0,2,1,""],load_data:[0,2,1,""],maskgen:[0,2,1,""],nbands:[0,2,1,""],resample:[0,2,1,""],save_data:[0,2,1,""],select_slice:[0,2,1,""],set_bands:[0,2,1,""],set_eaxis:[0,2,1,""],set_kvals:[0,2,1,""],set_landmarks:[0,2,1,""],set_mask:[0,2,1,""],summary:[0,2,1,""],visualize:[0,2,1,""]},"fuller.generator.EBandSynthesizer":{basisgen:[0,2,1,""],coeffgen:[0,2,1,""],save_bands:[0,2,1,""],set_kvals:[0,2,1,""],set_mask:[0,2,1,""],set_nbands:[0,2,1,""],set_spacing:[0,2,1,""],summary:[0,2,1,""],synthesize:[0,2,1,""],visualize:[0,2,1,""]},"fuller.generator.MPESDataGenerator":{add_bands:[0,2,1,""],generate_data:[0,2,1,""],nbands:[0,2,1,""],parameters:[0,2,1,""],save_data:[0,2,1,""],select_bands:[0,2,1,""],set_amplitude:[0,2,1,""],set_bands:[0,2,1,""],set_energy:[0,2,1,""],set_kvals:[0,2,1,""],set_lineshape:[0,2,1,""],set_linewidth:[0,2,1,""],set_matrix_elements:[0,2,1,""],set_srfwidth:[0,2,1,""],summary:[0,2,1,""]},"fuller.metrics":{abserror:[1,3,1,""],dcos:[1,3,1,""],demean:[1,3,1,""],similarity_matrix:[1,3,1,""]},"fuller.utils":{binarize:[3,3,1,""],coeffgen:[3,3,1,""],cut_margins:[3,3,1,""],fexp:[3,3,1,""],findFiles:[3,3,1,""],interpolate2d:[3,3,1,""],loadH5Parts:[3,3,1,""],loadHDF:[3,3,1,""],load_bandstruct:[3,3,1,""],load_calculation:[3,3,1,""],load_multiple_bands:[3,3,1,""],nonneg_sum_decomposition:[3,3,1,""],nzbound:[3,3,1,""],pick_operator:[3,3,1,""],saveHDF:[3,3,1,""],segmod:[3,3,1,""],to_masked:[3,3,1,""],tqdmenv:[3,3,1,""],trim_2d_edge:[3,3,1,""],valrange:[3,3,1,""]},fuller:{generator:[0,0,0,"-"],metrics:[1,0,0,"-"],mrfRec:[2,0,0,"-"],utils:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"class":0,"default":3,"final":0,"float":3,"function":[0,1,4],"int":[0,1,3],"long":0,"return":[0,1,3],"true":[0,3],For:0,The:[0,3,5],abserror:1,absolut:[1,3],absum:3,accord:0,across:0,add:[0,3],add_band:0,addit:[0,1,3],address:[0,3],after:0,against:1,alia:3,alias:3,align:[0,1],all:[0,1,3],along:[0,1,3],altogeth:0,amount:3,amp:3,amplitud:[0,3],angl:0,ani:0,annot:0,anoth:0,api:4,appli:[1,3],approxim:[0,1],argument:[0,1,3],arr:[1,3],arrai:[0,1,3],assign:3,associ:3,assum:0,averag:1,axes:[0,3],axi:[0,1,3],axial:1,backend:0,band:[3,4],band_index:0,bandcut:0,bandcutt:0,bandstack:0,bar:[0,3],base:[0,3],basi:0,basis_kwd:0,basis_typ:0,basisgen:0,baxi:[0,3],befor:0,between:[0,1],beyond:0,binar:3,bind:0,bool:[0,3],bottom:0,bottommost:0,bound:3,boundari:0,brillouin:[0,1],brillouinzon:0,calcul:[1,3],can:5,cband:0,ccw:0,center:0,center_det:0,centroidnn:0,cfs:3,check_axi:0,choos:3,classic:[0,3],coeff:0,coeffgen:[0,3],coeffici:[0,3],collect:3,colum_s:0,column:0,com:5,combin:3,compar:1,complex:3,compos:0,comput:0,conduct:0,construct:0,contain:[0,1,3],content:3,convert:3,coordin:0,cosin:1,could:0,custom:3,cut:0,cut_margin:3,cutedg:0,cutimag:0,cutrang:0,cvd:0,daofind:0,data:[0,3],dco:1,decompos:0,decomposit:[0,3],decomposition_hex2d:0,deform:0,deg:0,degre:0,delim:3,delimit:3,demean:1,depend:[0,5],detect:0,determin:0,diagon:0,dict:[0,1,3],dictionari:[0,1,3],differ:3,dimenion:1,dimens:[0,3],dimension:0,direciton:1,direct:[0,1,3],directori:3,displai:0,distanc:[0,1],distribut:[0,3],dmean:0,draw:3,drop:3,drop_axi:3,drop_po:3,dtyp:3,dtype:3,each:[0,1,3],eband:3,ebandsynthes:0,edg:[0,3],edgepad:0,edir:0,either:0,electron:0,element:[0,3],enabl:0,enam:3,end:3,end_1:3,end_2:3,energi:[0,3],entri:[1,3],env:3,envelop:3,environ:[0,3],equal:3,error:1,execut:3,exist:[0,5],exponenti:3,extra:[1,3],extract:[0,3],fals:0,fdir:3,featur:[0,1],feature_mat:1,fexp:3,field:0,figsiz:0,file:[0,3],filenam:[0,3],filter:0,final_s:0,find:3,findfil:3,findlandmark:0,finer:[0,3],first:[0,3],flat:3,flatten:0,fmetric:1,folder:[0,3],folder_dict:3,folder_nam:3,follow:[3,5],form:[0,3],format:[0,3],four:[0,3],from:[0,1,3,5],fstring:3,ftype:3,fuller:5,gamma:0,gap_id:0,gener:[3,4],generate_data:0,geometr:0,geq:3,git:5,github:5,given:[0,3],global:3,greater:3,grid:[0,3],griddata:0,group:3,h5py:3,hdf5:3,hdf:3,hexagon:0,hexdiag:0,hexfilt:0,hexmask:0,hexpad:0,hextil:0,hierarch:3,hierarchi:3,higher:1,horizont:0,how:4,http:5,ids:0,idx:1,ignor:0,imag:[0,3],imbas:0,img:0,imshift:0,imsid:0,incorpor:3,indaxi:0,independ:0,index:[0,1,3],indic:[0,3],individu:0,inform:3,input:1,instal:4,instruct:4,intens:0,interest:0,intermedi:[0,3],interp_ord:0,interpol:[0,3],interpolate2d:[0,3],intrins:0,irregularli:0,its:5,jupyt:3,kei:1,keyword:[0,1,3],kit:5,kname:3,kval:0,kwarg:[0,1,3],kwd:[0,1,3],landmark:0,latest:5,latter:0,least:[0,1],left:0,legendr:0,length:3,leq:3,less:3,limit:3,line:0,lineshap:0,linewidth:0,list:[0,1,3],load:[0,3],load_addr:3,load_bandstruct:3,load_calcul:3,load_data:0,load_multiple_band:3,loader:3,loadfunc:0,loadh5part:3,loadhdf:3,locat:[0,3],lookahead:0,lower:0,magnitud:0,main:5,manner:3,map:0,map_coordin:0,margin:[0,3],mask:[0,1,3],masked_imag:0,maskgen:0,matelem:0,matrix:[0,1],matrix_el:0,maxid:3,maximum:3,mean:[0,1],meanax:1,method:0,metric:4,miss:0,modul:[0,3],momentum:[0,3],mpe:5,mpesdatagener:0,mrfrec:4,multidimension:0,multipl:3,name:3,namestr:[0,3],nan:0,nanmax:0,natsort:3,nband:0,ncb:0,ndarrai:3,ndimag:0,need:0,newer:3,nkx:3,nky:3,nmax:0,none:[0,1,3],nonneg:3,nonneg_sum_decomposit:3,nonzero:3,notebook:[0,3],npix:0,nterm:0,number:[0,3],numer:[0,3],numpi:[0,1,3],nvb:0,nzbound:3,object:[0,3],obtain:0,off:0,offset:1,offseti:3,offsetx:3,ofs:1,old:3,oldi:3,oldx:3,one:0,onli:0,op_packag:0,oper:[0,3],option:[0,3],order:[0,3],ordinari:3,origin:0,orthogon:0,out:0,outdict:3,output:3,outsid:0,outtyp:3,overrid:0,overwrit:5,pacakg:3,packag:[0,3,5],pad:0,pad_bottom:0,pad_left:0,pad_right:0,pad_top:0,pad_xxx:0,padded_view:0,pair:1,paramet:[0,1,3],parametr:4,paramt:3,part:3,patch:0,path:3,pattern:0,pbar:0,pbenv:0,per:1,perpendicular:0,photoelectron:0,photoemiss:0,photoemss:0,pick_oper:3,piecewis:0,pip:5,pixel:[0,1,3],plane:0,plot:0,plotli:0,point:[0,3],polydecompos:0,polynomi:0,polyreconstruct:0,polytyp:0,posit:[0,3],previous:1,process:0,progress:[0,3],projectionfilt:0,properti:0,provid:0,quantif:4,quantiti:0,rand_gauss:0,random:3,rang:[0,3],read:3,reconstruct:[0,1,3,4],reconstruction_hex2d:0,rectangular:0,ref:1,refangl:0,refer:[0,1],reflect:0,reflectodeform:0,reflectosymmetr:0,refsym:0,region:0,regular:0,repositori:5,resampl:0,reshap:3,respect:0,respons:0,restor:0,result:[0,1,3],ret:[0,3],retriev:3,rettyp:0,right:0,rotat:0,rotodeform:0,rotosymdetect:0,rotosymmetr:0,rotrang:0,rotsym:0,row:0,row_siz:0,sampl:3,save:[0,3],save_addr:[0,3],save_band:0,save_data:0,save_item:0,savehdf:3,scale:3,scatterkw:0,scipi:0,see:[0,3],seed:3,segment:0,segmod:3,select:0,select_band:0,select_slic:0,selector:0,separ:0,sequenc:3,set:0,set_amplitud:0,set_band:0,set_eaxi:0,set_energi:0,set_kval:0,set_landmark:0,set_lineshap:0,set_linewidth:0,set_mask:0,set_matrix_el:0,set_nband:0,set_spac:0,set_srfwidth:0,shape:0,should:0,show:0,side:[0,1,3],sigma:0,similar:[1,3],similarity_matrix:1,simul:0,singl:3,sixfold:0,size:[0,3],slice:0,smallest:0,smat:1,softwar:[0,3],space:[0,3],specif:[0,3],specifi:[0,1,3],squar:0,srf:0,sstring:3,stack:0,start:4,start_1:3,start_2:3,state:0,step:0,store:3,str:[0,3],string:3,structur:[3,4],substructur:3,subtract:[0,1],sum:3,summari:0,suppli:0,symmetr:0,symmetri:0,synthes:0,synthesi:0,synthet:0,system:0,term:0,thei:3,three:0,threshold:3,tight:0,tightest:0,tile:0,to_mask:3,top:0,topmost:0,tqdm:3,tqdmenv:3,trace:0,track_ord:3,transdeform:0,translat:0,treat:3,trim:3,trim_2d_edg:3,truncat:0,tupl:[0,1,3],turn:0,two:[0,3],type:[0,3],uniform:3,upgrad:5,use:[0,3],used:[0,3],using:0,util:[0,4],val:3,valenc:0,valrang:3,valu:[0,3],variabl:[0,3],varnam:3,vband:0,vector:1,version:5,vertex:0,vertic:0,visual:0,wai:[3,5],where:3,which:[1,3],width:0,wise:0,within:0,xtran:0,ytran:0,zernik:0,zone:[0,1]},titles:["Band structure parametrization (fuller.generator)","Band structure quantification (fuller.metrics)","Band structure reconstruction (fuller.mrfRec)","Utility functions (fuller.utils)","fuller documentation","How to start"],titleterms:{"function":3,band:[0,1,2],document:4,fuller:[0,1,2,3,4],gener:0,how:5,instal:5,metric:1,mrfrec:2,parametr:0,quantif:1,reconstruct:2,start:5,structur:[0,1,2],util:3}}) \ No newline at end of file