-
4. Create pyfits library
-
FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the default tool:
-
pyfits <http://www.stsci.edu/institute/software_hardware/pyfits>.
-
To mitigate this problem a C++ class defined in fits.h is used. A simple possibility to create an interface of this C++ class and python is to use the
-
pyroot http://root.cern.ch/drupal/category/package-context/pyroot> module.
+
+
4. Create pyfits_h.so library
+
FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the existing tools:
+
pyfits <http://www.stsci.edu/institute/software_hardware/pyfits> which uses cfitsio.
+
To mitigate this problem a C++ class defined in fits.h is used. A simple possibility to create an interface of this C++ class is to use ROOT and later to import it using the
+pyroot module.
+
got to the directory: pyscripts/pyfact
simple:
-
[pceth118] /home/luster/py > root
-ROOT 5.28/00h (branches/v5-28-00-patches@42209, Feb 13 2012, 23:52:00 on linux)
+[lusterma@isdc-cn02 pyfact]$ root
+ROOT 5.28/00 (trunk@37585, Dec 14 2010, 15:20:27 on linuxx8664gcc)
CINT/ROOT C/C++ Interpreter version 5.18.00, July 2, 2010
Type ? for help. Commands must be C++ statements.
Enclose multiple statements between { }.
+
root [0] .L fits.h++
-Info in <TUnixSystem::ACLiC>: creating shared library /home/luster/py/./fits_h.so
+Info in <TUnixSystem::ACLiC>: creating shared library /home_nfs/isdc/lusterma/pyscripts/pyfact/./fits_h.so
root [1]
This might not work for whatenver reason then it should be done like this:
+$rootcint -f my_dict.C -c fits.h izstream.h
+$g++ -fPIC -c -I$ROOTSYS/include my_dict.C -o my_dict.o
+$g++ -o fits_h.so -shared my_dict.o
+
Now you can check if the reading rawdata is working:
+$ pyfact.py
+this should print some data from a few events
@@ -133,5 +142,5 @@
-
-class pyfact.RawData(data_file_name, calib_file_name, user_action_calib=<function <lambda> at 0xa818844>, baseline_file_name='', return_dict=None)
+class pyfact.RawData(data_file_name, calib_file_name, user_action_calib=<function <lambda> at 0xab028b4>, baseline_file_name='', return_dict=None)
raw data access and calibration
+
Footnotes
+
@@ -285,5 +301,5 @@
2. Environment variables
3. Check out the repository
-
4. Create pyfits library
+
4. Create pyfits_h.so library
5. Run examples
Index: fact/tools/pyscripts/doc/_build/html/index.html
===================================================================
--- fact/tools/pyscripts/doc/_build/html/index.html (revision 13323)
+++ fact/tools/pyscripts/doc/_build/html/index.html (revision 13324)
@@ -59,5 +59,5 @@
2. Environment variables
3. Check out the repository
-
4. Create pyfits library
+
4. Create pyfits_h.so library
5. Run examples
Index: fact/tools/pyscripts/doc/_build/html/searchindex.js
===================================================================
--- fact/tools/pyscripts/doc/_build/html/searchindex.js (revision 13323)
+++ fact/tools/pyscripts/doc/_build/html/searchindex.js (revision 13324)
@@ -1,1 +1,1 @@
-Search.setIndex({objects:{"pyfact.fnames":{info:[5,0,1],make:[5,0,1]},"pyfact.RawData":{info:[5,0,1],baseline_read_values:[5,0,1],baseline_correct:[5,0,1],data_file:[5,1,1],npix:[5,1,1],next:[5,0,1],calib_file:[5,1,1],nroi:[5,1,1],nevents:[5,1,1],board_times:[5,1,1],start_cells:[5,1,1],next_event:[5,0,1],calibrate_drs_amplitude:[5,0,1],data:[5,1,1]},pyfact:{fnames:[5,2,1],RawData:[5,2,1]}},terms:{all:5,code:[1,0],bsl_sum:5,edu:5,follow:[1,2,5],primer:1,row:5,categori:5,depend:5,program:1,matlab:2,unzip:[3,5],string:[3,5],account:5,readout:5,strang:5,fad:5,bslfname:[],list:[1,3,4,5],"try":5,baslin:5,vector:[],my_scrip:4,dir:4,swdev_nf:5,telescop:5,phyton:[2,0],hplt_mean:5,append:[3,5],index:[0,5],disk:5,pyroot:5,cell:[],version:[1,0,5],"new":1,full:[],aclic:5,gener:1,root_v5:5,here:5,path:[3,5],sinc:5,interpret:5,search:[0,5],cern:5,typic:[],fourier:2,calibr:[3,5],appli:[],modul:[1,0,5,4,2],unig:5,filenam:[3,5],instal:2,unit:5,plot:2,feb:5,zip:[3,5],visit:[],upgrad:2,next:5,few:5,call:[0,4],checkout:5,calf:[],drscal:[3,5],"__iter__":5,particular:4,must:5,none:5,setup:5,work:1,dev:1,ecampl:5,can:4,learn:1,"0x9541844":[],vallu:[],dec:5,root:5,process:2,rpath:[3,5],share:5,indic:0,tag:[3,5],tabl:0,want:5,multipl:5,how:5,env:5,gate:[],simpl:5,luster:5,int16:[],max:[],pyfit:[2,0,5],befor:5,npy:5,date:5,data:[1,0,3,5],averag:[],baseline_read_valu:5,alloc:5,pyfact:[1,0,3,5,2],environ:[2,0,5],allow:2,help:5,soon:2,tunixsystem:5,sumaroundpeak:[],still:2,fir:[0,3],style:[1,0],fit:[2,5],window:[],pixel:5,readbaselin:[],scipi:2,thei:2,python:[1,0,5,4,2],calfnam:[],v_bsl:[],initi:5,software_hardwar:5,petter:1,introduct:[1,0],name:[3,5],slide:[],compris:1,tcshrc:5,nevent:5,our:[],event:5,out:[0,5],variabl:[0,5],miss:2,content:0,print:[3,5],calib_fil:5,correct:[],pyscript:5,pceth118:5,standard:2,dictionari:[3,5],org:[1,5],basi:2,maxpo:[],drupal:5,startcel:[],filter:[0,3],thing:1,length:5,lambda:5,oper:2,softwar:5,suffix:[3,5],arrai:5,misc:2,number:5,echo:4,stsci:5,instruct:5,open:5,convent:[1,0],script:4,"0xa818844":5,system:[2,0,4],least:5,"0xa872844":[],start_cel:5,too:5,statement:5,store:5,shell:5,tool:[1,5],specifi:[3,5],part:2,enclos:5,provid:[1,2,5],data_file_nam:5,project:5,rootsi:5,"function":[2,0,3,5],comput:2,ani:[1,4],raw:5,hava:[],have:5,close:1,need:1,lib:5,min:[],self:[],fact_runinfo:5,fname:[0,3,5],findpeak:[],datacent:5,juli:5,smoothdata:[],filtercfd:[],distribut:2,plenti:5,buffer:5,object:5,bsl:[3,5],most:1,jsp:5,automodul:[],histogram:5,"class":[1,0,3,5],windows:[],doc:[],later:1,fact:[1,0,3,5,2],radik:[3,5],acaldata:[],fine:1,find:5,absolut:5,ratio:[],just:1,should:[1,5],suppos:[1,2,4],analys:1,get:[0,5],run_db:5,return_dict:5,organ:[3,5],bsl_hist:5,patch:5,integr:[],contain:5,logbook:5,where:5,set:5,next_ev:5,result:[3,5],dfname:[],concern:5,data_fil:5,databas:5,"0xa13c844":[],between:5,"import":[0,4,5],attribut:[],web:[],numer:2,filnam:[],han:1,region:5,instanc:5,context:5,col:5,scratch_nf:[3,5],load:5,among:2,linux:5,astropython:1,guid:[1,0],creat:[0,3,4,5],numpi:2,trigger:5,valu:5,interest:5,basic:[1,5],presenc:2,sotwar:[],present:2,"case":1,look:5,packag:[2,5],npix:5,"0xb411844":[],defin:[3,5],board_tim:5,"00h":5,site:[],cluster:[1,2],inform:5,welcom:0,perform:5,make:[3,5],filterslidingaverag:[],member:[],cint:5,document:[1,0],complet:[3,5],http:[1,5],maxamp:[],php:5,studi:1,calib_file_nam:5,task:1,center:5,ld_library_path:5,thought:1,exampl:[1,0,4,5],command:[2,0,4,5],rawdata:[0,3,5],thi:[1,4,5],gzip:5,left:[],baseline_correct:5,execut:4,languag:1,my_script:4,langtangen:1,easi:2,add:[1,5],book:1,"0xa1d7844":[],bin:5,around:[],read:5,calibrate_drs_amplitud:5,like:2,specif:1,bashrc:5,signal:2,"0xa93e844":[],page:[1,0,5],yyyi:[3,5],www:[1,5],right:[],some:5,pipelin:[],yyyymmdd:[3,5],home:5,librari:[0,5],slice:5,pep:1,larg:5,elogbook:5,"0xa187844":[],run:[2,0,3,5],host:5,repositori:[0,5],from:[4,5],subtract:5,about:5,would:1,correctbaselin:[],plan:2,own:4,"0x9b7a844":[],pythonpath:5,within:4,your:[4,5],institut:5,user_action_calib:5,support:1,transform:2,"long":[1,4],avail:5,start:[0,5],interfac:5,includ:[2,5],fraction:[],analysi:[],fits_h:5,pwd:4,link:[0,5],ethz:5,line:4,mitig:5,"true":[3,4,5],info:[3,5],wise:1,possibl:5,"default":5,type:5,autoclass:[],access:[1,0,3,5,2],maximum:[],"0x9f4e844":[],problem:5,constant:[],cfddata:[],novemb:[],isdc:[1,2,5],file:[2,3,5],calibrate_drsamplitud:[],check:[0,5],fill:[],when:5,baseline_file_nam:5,other:2,branch:5,you:[1,4,5],baselin:5,factelog:5,docstr:[],substract:5,palma:5,peak:[],amplitud:5,matplotlib:2,svn:5,"0x94b8844":[],scientif:[1,2],directori:[3,5],time:5,nroi:5},objtypes:{"0":"py:method","1":"py:attribute","2":"py:class"},titles:["Welcome to pyfact’s documentation!","Introduction","phyton in FACT","Classes","Examples","Getting Started"],objnames:{"0":"Python method","1":"Python attribute","2":"Python class"},filenames:["index","introduction","python","classes","examples","getting_started"]})
+Search.setIndex({objects:{"pyfact.fnames":{info:[5,0,1],make:[5,0,1]},"pyfact.RawData":{info:[5,0,1],baseline_read_values:[5,0,1],baseline_correct:[5,0,1],data_file:[5,1,1],npix:[5,1,1],next:[5,0,1],calib_file:[5,1,1],nroi:[5,1,1],nevents:[5,1,1],board_times:[5,1,1],start_cells:[5,1,1],next_event:[5,0,1],calibrate_drs_amplitude:[5,0,1],data:[5,1,1]},pyfact:{fnames:[5,2,1],RawData:[5,2,1]}},terms:{all:5,code:[1,0],bsl_sum:5,my_dict:5,edu:5,follow:[1,2,5],primer:1,row:5,footnot:5,depend:5,program:1,matlab:2,unzip:[3,5],string:[3,5],account:5,readout:5,strang:5,fad:5,bslfname:[],heasarc:[],list:[1,3,4,5],"try":5,baslin:5,vector:[],my_scrip:4,dir:4,cfitsio:5,swdev_nf:5,telescop:5,phyton:[2,0],hplt_mean:5,append:[3,5],index:[0,5],disk:5,pyroot:5,cell:[],version:[1,0,5],"new":1,full:[],aclic:5,gener:1,root_v5:5,here:5,trunk:5,path:[3,5],sinc:5,interpret:5,search:[0,5],cern:[],typic:[],fourier:2,calibr:[3,5],appli:[],"0xa1d7844":[],unig:5,filenam:[3,5],instal:2,unit:5,plot:2,feb:[],zip:[3,5],visit:[],upgrad:2,next:5,few:5,call:[0,4],checkout:5,calf:[],drscal:[3,5],"__iter__":5,particular:4,must:5,none:5,setup:5,work:[1,5],dev:1,ecampl:5,can:[4,5],learn:1,"0x9541844":[],vallu:[],dec:5,root:5,process:2,rpath:[3,5],share:5,indic:0,tag:[3,5],tabl:0,want:5,"0xab028b4":5,multipl:5,how:5,env:5,gate:[],simpl:5,luster:[],bretz:5,mar:5,max:[],"0x9d0687c":[],pyfit:[2,5],befor:5,npy:5,date:5,data:[1,0,3,5],averag:[],baseline_read_valu:5,alloc:5,pyfact:[1,0,3,5,2],environ:[2,0,5],allow:2,help:5,soon:2,tunixsystem:5,sumaroundpeak:[],still:2,fir:[0,3],style:[1,0],fit:[2,5],window:[],fitsio:[],might:5,pixel:5,readbaselin:[],scipi:2,thei:2,python:[1,0,5,4,2],calfnam:[],v_bsl:[],initi:5,software_hardwar:5,petter:1,now:5,introduct:[1,0],name:[3,5],slide:[],compris:1,tcshrc:5,nevent:5,int16:[],our:[],event:5,out:[0,5],variabl:[0,5],open:5,categori:[],print:[3,5],got:5,gov:[],calib_fil:5,correct:[],pyscript:5,pceth118:[],standard:2,reason:5,dictionari:[3,5],org:[1,5],basi:2,maxpo:[],drupal:[],startcel:[],filter:[0,3],thing:1,length:5,lambda:5,oper:2,softwar:5,suffix:[3,5],arrai:5,misc:2,number:5,echo:4,stsci:5,instruct:5,done:5,miss:2,rootcint:5,convent:[1,0],script:4,"0xa818844":[],system:[2,0,4],least:5,"0xa872844":[],start_cel:5,too:5,statement:5,which:5,store:5,shell:5,tool:[1,5],specifi:[3,5],convieni:5,enclos:5,provid:[1,2,5],"0xae4487c":[],data_file_nam:5,project:5,rootsi:5,"function":[2,0,3,5],comput:2,ani:[1,4],raw:5,hava:[],have:5,close:1,need:1,lib:5,min:[],self:[],fact_runinfo:5,fname:[0,3,5],findpeak:[],datacent:5,juli:5,smoothdata:[],pipelin:[],distribut:2,plenti:5,buffer:5,object:5,bsl:[3,5],most:1,jsp:5,automodul:[],histogram:5,"class":[1,0,3,5],windows:[],doc:[],later:[1,5],part:[2,5],fact:[1,0,3,5,2],radik:[3,5],rubric:[],acaldata:[],fine:1,find:5,absolut:5,ratio:[],just:1,should:[1,5],suppos:[1,2,4],analys:1,get:[0,5],run_db:5,return_dict:5,"0x9ad887c":[],organ:[3,5],bsl_hist:5,patch:[],integr:[],contain:5,logbook:5,where:5,set:5,next_ev:5,"0x9cdd87c":[],result:[3,5],content:0,dfname:[],concern:5,data_fil:5,databas:5,written:5,"0xa13c844":[],between:5,"import":[0,4,5],attribut:[],web:[],numer:2,filnam:[],han:1,region:5,instanc:5,context:[],lusterma:5,col:5,scratch_nf:[3,5],load:5,among:2,linux:[],astropython:1,guid:[1,0],creat:[0,3,4,5],numpi:2,trigger:5,valu:5,interest:5,basic:[1,5],presenc:2,sotwar:[],present:2,"case":1,look:5,packag:2,npix:5,"0xb411844":[],whatenv:5,defin:[3,5],board_tim:5,"00h":[],site:[],cluster:[1,2],inform:5,welcom:0,perform:5,pyfits_h:[0,5],make:[3,5],filterslidingaverag:[],member:[],cint:5,document:[1,0],complet:[3,5],http:[1,5],maxamp:[],php:5,studi:1,calib_file_nam:5,task:1,center:5,ld_library_path:5,thought:1,exampl:[1,0,4,5],command:[2,0,4,5],rawdata:[0,3,5],thi:[1,4,5],gzip:5,left:[],baseline_correct:5,execut:4,languag:1,my_script:4,langtangen:1,easi:2,add:[1,5],book:1,modul:[1,0,5,4,2],bin:5,around:[],read:5,calibrate_drs_amplitud:5,"0xa6df87c":[],like:[2,5],specif:1,bashrc:5,signal:2,"0xa93e844":[],page:[1,0,5],yyyi:[3,5],www:[1,5],right:[],some:5,filtercfd:[],yyyymmdd:[3,5],home:[],librari:[0,5],slice:5,fpic:5,pep:1,larg:5,elogbook:5,gsfc:[],"0xa187844":[],home_nf:5,run:[2,0,3,5],host:5,repositori:[0,5],from:[4,5],subtract:5,about:5,would:1,correctbaselin:[],plan:2,own:4,"0x9b7a844":[],pythonpath:5,within:4,your:[4,5],"0x956d87c":[],institut:5,user_action_calib:5,support:1,transform:2,"long":[1,4],avail:5,start:[0,5],interfac:5,includ:[2,5],fraction:[],analysi:[],linuxx8664gcc:5,fits_h:5,pwd:4,link:[0,5],ethz:5,line:4,mitig:5,"true":[3,4,5],info:[3,5],wise:1,possibl:5,"default":[],type:5,autoclass:[],access:[1,0,3,5,2],maximum:[],"0x9f4e844":[],problem:5,constant:[],cfddata:[],novemb:[],isdc:[1,2,5],exist:5,file:[2,3,5],calibrate_drsamplitud:[],check:[0,5],fill:[],when:5,baseline_file_nam:5,other:2,branch:[],you:[1,4,5],baselin:5,factelog:5,docstr:[],substract:5,palma:5,peak:[],amplitud:5,cn02:5,matplotlib:2,svn:5,"0xa1368b4":[],"0x94b8844":[],scientif:[1,2],directori:[3,5],izstream:5,nasa:[],time:5,nroi:5},objtypes:{"0":"py:method","1":"py:attribute","2":"py:class"},titles:["Welcome to pyfact’s documentation!","Introduction","phyton in FACT","Classes","Examples","Getting Started"],objnames:{"0":"Python method","1":"Python attribute","2":"Python class"},filenames:["index","introduction","python","classes","examples","getting_started"]})
Index: fact/tools/pyscripts/doc/_build/latex/pyfact.aux
===================================================================
--- fact/tools/pyscripts/doc/_build/latex/pyfact.aux (revision 13323)
+++ fact/tools/pyscripts/doc/_build/latex/pyfact.aux (revision 13324)
@@ -23,29 +23,82 @@
\newlabel{introduction:introduction}{{1}{3}{Introduction\relax }{chapter.1}{}}
\newlabel{introduction::doc}{{1}{3}{Introduction\relax }{chapter.1}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {2}Classes}{5}{chapter.2}}
+\@writefile{toc}{\contentsline {section}{\numberline {1.1}Python version and modules used}{3}{section.1.1}}
+\newlabel{introduction:python-version-and-modules-used}{{1.1}{3}{Python version and modules used\relax }{section.1.1}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {1.2}Style guide and coding conventions}{3}{section.1.2}}
+\newlabel{introduction:style-guide-and-coding-conventions}{{1.2}{3}{Style guide and coding conventions\relax }{section.1.2}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {2}Getting Started}{5}{chapter.2}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{classes:classes}{{2}{5}{Classes\relax }{chapter.2}{}}
-\newlabel{classes::doc}{{2}{5}{Classes\relax }{chapter.2}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.1}pyfact.py}{5}{section.2.1}}
-\newlabel{classes:pyfact-py}{{2.1}{5}{pyfact.py\relax }{section.2.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.1}rawdata access}{5}{subsection.2.1.1}}
-\newlabel{classes:rawdata-access}{{2.1.1}{5}{rawdata access\relax }{subsection.2.1.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.2}fnames of a data run}{5}{subsection.2.1.2}}
-\newlabel{classes:fnames-of-a-data-run}{{2.1.2}{5}{fnames of a data run\relax }{subsection.2.1.2}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {3}Examples}{7}{chapter.3}}
+\newlabel{getting_started:getting-started}{{2}{5}{Getting Started\relax }{chapter.2}{}}
+\newlabel{getting_started::doc}{{2}{5}{Getting Started\relax }{chapter.2}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.1}1. Important links}{5}{section.2.1}}
+\newlabel{getting_started:important-links}{{2.1}{5}{1. Important links\relax }{section.2.1}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.2}2. Environment variables}{5}{section.2.2}}
+\newlabel{getting_started:environment-variables}{{2.2}{5}{2. Environment variables\relax }{section.2.2}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.3}3. Check out the repository}{6}{section.2.3}}
+\newlabel{getting_started:check-out-the-repository}{{2.3}{6}{3. Check out the repository\relax }{section.2.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.4}4. Create pyfits\_h.so library}{6}{section.2.4}}
+\newlabel{getting_started:create-pyfits-h-so-library}{{2.4}{6}{4. Create pyfits\_h.so library\relax }{section.2.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.5}5. Run examples}{6}{section.2.5}}
+\newlabel{getting_started:run-examples}{{2.5}{6}{5. Run examples\relax }{section.2.5}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {3}Classes}{7}{chapter.3}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{examples::doc}{{3}{7}{Examples\relax }{chapter.3}{}}
-\newlabel{examples:examples}{{3}{7}{Examples\relax }{chapter.3}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {3.1}calling a system command}{7}{section.3.1}}
-\newlabel{examples:calling-a-system-command}{{3.1}{7}{calling a system command\relax }{section.3.1}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {4}phyton in FACT}{9}{chapter.4}}
+\newlabel{getting_started:classes}{{3}{7}{Classes\relax }{chapter.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {3.1}pyfact.py}{7}{section.3.1}}
+\newlabel{getting_started:pyfact-py}{{3.1}{7}{pyfact.py\relax }{section.3.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.1}rawdata access}{7}{subsection.3.1.1}}
+\newlabel{getting_started:rawdata-access}{{3.1.1}{7}{rawdata access\relax }{subsection.3.1.1}{}}
+\newlabel{getting_started:pyfact.RawData}{{3.1.1}{7}{rawdata access\relax }{section*.3}{}}
+\newlabel{getting_started:pyfact.RawData.baseline_correct}{{3.1.1}{7}{rawdata access\relax }{section*.4}{}}
+\newlabel{getting_started:pyfact.RawData.baseline_read_values}{{3.1.1}{7}{rawdata access\relax }{section*.5}{}}
+\newlabel{getting_started:pyfact.RawData.board_times}{{3.1.1}{7}{rawdata access\relax }{section*.6}{}}
+\newlabel{getting_started:pyfact.RawData.calib_file}{{3.1.1}{7}{rawdata access\relax }{section*.7}{}}
+\newlabel{getting_started:pyfact.RawData.calibrate_drs_amplitude}{{3.1.1}{7}{rawdata access\relax }{section*.8}{}}
+\newlabel{getting_started:pyfact.RawData.data}{{3.1.1}{7}{rawdata access\relax }{section*.9}{}}
+\newlabel{getting_started:pyfact.RawData.data_file}{{3.1.1}{7}{rawdata access\relax }{section*.10}{}}
+\newlabel{getting_started:pyfact.RawData.info}{{3.1.1}{7}{rawdata access\relax }{section*.11}{}}
+\newlabel{getting_started:pyfact.RawData.nevents}{{3.1.1}{8}{rawdata access\relax }{section*.12}{}}
+\newlabel{getting_started:pyfact.RawData.next}{{3.1.1}{8}{rawdata access\relax }{section*.13}{}}
+\newlabel{getting_started:pyfact.RawData.next_event}{{3.1.1}{8}{rawdata access\relax }{section*.14}{}}
+\newlabel{getting_started:pyfact.RawData.npix}{{3.1.1}{8}{rawdata access\relax }{section*.15}{}}
+\newlabel{getting_started:pyfact.RawData.nroi}{{3.1.1}{8}{rawdata access\relax }{section*.16}{}}
+\newlabel{getting_started:pyfact.RawData.start_cells}{{3.1.1}{8}{rawdata access\relax }{section*.17}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.2}fnames of a data run}{8}{subsection.3.1.2}}
+\newlabel{getting_started:fnames-of-a-data-run}{{3.1.2}{8}{fnames of a data run\relax }{subsection.3.1.2}{}}
+\newlabel{getting_started:pyfact.fnames}{{3.1.2}{8}{fnames of a data run\relax }{section*.18}{}}
+\newlabel{getting_started:pyfact.fnames.info}{{3.1.2}{8}{fnames of a data run\relax }{section*.19}{}}
+\newlabel{getting_started:pyfact.fnames.make}{{3.1.2}{8}{fnames of a data run\relax }{section*.20}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {4}Classes}{9}{chapter.4}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{python:phyton-in-fact}{{4}{9}{phyton in FACT\relax }{chapter.4}{}}
-\newlabel{python::doc}{{4}{9}{phyton in FACT\relax }{chapter.4}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {5}Indices and tables}{11}{chapter.5}}
+\newlabel{classes:classes}{{4}{9}{Classes\relax }{chapter.4}{}}
+\newlabel{classes::doc}{{4}{9}{Classes\relax }{chapter.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {4.1}pyfact.py}{9}{section.4.1}}
+\newlabel{classes:pyfact-py}{{4.1}{9}{pyfact.py\relax }{section.4.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}rawdata access}{9}{subsection.4.1.1}}
+\newlabel{classes:rawdata-access}{{4.1.1}{9}{rawdata access\relax }{subsection.4.1.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.2}fnames of a data run}{9}{subsection.4.1.2}}
+\newlabel{classes:fnames-of-a-data-run}{{4.1.2}{9}{fnames of a data run\relax }{subsection.4.1.2}{}}
+\newlabel{classes:pyfact.fnames}{{4.1.2}{9}{fnames of a data run\relax }{section*.21}{}}
+\newlabel{classes:pyfact.fnames.info}{{4.1.2}{9}{fnames of a data run\relax }{section*.22}{}}
+\newlabel{classes:pyfact.fnames.make}{{4.1.2}{9}{fnames of a data run\relax }{section*.23}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {4.2}FIR filter functions}{9}{section.4.2}}
+\newlabel{classes:fir-filter-functions}{{4.2}{9}{FIR filter functions\relax }{section.4.2}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {5}Examples}{11}{chapter.5}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{index:indices-and-tables}{{5}{11}{Indices and tables\relax }{chapter.5}{}}
+\newlabel{examples::doc}{{5}{11}{Examples\relax }{chapter.5}{}}
+\newlabel{examples:examples}{{5}{11}{Examples\relax }{chapter.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {5.1}calling a system command}{11}{section.5.1}}
+\newlabel{examples:calling-a-system-command}{{5.1}{11}{calling a system command\relax }{section.5.1}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {6}phyton in FACT}{13}{chapter.6}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{python:phyton-in-fact}{{6}{13}{phyton in FACT\relax }{chapter.6}{}}
+\newlabel{python::doc}{{6}{13}{phyton in FACT\relax }{chapter.6}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {7}Indices and tables}{15}{chapter.7}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{index:indices-and-tables}{{7}{15}{Indices and tables\relax }{chapter.7}{}}
+\@writefile{toc}{\contentsline {chapter}{Index}{17}{section*.24}}
Index: fact/tools/pyscripts/doc/_build/latex/pyfact.idx
===================================================================
--- fact/tools/pyscripts/doc/_build/latex/pyfact.idx (revision 13323)
+++ fact/tools/pyscripts/doc/_build/latex/pyfact.idx (revision 13324)
@@ -0,0 +1,21 @@
+\indexentry{RawData (class in pyfact)|hyperpage}{7}
+\indexentry{baseline\_correct() (pyfact.RawData method)|hyperpage}{7}
+\indexentry{baseline\_read\_values() (pyfact.RawData method)|hyperpage}{7}
+\indexentry{board\_times (pyfact.RawData attribute)|hyperpage}{7}
+\indexentry{calib\_file (pyfact.RawData attribute)|hyperpage}{7}
+\indexentry{calibrate\_drs\_amplitude() (pyfact.RawData method)|hyperpage}{7}
+\indexentry{data (pyfact.RawData attribute)|hyperpage}{7}
+\indexentry{data\_file (pyfact.RawData attribute)|hyperpage}{7}
+\indexentry{info() (pyfact.RawData method)|hyperpage}{7}
+\indexentry{nevents (pyfact.RawData attribute)|hyperpage}{8}
+\indexentry{next() (pyfact.RawData method)|hyperpage}{8}
+\indexentry{next\_event() (pyfact.RawData method)|hyperpage}{8}
+\indexentry{npix (pyfact.RawData attribute)|hyperpage}{8}
+\indexentry{nroi (pyfact.RawData attribute)|hyperpage}{8}
+\indexentry{start\_cells (pyfact.RawData attribute)|hyperpage}{8}
+\indexentry{fnames (class in pyfact)|hyperpage}{8}
+\indexentry{info() (pyfact.fnames method)|hyperpage}{8}
+\indexentry{make() (pyfact.fnames method)|hyperpage}{8}
+\indexentry{fnames (class in pyfact)|hyperpage}{9}
+\indexentry{info() (pyfact.fnames method)|hyperpage}{9}
+\indexentry{make() (pyfact.fnames method)|hyperpage}{9}
Index: fact/tools/pyscripts/doc/_build/latex/pyfact.ilg
===================================================================
--- fact/tools/pyscripts/doc/_build/latex/pyfact.ilg (revision 13323)
+++ fact/tools/pyscripts/doc/_build/latex/pyfact.ilg (revision 13324)
@@ -1,5 +1,7 @@
This is makeindex, version 2.14 [02-Oct-2002] (kpathsea + Thai support).
Scanning style file ./python.ist......done (6 attributes redefined, 0 ignored).
-Scanning input file pyfact.idx...done (0 entries accepted, 0 rejected).
-Nothing written in pyfact.ind.
+Scanning input file pyfact.idx....done (21 entries accepted, 0 rejected).
+Sorting entries....done (91 comparisons).
+Generating output file pyfact.ind....done (48 lines written, 0 warnings).
+Output written in pyfact.ind.
Transcript written in pyfact.ilg.
Index: fact/tools/pyscripts/doc/_build/latex/pyfact.ind
===================================================================
--- fact/tools/pyscripts/doc/_build/latex/pyfact.ind (revision 13323)
+++ fact/tools/pyscripts/doc/_build/latex/pyfact.ind (revision 13324)
@@ -0,0 +1,48 @@
+\begin{theindex}
+\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
+
+ \bigletter B
+ \item baseline\_correct() (pyfact.RawData method), \hyperpage{7}
+ \item baseline\_read\_values() (pyfact.RawData method), \hyperpage{7}
+ \item board\_times (pyfact.RawData attribute), \hyperpage{7}
+
+ \indexspace
+ \bigletter C
+ \item calib\_file (pyfact.RawData attribute), \hyperpage{7}
+ \item calibrate\_drs\_amplitude() (pyfact.RawData method), \hyperpage{7}
+
+ \indexspace
+ \bigletter D
+ \item data (pyfact.RawData attribute), \hyperpage{7}
+ \item data\_file (pyfact.RawData attribute), \hyperpage{7}
+
+ \indexspace
+ \bigletter F
+ \item fnames (class in pyfact), \hyperpage{8, 9}
+
+ \indexspace
+ \bigletter I
+ \item info() (pyfact.fnames method), \hyperpage{8, 9}
+ \item info() (pyfact.RawData method), \hyperpage{7}
+
+ \indexspace
+ \bigletter M
+ \item make() (pyfact.fnames method), \hyperpage{8, 9}
+
+ \indexspace
+ \bigletter N
+ \item nevents (pyfact.RawData attribute), \hyperpage{8}
+ \item next() (pyfact.RawData method), \hyperpage{8}
+ \item next\_event() (pyfact.RawData method), \hyperpage{8}
+ \item npix (pyfact.RawData attribute), \hyperpage{8}
+ \item nroi (pyfact.RawData attribute), \hyperpage{8}
+
+ \indexspace
+ \bigletter R
+ \item RawData (class in pyfact), \hyperpage{7}
+
+ \indexspace
+ \bigletter S
+ \item start\_cells (pyfact.RawData attribute), \hyperpage{8}
+
+\end{theindex}
Index: fact/tools/pyscripts/doc/_build/latex/pyfact.log
===================================================================
--- fact/tools/pyscripts/doc/_build/latex/pyfact.log (revision 13323)
+++ fact/tools/pyscripts/doc/_build/latex/pyfact.log (revision 13324)
@@ -1,3 +1,3 @@
-This is pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4) (format=pdflatex 2011.2.7) 9 FEB 2012 10:54
+This is pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4) (format=pdflatex 2012.3.14) 5 APR 2012 18:22
entering extended mode
**pyfact.tex
@@ -853,42 +853,75 @@
]
Chapter 2.
+
+Underfull \hbox (badness 10000) in paragraph at lines 185--187
+[]\T1/ptm/m/n/10 here you find in-for-ma-tion
+ []
+
+[5]
+LaTeX Font Info: Try loading font information for T1+pcr on input line 256.
+ (/usr/share/texmf/tex/latex/psnfss/t1pcr.fd
+File: t1pcr.fd 2001/06/04 font definitions for T1/pcr.
+) [6]
+Chapter 3.
LaTeX Font Info: Font shape `T1/phv/bx/n' in size <12> not available
-(Font) Font shape `T1/phv/b/n' tried instead on input line 144.
-[5] [6
+(Font) Font shape `T1/phv/b/n' tried instead on input line 292.
+LaTeX Font Info: Font shape `T1/pcr/bx/n' in size <10> not available
+(Font) Font shape `T1/pcr/b/n' tried instead on input line 296.
+[7
]
-Chapter 3.
-LaTeX Font Info: Try loading font information for T1+pcr on input line 157.
-(/usr/share/texmf/tex/latex/psnfss/t1pcr.fd
-File: t1pcr.fd 2001/06/04 font definitions for T1/pcr.
-)
-LaTeX Font Info: Font shape `T1/pcr/bx/n' in size <9> not available
-(Font) Font shape `T1/pcr/b/n' tried instead on input line 158.
- [7] [8
-
-]
+Underfull \hbox (badness 10000) in paragraph at lines 447--447
+[]\T1/ptm/m/it/10 specifier=[`012', `023', `2011', `11', `24'], rpath='/scratch
+_nfs/res/bsl/',
+ []
+
+[8]
Chapter 4.
-[9] [10
+
+Underfull \hbox (badness 10000) in paragraph at lines 496--496
+[]\T1/ptm/m/it/10 specifier=[`012', `023', `2011', `11', `24'], rpath='/scratch
+_nfs/res/bsl/',
+ []
+
+[9
+
+] [10
]
Chapter 5.
-(./pyfact.ind) [11] (./pyfact.aux) )
+LaTeX Font Info: Font shape `T1/pcr/bx/n' in size <9> not available
+(Font) Font shape `T1/pcr/b/n' tried instead on input line 543.
+[11] [12
+
+]
+Chapter 6.
+[13] [14
+
+]
+Chapter 7.
+(./pyfact.ind [15] [16
+
+] [17
+
+
+]) (./pyfact.aux) )
Here is how much of TeX's memory you used:
- 6304 strings out of 94500
- 79435 string characters out of 1176767
- 141408 words of memory out of 1000000
- 9299 multiletter control sequences out of 10000+50000
- 55746 words of font info for 63 fonts, out of 500000 for 2000
+ 6427 strings out of 94500
+ 81642 string characters out of 1176766
+ 145035 words of memory out of 1000000
+ 9363 multiletter control sequences out of 10000+50000
+ 68581 words of font info for 82 fonts, out of 500000 for 2000
581 hyphenation exceptions out of 1000
- 34i,11n,45p,294b,379s stack positions out of 1500i,500n,5000p,200000b,5000s
+ 34i,11n,49p,370b,453s stack positions out of 1500i,500n,5000p,200000b,5000s
PDF statistics:
- 131 PDF objects out of 300000
- 23 named destinations out of 131072
- 73 words of extra memory for PDF output out of 65536
-{/usr/share/texmf/fonts/enc/dvips/psnfss/8r
-.enc}
-Output written on pyfact.pdf (15 pages, 92569 bytes).
+ 281 PDF objects out of 300000
+ 69 named destinations out of 131072
+ 169 words of extra memory for PDF output out of 65536
+{/usr/share/texmf/fonts/enc/dvips/psnfss/8r.enc}
+Output written on pyfact.pdf (21 pages, 154318 bytes).
Index: fact/tools/pyscripts/doc/_build/latex/pyfact.out
===================================================================
--- fact/tools/pyscripts/doc/_build/latex/pyfact.out (revision 13323)
+++ fact/tools/pyscripts/doc/_build/latex/pyfact.out (revision 13324)
@@ -1,7 +1,19 @@
\BOOKMARK [0][-]{chapter.1}{Introduction}{}
-\BOOKMARK [0][-]{chapter.2}{Classes}{}
-\BOOKMARK [1][-]{section.2.1}{pyfact.py}{chapter.2}
-\BOOKMARK [0][-]{chapter.3}{Examples}{}
-\BOOKMARK [1][-]{section.3.1}{calling a system command}{chapter.3}
-\BOOKMARK [0][-]{chapter.4}{phyton in FACT}{}
-\BOOKMARK [0][-]{chapter.5}{Indices and tables}{}
+\BOOKMARK [1][-]{section.1.1}{Python version and modules used}{chapter.1}
+\BOOKMARK [1][-]{section.1.2}{Style guide and coding conventions}{chapter.1}
+\BOOKMARK [0][-]{chapter.2}{Getting Started}{}
+\BOOKMARK [1][-]{section.2.1}{1. Important links}{chapter.2}
+\BOOKMARK [1][-]{section.2.2}{2. Environment variables}{chapter.2}
+\BOOKMARK [1][-]{section.2.3}{3. Check out the repository}{chapter.2}
+\BOOKMARK [1][-]{section.2.4}{4. Create pyfits\137h.so library}{chapter.2}
+\BOOKMARK [1][-]{section.2.5}{5. Run examples}{chapter.2}
+\BOOKMARK [0][-]{chapter.3}{Classes}{}
+\BOOKMARK [1][-]{section.3.1}{pyfact.py}{chapter.3}
+\BOOKMARK [0][-]{chapter.4}{Classes}{}
+\BOOKMARK [1][-]{section.4.1}{pyfact.py}{chapter.4}
+\BOOKMARK [1][-]{section.4.2}{FIR filter functions}{chapter.4}
+\BOOKMARK [0][-]{chapter.5}{Examples}{}
+\BOOKMARK [1][-]{section.5.1}{calling a system command}{chapter.5}
+\BOOKMARK [0][-]{chapter.6}{phyton in FACT}{}
+\BOOKMARK [0][-]{chapter.7}{Indices and tables}{}
+\BOOKMARK [0][-]{section*.24}{Index}{}
Index: fact/tools/pyscripts/doc/_build/latex/pyfact.tex
===================================================================
--- fact/tools/pyscripts/doc/_build/latex/pyfact.tex (revision 13323)
+++ fact/tools/pyscripts/doc/_build/latex/pyfact.tex (revision 13324)
@@ -13,5 +13,5 @@
\title{pyfact Documentation}
-\date{February 09, 2012}
+\date{April 05, 2012}
\release{0.1}
\author{Werner Lustermann}
@@ -135,4 +135,349 @@
\end{itemize}
+If you are new to python you need to learn the basics. In any case it would be wise to study the following book:
+
+\emph{A Primer on Scientific Programming with Python - Hans Petter Langtangen}
+
+pyfact is supposed to follow closely the programming style thought in this book.
+
+\href{http://docs.python.org/}{python documentation pages}
+
+\href{http://www.astropython.org/resources}{astropython.org}
+
+
+\section{Python version and modules used}
+\label{introduction:python-version-and-modules-used}
+As long as you work on the ISDC FACT cluster most things should be just fine.
+{\color{red}\bfseries{}\textbar{}}python version: 2.6.6
+{\color{red}\bfseries{}\textbar{}}--- add later: list of modules
+
+
+\section{Style guide and coding conventions}
+\label{introduction:style-guide-and-coding-conventions}
+The code of pyfact follows the {\color{red}\bfseries{}{}`}Style Guide for python code \textless{}\href{http://www.python.org/dev/peps/pep-0008/}{http://www.python.org/dev/peps/pep-0008/}\textgreater{}.
+
+
+\chapter{Getting Started}
+\label{getting_started:getting-started}\label{getting_started::doc}\begin{enumerate}
+\item {}
+Get an account at the FACT data center at ISDC
+
+\item {}
+Setup your environment variables
+
+\item {}
+Checkout the pyfact software repository
+
+\item {}
+Try a few examples
+
+\end{enumerate}
+
+
+\section{1. Important links}
+\label{getting_started:important-links}\begin{description}
+\item[{\textbf{FACT data center at ISDC} \textless{}\href{http://www.isdc.unige.ch/fact/datacenter}{http://www.isdc.unige.ch/fact/datacenter}\textgreater{}**}] \leavevmode
+here you find instructions how to get an account, how to set it up and how to use it
+
+\item[{\textbf{SVN repository} \textless{}\href{https://fact.isdc.unige.ch/svn/fact/}{https://fact.isdc.unige.ch/svn/fact/}\textgreater{}}] \leavevmode
+hosts all FACT software (including pyfact)
+
+\item[{\textbf{FACT run database} \textless{}\href{https://www.fact-project.org/run\_db/db/fact\_runinfo.php}{https://www.fact-project.org/run\_db/db/fact\_runinfo.php}\textgreater{}}] \leavevmode
+here you find information about all available runs
+
+\item[{\textbf{eLogbook} \textless{}\href{https://www.fact-project.org/logbook/}{https://www.fact-project.org/logbook/}\textgreater{}}] \leavevmode
+telescope logbook used since Dec. 1, 2012; for logbook information before this date have a look here: \textless{}\href{http://fact.ethz.ch/FACTelog/index.jsp}{http://fact.ethz.ch/FACTelog/index.jsp}\textgreater{}
+
+\item[{\textbf{FACT La Palma pages} \textless{}\href{https://www.fact-project.org/}{https://www.fact-project.org/}\textgreater{}}] \leavevmode
+plenty of information concerning the telescope in La Palma
+
+\end{description}
+
+
+\section{2. Environment variables}
+\label{getting_started:environment-variables}
+set the following env variables depending on the SHELL you are using, for instance in .bashrc or .tcshrc
+\begin{itemize}
+\item {}
+\textbf{ROOTSYS}: /swdev\_nfs/root\_v5.28.00
+
+\item {}
+\textbf{PATH}: add \$ROOTSYS/bin
+
+\item {}
+\textbf{PATH}: add /swdev\_nfs/FACT++
+
+\item {}
+\textbf{LD\_LIBRARY\_PATH}: \$ROOTSYS/lib:/swdev\_nfs/FACT++/.libs
+
+\item {}
+\textbf{PYTHONPATH}: \$ROOTSYS/lib
+
+\item {} \begin{description}
+\item[{\textbf{PYTHONPATH}: add all directories where python should search for modules. At least:}] \leavevmode\begin{itemize}
+\item {}
+pyscripts/pyfact
+
+\item {}
+pyscript/tools
+
+\item {}
+pyscripts/ecamples
+
+\end{itemize}
+
+\end{description}
+
+\end{itemize}
+
+the absolute path depends on where you have checked (or will check) out the pyscripts repository
+
+
+\section{3. Check out the repository}
+\label{getting_started:check-out-the-repository}
+svn co \href{https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/}{https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/}
+
+
+\section{4. Create pyfits\_h.so library}
+\label{getting_started:create-pyfits-h-so-library}
+FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the existing tools:
+
+\emph{pyfits \textless{}http://www.stsci.edu/institute/software\_hardware/pyfits\textgreater{}} which uses \href{http://heasarc.gsfc.nasa.gov/fitsio/}{cfitsio}.
+
+To mitigate this problem a C++ class defined in fits.h \footnote{
+fits.h (here named pyfits.h) is part of MARS and was written by T.Bretz, it was added to this repository for convienience
+} is used. A simple possibility to create an interface of this C++ class is to use ROOT and later to import it using the
+\href{http://root.cern.ch/drupal/category/package-context/pyroot}{pyroot} module.
+
+got to the directory: pyscripts/pyfact
+
+simple:
+
+\begin{Verbatim}[commandchars=@\[\]]
+@PYGZlb[]lusterma@PYGZat[]isdc-cn02 pyfact@PYGZrb[]@$ root
+ROOT 5.28/00 (trunk@PYGZat[]37585, Dec 14 2010, 15:20:27 on linuxx8664gcc)
+CINT/ROOT C/C++ Interpreter version 5.18.00, July 2, 2010
+Type ? for help. Commands must be C++ statements.
+Enclose multiple statements between { }.
+
+root @PYGZlb[]0@PYGZrb[] .L fits.h++
+Info in @textless[]TUnixSystem::ACLiC@textgreater[]: creating shared library /home@_nfs/isdc/lusterma/pyscripts/pyfact/./fits@_h.so
+root @PYGZlb[]1@PYGZrb[]
+\end{Verbatim}
+
+This might not work for whatenver reason then it should be done like this:
+
+\begin{Verbatim}[commandchars=@\[\]]
+@$rootcint -f my@_dict.C -c fits.h izstream.h
+@$g++ -fPIC -c -I@$ROOTSYS/include my@_dict.C -o my@_dict.o
+@$g++ -o fits@_h.so -shared my@_dict.o
+\end{Verbatim}
+
+Now you can check if the reading rawdata is working:
+
+\$ pyfact.py
+
+this should print some data from a few events
+
+
+\section{5. Run examples}
+\label{getting_started:run-examples}
+
+\chapter{Classes}
+\label{getting_started:classes}
+
+\section{pyfact.py}
+\label{getting_started:pyfact-py}
+
+\subsection{rawdata access}
+\label{getting_started:rawdata-access}\index{RawData (class in pyfact)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData}\pysiglinewithargsret{\strong{class }\code{pyfact.}\bfcode{RawData}}{\emph{data\_file\_name}, \emph{calib\_file\_name}, \emph{user\_action\_calib=\textless{}function \textless{}lambda\textgreater{} at 0xab028b4\textgreater{}}, \emph{baseline\_file\_name='`}, \emph{return\_dict=None}}{}
+raw data access and calibration
+\begin{itemize}
+\item {}
+open raw data file and drs calibration file
+
+\item {}
+performs amplitude calibration
+
+\item {}
+performs baseline substraction if wanted
+
+\item {}
+provides all data in an array:
+row = number of pixel
+col = length of region of interest
+
+\end{itemize}
+
+initialize object
+
+open data file and calibration data file
+get basic information about the data in data\_file\_name
+allocate buffers for data access
+
+data\_file\_name : fits or fits.gz file of the data including the path
+calib\_file\_name : fits or fits.gz file containing DRS calibration data
+baseline\_file\_name : npy file containing the baseline values
+\index{baseline\_correct() (pyfact.RawData method)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.baseline_correct}\pysiglinewithargsret{\bfcode{baseline\_correct}}{}{}
+subtract baseline from the data
+
+\end{fulllineitems}
+
+\index{baseline\_read\_values() (pyfact.RawData method)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.baseline_read_values}\pysiglinewithargsret{\bfcode{baseline\_read\_values}}{\emph{file}, \emph{bsl\_hist='bsl\_sum/hplt\_mean'}}{}
+open ROOT file with baseline histogram and read baseline values
+file name of the root file
+bsl\_hist path to the histogram containing the basline values
+
+\end{fulllineitems}
+
+\index{board\_times (pyfact.RawData attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.board_times}\pysigline{\bfcode{board\_times}}{}
+time when the FAD was triggered, in some strange units...
+
+\end{fulllineitems}
+
+\index{calib\_file (pyfact.RawData attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.calib_file}\pysigline{\bfcode{calib\_file}}{}
+drs calibration file
+
+\end{fulllineitems}
+
+\index{calibrate\_drs\_amplitude() (pyfact.RawData method)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.calibrate_drs_amplitude}\pysiglinewithargsret{\bfcode{calibrate\_drs\_amplitude}}{}{}
+perform the drs amplitude calibration of the event data
+
+\end{fulllineitems}
+
+\index{data (pyfact.RawData attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.data}\pysigline{\bfcode{data}}{}
+1D array with raw data
+
+\end{fulllineitems}
+
+\index{data\_file (pyfact.RawData attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.data_file}\pysigline{\bfcode{data\_file}}{}
+data file (fits object)
+
+\end{fulllineitems}
+
+\index{info() (pyfact.RawData method)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.info}\pysiglinewithargsret{\bfcode{info}}{}{}
+print run information
+
+\end{fulllineitems}
+
+\index{nevents (pyfact.RawData attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.nevents}\pysigline{\bfcode{nevents}}{}
+number of events in the data run
+
+\end{fulllineitems}
+
+\index{next() (pyfact.RawData method)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.next}\pysiglinewithargsret{\bfcode{next}}{}{}
+used by \_\_iter\_\_
+
+\end{fulllineitems}
+
+\index{next\_event() (pyfact.RawData method)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.next_event}\pysiglinewithargsret{\bfcode{next\_event}}{}{}
+load the next event from disk and calibrate it
+
+\end{fulllineitems}
+
+\index{npix (pyfact.RawData attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.npix}\pysigline{\bfcode{npix}}{}
+number of pixels (should be 1440)
+
+\end{fulllineitems}
+
+\index{nroi (pyfact.RawData attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.nroi}\pysigline{\bfcode{nroi}}{}
+region of interest (number of DRS slices read)
+
+\end{fulllineitems}
+
+\index{start\_cells (pyfact.RawData attribute)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.RawData.start_cells}\pysigline{\bfcode{start\_cells}}{}
+slice where drs readout started
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\subsection{fnames of a data run}
+\label{getting_started:fnames-of-a-data-run}\index{fnames (class in pyfact)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.fnames}\pysiglinewithargsret{\strong{class }\code{pyfact.}\bfcode{fnames}}{\emph{specifier={[}`012', `023', `2011', `11', `24'{]}, rpath='/scratch\_nfs/res/bsl/', zipped=True}}{}
+organize file names of a FACT data run
+\begin{description}
+\item[{specifier}] \leavevmode{[}list of strings defined as:{]}
+{[} `DRS calibration file', `Data file', `YYYY', `MM', `DD'{]}
+
+\end{description}
+
+rpath : directory path for the results; YYYYMMDD will be appended to rpath
+zipped : use zipped (True) or unzipped (Data)
+\index{info() (pyfact.fnames method)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.fnames.info}\pysiglinewithargsret{\bfcode{info}}{}{}
+print complete filenames
+
+\end{fulllineitems}
+
+\index{make() (pyfact.fnames method)}
+
+\begin{fulllineitems}
+\phantomsection\label{getting_started:pyfact.fnames.make}\pysiglinewithargsret{\bfcode{make}}{\emph{specifier}, \emph{rpath}, \emph{zipped}}{}
+create (make) the filenames
+
+names : dictionary of filenames, tags \{ `data', `drscal', `results' \}
+data : name of the data file
+drscal : name of the drs calibration file
+results : radikal of file name(s) for results (to be completed by suffixes)
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
\chapter{Classes}
@@ -146,5 +491,45 @@
\subsection{fnames of a data run}
-\label{classes:fnames-of-a-data-run}
+\label{classes:fnames-of-a-data-run}\index{fnames (class in pyfact)}
+
+\begin{fulllineitems}
+\phantomsection\label{classes:pyfact.fnames}\pysiglinewithargsret{\strong{class }\code{pyfact.}\bfcode{fnames}}{\emph{specifier={[}`012', `023', `2011', `11', `24'{]}, rpath='/scratch\_nfs/res/bsl/', zipped=True}}{}
+organize file names of a FACT data run
+\begin{description}
+\item[{specifier}] \leavevmode{[}list of strings defined as:{]}
+{[} `DRS calibration file', `Data file', `YYYY', `MM', `DD'{]}
+
+\end{description}
+
+rpath : directory path for the results; YYYYMMDD will be appended to rpath
+zipped : use zipped (True) or unzipped (Data)
+\index{info() (pyfact.fnames method)}
+
+\begin{fulllineitems}
+\phantomsection\label{classes:pyfact.fnames.info}\pysiglinewithargsret{\bfcode{info}}{}{}
+print complete filenames
+
+\end{fulllineitems}
+
+\index{make() (pyfact.fnames method)}
+
+\begin{fulllineitems}
+\phantomsection\label{classes:pyfact.fnames.make}\pysiglinewithargsret{\bfcode{make}}{\emph{specifier}, \emph{rpath}, \emph{zipped}}{}
+create (make) the filenames
+
+names : dictionary of filenames, tags \{ `data', `drscal', `results' \}
+data : name of the data file
+drscal : name of the drs calibration file
+results : radikal of file name(s) for results (to be completed by suffixes)
+
+\end{fulllineitems}
+
+
+\end{fulllineitems}
+
+
+
+\section{FIR filter functions}
+\label{classes:fir-filter-functions}
\chapter{Examples}
Index: fact/tools/pyscripts/doc/_build/latex/pyfact.toc
===================================================================
--- fact/tools/pyscripts/doc/_build/latex/pyfact.toc (revision 13323)
+++ fact/tools/pyscripts/doc/_build/latex/pyfact.toc (revision 13324)
@@ -1,10 +1,24 @@
\select@language {english}
\contentsline {chapter}{\numberline {1}Introduction}{3}{chapter.1}
-\contentsline {chapter}{\numberline {2}Classes}{5}{chapter.2}
-\contentsline {section}{\numberline {2.1}pyfact.py}{5}{section.2.1}
-\contentsline {subsection}{\numberline {2.1.1}rawdata access}{5}{subsection.2.1.1}
-\contentsline {subsection}{\numberline {2.1.2}fnames of a data run}{5}{subsection.2.1.2}
-\contentsline {chapter}{\numberline {3}Examples}{7}{chapter.3}
-\contentsline {section}{\numberline {3.1}calling a system command}{7}{section.3.1}
-\contentsline {chapter}{\numberline {4}phyton in FACT}{9}{chapter.4}
-\contentsline {chapter}{\numberline {5}Indices and tables}{11}{chapter.5}
+\contentsline {section}{\numberline {1.1}Python version and modules used}{3}{section.1.1}
+\contentsline {section}{\numberline {1.2}Style guide and coding conventions}{3}{section.1.2}
+\contentsline {chapter}{\numberline {2}Getting Started}{5}{chapter.2}
+\contentsline {section}{\numberline {2.1}1. Important links}{5}{section.2.1}
+\contentsline {section}{\numberline {2.2}2. Environment variables}{5}{section.2.2}
+\contentsline {section}{\numberline {2.3}3. Check out the repository}{6}{section.2.3}
+\contentsline {section}{\numberline {2.4}4. Create pyfits\_h.so library}{6}{section.2.4}
+\contentsline {section}{\numberline {2.5}5. Run examples}{6}{section.2.5}
+\contentsline {chapter}{\numberline {3}Classes}{7}{chapter.3}
+\contentsline {section}{\numberline {3.1}pyfact.py}{7}{section.3.1}
+\contentsline {subsection}{\numberline {3.1.1}rawdata access}{7}{subsection.3.1.1}
+\contentsline {subsection}{\numberline {3.1.2}fnames of a data run}{8}{subsection.3.1.2}
+\contentsline {chapter}{\numberline {4}Classes}{9}{chapter.4}
+\contentsline {section}{\numberline {4.1}pyfact.py}{9}{section.4.1}
+\contentsline {subsection}{\numberline {4.1.1}rawdata access}{9}{subsection.4.1.1}
+\contentsline {subsection}{\numberline {4.1.2}fnames of a data run}{9}{subsection.4.1.2}
+\contentsline {section}{\numberline {4.2}FIR filter functions}{9}{section.4.2}
+\contentsline {chapter}{\numberline {5}Examples}{11}{chapter.5}
+\contentsline {section}{\numberline {5.1}calling a system command}{11}{section.5.1}
+\contentsline {chapter}{\numberline {6}phyton in FACT}{13}{chapter.6}
+\contentsline {chapter}{\numberline {7}Indices and tables}{15}{chapter.7}
+\contentsline {chapter}{Index}{17}{section*.24}
Index: fact/tools/pyscripts/doc/getting_started.rst
===================================================================
--- fact/tools/pyscripts/doc/getting_started.rst (revision 13323)
+++ fact/tools/pyscripts/doc/getting_started.rst (revision 13324)
@@ -39,5 +39,4 @@
* pyscript/tools
* pyscripts/ecamples
- * py
the absolute path depends on where you have checked (or will check) out the pyscripts repository
@@ -47,26 +46,38 @@
svn co https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/
-4. Create pyfits library
+4. Create pyfits_h.so library
========================
-FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the default tool:
+FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the existing tools:
-`pyfits
`.
+`pyfits ` which uses `cfitsio `_.
-To mitigate this problem a C++ class defined in `fits.h` is used. A simple possibility to create an interface of this C++ class and python is to use the
+To mitigate this problem a C++ class defined in fits.h [#f1]_ is used. A simple possibility to create an interface of this C++ class is to use ROOT and later to import it using the
+`pyroot `_ module.
-`pyroot http://root.cern.ch/drupal/category/package-context/pyroot>` module.
+got to the directory: pyscripts/pyfact
simple::
- [pceth118] /home/luster/py > root
- ROOT 5.28/00h (branches/v5-28-00-patches@42209, Feb 13 2012, 23:52:00 on linux)
+ [lusterma@isdc-cn02 pyfact]$ root
+ ROOT 5.28/00 (trunk@37585, Dec 14 2010, 15:20:27 on linuxx8664gcc)
CINT/ROOT C/C++ Interpreter version 5.18.00, July 2, 2010
Type ? for help. Commands must be C++ statements.
Enclose multiple statements between { }.
+
root [0] .L fits.h++
- Info in : creating shared library /home/luster/py/./fits_h.so
+ Info in : creating shared library /home_nfs/isdc/lusterma/pyscripts/pyfact/./fits_h.so
root [1]
+This might not work for whatenver reason then it should be done like this::
+ $rootcint -f my_dict.C -c fits.h izstream.h
+ $g++ -fPIC -c -I$ROOTSYS/include my_dict.C -o my_dict.o
+ $g++ -o fits_h.so -shared my_dict.o
+
+Now you can check if the reading rawdata is working:
+
+$ ./pyfact.py
+
+this should print some data from a few events
5. Run examples
@@ -93,2 +104,4 @@
+.. rubric:: Footnotes
+.. [#f1] fits.h (here named pyfits.h) is part of MARS and was written by T.Bretz, it was added to this repository for convienience