Ignore:
Timestamp:
04/05/12 17:32:54 (13 years ago)
Author:
lusterma
Message:
updated
Location:
fact/tools/pyscripts/doc/_build
Files:
17 edited

Legend:

Unmodified
Added
Removed

  • fact/tools/pyscripts/doc/_build/html/_sources/getting_started.txt

    r13316 r13324  
    3939    * pyscript/tools
    4040    * pyscripts/ecamples
    41     * py
    4241
    4342the absolute path depends on where you have checked (or will check) out the pyscripts repository
    … …  
    4746svn co https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/
    4847
    49 4. Create pyfits library
     484. Create pyfits_h.so library
    5049========================
    51 FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the default tool:
     50FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the existing tools:
    5251
    53 `pyfits <http://www.stsci.edu/institute/software_hardware/pyfits>`.
     52`pyfits <http://www.stsci.edu/institute/software_hardware/pyfits>` which uses `cfitsio <http://heasarc.gsfc.nasa.gov/fitsio/>`_.
    5453
    55 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
     54To 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
     55`pyroot <http://root.cern.ch/drupal/category/package-context/pyroot>`_ module.
    5656
    57 `pyroot http://root.cern.ch/drupal/category/package-context/pyroot>` module.
     57got to the directory: pyscripts/pyfact
    5858
    5959simple::
    6060
    61   [pceth118] /home/luster/py > root
    62   ROOT 5.28/00h (branches/v5-28-00-patches@42209, Feb 13 2012, 23:52:00 on linux)
     61  [lusterma@isdc-cn02 pyfact]$ root
     62  ROOT 5.28/00 (trunk@37585, Dec 14 2010, 15:20:27 on linuxx8664gcc)
    6363  CINT/ROOT C/C++ Interpreter version 5.18.00, July 2, 2010
    6464  Type ? for help. Commands must be C++ statements.
    6565  Enclose multiple statements between { }.
     66
    6667  root [0] .L fits.h++
    67   Info in <TUnixSystem::ACLiC>: creating shared library /home/luster/py/./fits_h.so
     68  Info in <TUnixSystem::ACLiC>: creating shared library /home_nfs/isdc/lusterma/pyscripts/pyfact/./fits_h.so
    6869  root [1]
    6970
     71This might not work for whatenver reason then it should be done like this::
    7072
     73  $rootcint -f my_dict.C -c fits.h izstream.h
     74  $g++ -fPIC -c -I$ROOTSYS/include my_dict.C -o my_dict.o
     75  $g++ -o fits_h.so -shared my_dict.o
     76
     77Now you can check if the reading rawdata is working:
     78
     79$ pyfact.py
     80
     81this should print some data from a few events
    7182
    72835. Run examples
    … …  
    93104
    94105
     106.. rubric:: Footnotes
     107.. [#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

  • fact/tools/pyscripts/doc/_build/html/classes.html

    r13316 r13324  
    2525    <link rel="top" title="pyfact v0.1 documentation" href="index.html" />
    2626    <link rel="next" title="Examples" href="examples.html" />
    27     <link rel="prev" title="Introduction" href="introduction.html" />
     27    <link rel="prev" title="Getting Started" href="getting_started.html" />
    2828  </head>
    2929  <body>
    … …  
    3838             accesskey="N">next</a> |</li>
    3939        <li class="right" >
    40           <a href="introduction.html" title="Introduction"
     40          <a href="getting_started.html" title="Getting Started"
    4141             accesskey="P">previous</a> |</li>
    4242        <li><a href="index.html">pyfact v0.1 documentation</a> &raquo;</li>
    … …  
    113113
    114114  <h4>Previous topic</h4>
    115   <p class="topless"><a href="introduction.html"
    116                         title="previous chapter">Introduction</a></p>
     115  <p class="topless"><a href="getting_started.html"
     116                        title="previous chapter">Getting Started</a></p>
    117117  <h4>Next topic</h4>
    118118  <p class="topless"><a href="examples.html"
    … …  
    150150             >next</a> |</li>
    151151        <li class="right" >
    152           <a href="introduction.html" title="Introduction"
     152          <a href="getting_started.html" title="Getting Started"
    153153             >previous</a> |</li>
    154154        <li><a href="index.html">pyfact v0.1 documentation</a> &raquo;</li>

  • fact/tools/pyscripts/doc/_build/html/getting_started.html

    r13316 r13324  
    9292<li>pyscript/tools</li>
    9393<li>pyscripts/ecamples</li>
    94 <li>py</li>
    9594</ul>
    9695</dd>
    … …  
    104103<p>svn co <a class="reference external" href="https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/">https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/</a></p>
    105104</div>
    106 <div class="section" id="create-pyfits-library">
    107 <h2>4. Create pyfits library<a class="headerlink" href="#create-pyfits-library" title="Permalink to this headline">¶</a></h2>
    108 <p>FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the default tool:</p>
    109 <p><cite>pyfits &lt;http://www.stsci.edu/institute/software_hardware/pyfits&gt;</cite>.</p>
    110 <p>To mitigate this problem a C++ class defined in <cite>fits.h</cite> is used. A simple possibility to create an interface of this C++ class and python is to use the</p>
    111 <p><cite>pyroot http://root.cern.ch/drupal/category/package-context/pyroot&gt;</cite> module.</p>
     105<div class="section" id="create-pyfits-h-so-library">
     106<h2>4. Create pyfits_h.so library<a class="headerlink" href="#create-pyfits-h-so-library" title="Permalink to this headline">¶</a></h2>
     107<p>FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the existing tools:</p>
     108<p><cite>pyfits &lt;http://www.stsci.edu/institute/software_hardware/pyfits&gt;</cite> which uses <a class="reference external" href="http://heasarc.gsfc.nasa.gov/fitsio/">cfitsio</a>.</p>
     109<p>To mitigate this problem a C++ class defined in fits.h <a class="footnote-reference" href="#f1" id="id1">[1]</a> is used. A simple possibility to create an interface of this C++ class is to use ROOT and later to import it using the
     110<a class="reference external" href="http://root.cern.ch/drupal/category/package-context/pyroot">pyroot</a> module.</p>
     111<p>got to the directory: pyscripts/pyfact</p>
    112112<p>simple:</p>
    113 <div class="highlight-python"><pre>[pceth118] /home/luster/py &gt; root
    114 ROOT 5.28/00h (branches/v5-28-00-patches@42209, Feb 13 2012, 23:52:00 on linux)
     113<div class="highlight-python"><pre>[lusterma@isdc-cn02 pyfact]$ root
     114ROOT 5.28/00 (trunk@37585, Dec 14 2010, 15:20:27 on linuxx8664gcc)
    115115CINT/ROOT C/C++ Interpreter version 5.18.00, July 2, 2010
    116116Type ? for help. Commands must be C++ statements.
    117117Enclose multiple statements between { }.
     118
    118119root [0] .L fits.h++
    119 Info in &lt;TUnixSystem::ACLiC&gt;: creating shared library /home/luster/py/./fits_h.so
     120Info in &lt;TUnixSystem::ACLiC&gt;: creating shared library /home_nfs/isdc/lusterma/pyscripts/pyfact/./fits_h.so
    120121root [1]</pre>
    121122</div>
     123<p>This might not work for whatenver reason then it should be done like this:</p>
     124<div class="highlight-python"><pre>$rootcint -f my_dict.C -c fits.h izstream.h
     125$g++ -fPIC -c -I$ROOTSYS/include my_dict.C -o my_dict.o
     126$g++ -o fits_h.so -shared my_dict.o</pre>
     127</div>
     128<p>Now you can check if the reading rawdata is working:</p>
     129<p>$ pyfact.py</p>
     130<p>this should print some data from a few events</p>
    122131</div>
    123132<div class="section" id="run-examples">
    … …  
    133142<dl class="class">
    134143<dt id="pyfact.RawData">
    135 <em class="property">class </em><tt class="descclassname">pyfact.</tt><tt class="descname">RawData</tt><big>(</big><em>data_file_name</em>, <em>calib_file_name</em>, <em>user_action_calib=&lt;function &lt;lambda&gt; at 0xa818844&gt;</em>, <em>baseline_file_name=''</em>, <em>return_dict=None</em><big>)</big><a class="headerlink" href="#pyfact.RawData" title="Permalink to this definition">¶</a></dt>
     144<em class="property">class </em><tt class="descclassname">pyfact.</tt><tt class="descname">RawData</tt><big>(</big><em>data_file_name</em>, <em>calib_file_name</em>, <em>user_action_calib=&lt;function &lt;lambda&gt; at 0xab028b4&gt;</em>, <em>baseline_file_name=''</em>, <em>return_dict=None</em><big>)</big><a class="headerlink" href="#pyfact.RawData" title="Permalink to this definition">¶</a></dt>
    136145<dd><p>raw data access and calibration</p>
    137146<ul class="simple">
    … …  
    269278</dd></dl>
    270279
     280<p class="rubric">Footnotes</p>
     281<table class="docutils footnote" frame="void" id="f1" rules="none">
     282<colgroup><col class="label" /><col /></colgroup>
     283<tbody valign="top">
     284<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>fits.h (here named pyfits.h) is part of MARS and was written by T.Bretz, it was added to this repository for convienience</td></tr>
     285</tbody>
     286</table>
    271287</div>
    272288</div>
    … …  
    285301<li><a class="reference internal" href="#environment-variables">2. Environment variables</a></li>
    286302<li><a class="reference internal" href="#check-out-the-repository">3. Check out the repository</a></li>
    287 <li><a class="reference internal" href="#create-pyfits-library">4. Create pyfits library</a></li>
     303<li><a class="reference internal" href="#create-pyfits-h-so-library">4. Create pyfits_h.so library</a></li>
    288304<li><a class="reference internal" href="#run-examples">5. Run examples</a></li>
    289305</ul>

  • fact/tools/pyscripts/doc/_build/html/index.html

    r13316 r13324  
    5959<li class="toctree-l2"><a class="reference internal" href="getting_started.html#environment-variables">2. Environment variables</a></li>
    6060<li class="toctree-l2"><a class="reference internal" href="getting_started.html#check-out-the-repository">3. Check out the repository</a></li>
    61 <li class="toctree-l2"><a class="reference internal" href="getting_started.html#create-pyfits-library">4. Create pyfits library</a></li>
     61<li class="toctree-l2"><a class="reference internal" href="getting_started.html#create-pyfits-h-so-library">4. Create pyfits_h.so library</a></li>
    6262<li class="toctree-l2"><a class="reference internal" href="getting_started.html#run-examples">5. Run examples</a></li>
    6363</ul>

  • fact/tools/pyscripts/doc/_build/html/searchindex.js

    r13316 r13324  
    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&#8217;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"]})
     1Search.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&#8217;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"]})

  • fact/tools/pyscripts/doc/_build/latex/pyfact.aux

    r13151 r13324  
    2323\newlabel{introduction:introduction}{{1}{3}{Introduction\relax }{chapter.1}{}}
    2424\newlabel{introduction::doc}{{1}{3}{Introduction\relax }{chapter.1}{}}
    25 \@writefile{toc}{\contentsline {chapter}{\numberline {2}Classes}{5}{chapter.2}}
     25\@writefile{toc}{\contentsline {section}{\numberline {1.1}Python version and modules used}{3}{section.1.1}}
     26\newlabel{introduction:python-version-and-modules-used}{{1.1}{3}{Python version and modules used\relax }{section.1.1}{}}
     27\@writefile{toc}{\contentsline {section}{\numberline {1.2}Style guide and coding conventions}{3}{section.1.2}}
     28\newlabel{introduction:style-guide-and-coding-conventions}{{1.2}{3}{Style guide and coding conventions\relax }{section.1.2}{}}
     29\@writefile{toc}{\contentsline {chapter}{\numberline {2}Getting Started}{5}{chapter.2}}
    2630\@writefile{lof}{\addvspace {10\p@ }}
    2731\@writefile{lot}{\addvspace {10\p@ }}
    28 \newlabel{classes:classes}{{2}{5}{Classes\relax }{chapter.2}{}}
    29 \newlabel{classes::doc}{{2}{5}{Classes\relax }{chapter.2}{}}
    30 \@writefile{toc}{\contentsline {section}{\numberline {2.1}pyfact.py}{5}{section.2.1}}
    31 \newlabel{classes:pyfact-py}{{2.1}{5}{pyfact.py\relax }{section.2.1}{}}
    32 \@writefile{toc}{\contentsline {subsection}{\numberline {2.1.1}rawdata access}{5}{subsection.2.1.1}}
    33 \newlabel{classes:rawdata-access}{{2.1.1}{5}{rawdata access\relax }{subsection.2.1.1}{}}
    34 \@writefile{toc}{\contentsline {subsection}{\numberline {2.1.2}fnames of a data run}{5}{subsection.2.1.2}}
    35 \newlabel{classes:fnames-of-a-data-run}{{2.1.2}{5}{fnames of a data run\relax }{subsection.2.1.2}{}}
    36 \@writefile{toc}{\contentsline {chapter}{\numberline {3}Examples}{7}{chapter.3}}
     32\newlabel{getting_started:getting-started}{{2}{5}{Getting Started\relax }{chapter.2}{}}
     33\newlabel{getting_started::doc}{{2}{5}{Getting Started\relax }{chapter.2}{}}
     34\@writefile{toc}{\contentsline {section}{\numberline {2.1}1. Important links}{5}{section.2.1}}
     35\newlabel{getting_started:important-links}{{2.1}{5}{1. Important links\relax }{section.2.1}{}}
     36\@writefile{toc}{\contentsline {section}{\numberline {2.2}2. Environment variables}{5}{section.2.2}}
     37\newlabel{getting_started:environment-variables}{{2.2}{5}{2. Environment variables\relax }{section.2.2}{}}
     38\@writefile{toc}{\contentsline {section}{\numberline {2.3}3. Check out the repository}{6}{section.2.3}}
     39\newlabel{getting_started:check-out-the-repository}{{2.3}{6}{3. Check out the repository\relax }{section.2.3}{}}
     40\@writefile{toc}{\contentsline {section}{\numberline {2.4}4. Create pyfits\_h.so library}{6}{section.2.4}}
     41\newlabel{getting_started:create-pyfits-h-so-library}{{2.4}{6}{4. Create pyfits\_h.so library\relax }{section.2.4}{}}
     42\@writefile{toc}{\contentsline {section}{\numberline {2.5}5. Run examples}{6}{section.2.5}}
     43\newlabel{getting_started:run-examples}{{2.5}{6}{5. Run examples\relax }{section.2.5}{}}
     44\@writefile{toc}{\contentsline {chapter}{\numberline {3}Classes}{7}{chapter.3}}
    3745\@writefile{lof}{\addvspace {10\p@ }}
    3846\@writefile{lot}{\addvspace {10\p@ }}
    39 \newlabel{examples::doc}{{3}{7}{Examples\relax }{chapter.3}{}}
    40 \newlabel{examples:examples}{{3}{7}{Examples\relax }{chapter.3}{}}
    41 \@writefile{toc}{\contentsline {section}{\numberline {3.1}calling a system command}{7}{section.3.1}}
    42 \newlabel{examples:calling-a-system-command}{{3.1}{7}{calling a system command\relax }{section.3.1}{}}
    43 \@writefile{toc}{\contentsline {chapter}{\numberline {4}phyton in FACT}{9}{chapter.4}}
     47\newlabel{getting_started:classes}{{3}{7}{Classes\relax }{chapter.3}{}}
     48\@writefile{toc}{\contentsline {section}{\numberline {3.1}pyfact.py}{7}{section.3.1}}
     49\newlabel{getting_started:pyfact-py}{{3.1}{7}{pyfact.py\relax }{section.3.1}{}}
     50\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.1}rawdata access}{7}{subsection.3.1.1}}
     51\newlabel{getting_started:rawdata-access}{{3.1.1}{7}{rawdata access\relax }{subsection.3.1.1}{}}
     52\newlabel{getting_started:pyfact.RawData}{{3.1.1}{7}{rawdata access\relax }{section*.3}{}}
     53\newlabel{getting_started:pyfact.RawData.baseline_correct}{{3.1.1}{7}{rawdata access\relax }{section*.4}{}}
     54\newlabel{getting_started:pyfact.RawData.baseline_read_values}{{3.1.1}{7}{rawdata access\relax }{section*.5}{}}
     55\newlabel{getting_started:pyfact.RawData.board_times}{{3.1.1}{7}{rawdata access\relax }{section*.6}{}}
     56\newlabel{getting_started:pyfact.RawData.calib_file}{{3.1.1}{7}{rawdata access\relax }{section*.7}{}}
     57\newlabel{getting_started:pyfact.RawData.calibrate_drs_amplitude}{{3.1.1}{7}{rawdata access\relax }{section*.8}{}}
     58\newlabel{getting_started:pyfact.RawData.data}{{3.1.1}{7}{rawdata access\relax }{section*.9}{}}
     59\newlabel{getting_started:pyfact.RawData.data_file}{{3.1.1}{7}{rawdata access\relax }{section*.10}{}}
     60\newlabel{getting_started:pyfact.RawData.info}{{3.1.1}{7}{rawdata access\relax }{section*.11}{}}
     61\newlabel{getting_started:pyfact.RawData.nevents}{{3.1.1}{8}{rawdata access\relax }{section*.12}{}}
     62\newlabel{getting_started:pyfact.RawData.next}{{3.1.1}{8}{rawdata access\relax }{section*.13}{}}
     63\newlabel{getting_started:pyfact.RawData.next_event}{{3.1.1}{8}{rawdata access\relax }{section*.14}{}}
     64\newlabel{getting_started:pyfact.RawData.npix}{{3.1.1}{8}{rawdata access\relax }{section*.15}{}}
     65\newlabel{getting_started:pyfact.RawData.nroi}{{3.1.1}{8}{rawdata access\relax }{section*.16}{}}
     66\newlabel{getting_started:pyfact.RawData.start_cells}{{3.1.1}{8}{rawdata access\relax }{section*.17}{}}
     67\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.2}fnames of a data run}{8}{subsection.3.1.2}}
     68\newlabel{getting_started:fnames-of-a-data-run}{{3.1.2}{8}{fnames of a data run\relax }{subsection.3.1.2}{}}
     69\newlabel{getting_started:pyfact.fnames}{{3.1.2}{8}{fnames of a data run\relax }{section*.18}{}}
     70\newlabel{getting_started:pyfact.fnames.info}{{3.1.2}{8}{fnames of a data run\relax }{section*.19}{}}
     71\newlabel{getting_started:pyfact.fnames.make}{{3.1.2}{8}{fnames of a data run\relax }{section*.20}{}}
     72\@writefile{toc}{\contentsline {chapter}{\numberline {4}Classes}{9}{chapter.4}}
    4473\@writefile{lof}{\addvspace {10\p@ }}
    4574\@writefile{lot}{\addvspace {10\p@ }}
    46 \newlabel{python:phyton-in-fact}{{4}{9}{phyton in FACT\relax }{chapter.4}{}}
    47 \newlabel{python::doc}{{4}{9}{phyton in FACT\relax }{chapter.4}{}}
    48 \@writefile{toc}{\contentsline {chapter}{\numberline {5}Indices and tables}{11}{chapter.5}}
     75\newlabel{classes:classes}{{4}{9}{Classes\relax }{chapter.4}{}}
     76\newlabel{classes::doc}{{4}{9}{Classes\relax }{chapter.4}{}}
     77\@writefile{toc}{\contentsline {section}{\numberline {4.1}pyfact.py}{9}{section.4.1}}
     78\newlabel{classes:pyfact-py}{{4.1}{9}{pyfact.py\relax }{section.4.1}{}}
     79\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}rawdata access}{9}{subsection.4.1.1}}
     80\newlabel{classes:rawdata-access}{{4.1.1}{9}{rawdata access\relax }{subsection.4.1.1}{}}
     81\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.2}fnames of a data run}{9}{subsection.4.1.2}}
     82\newlabel{classes:fnames-of-a-data-run}{{4.1.2}{9}{fnames of a data run\relax }{subsection.4.1.2}{}}
     83\newlabel{classes:pyfact.fnames}{{4.1.2}{9}{fnames of a data run\relax }{section*.21}{}}
     84\newlabel{classes:pyfact.fnames.info}{{4.1.2}{9}{fnames of a data run\relax }{section*.22}{}}
     85\newlabel{classes:pyfact.fnames.make}{{4.1.2}{9}{fnames of a data run\relax }{section*.23}{}}
     86\@writefile{toc}{\contentsline {section}{\numberline {4.2}FIR filter functions}{9}{section.4.2}}
     87\newlabel{classes:fir-filter-functions}{{4.2}{9}{FIR filter functions\relax }{section.4.2}{}}
     88\@writefile{toc}{\contentsline {chapter}{\numberline {5}Examples}{11}{chapter.5}}
    4989\@writefile{lof}{\addvspace {10\p@ }}
    5090\@writefile{lot}{\addvspace {10\p@ }}
    51 \newlabel{index:indices-and-tables}{{5}{11}{Indices and tables\relax }{chapter.5}{}}
     91\newlabel{examples::doc}{{5}{11}{Examples\relax }{chapter.5}{}}
     92\newlabel{examples:examples}{{5}{11}{Examples\relax }{chapter.5}{}}
     93\@writefile{toc}{\contentsline {section}{\numberline {5.1}calling a system command}{11}{section.5.1}}
     94\newlabel{examples:calling-a-system-command}{{5.1}{11}{calling a system command\relax }{section.5.1}{}}
     95\@writefile{toc}{\contentsline {chapter}{\numberline {6}phyton in FACT}{13}{chapter.6}}
     96\@writefile{lof}{\addvspace {10\p@ }}
     97\@writefile{lot}{\addvspace {10\p@ }}
     98\newlabel{python:phyton-in-fact}{{6}{13}{phyton in FACT\relax }{chapter.6}{}}
     99\newlabel{python::doc}{{6}{13}{phyton in FACT\relax }{chapter.6}{}}
     100\@writefile{toc}{\contentsline {chapter}{\numberline {7}Indices and tables}{15}{chapter.7}}
     101\@writefile{lof}{\addvspace {10\p@ }}
     102\@writefile{lot}{\addvspace {10\p@ }}
     103\newlabel{index:indices-and-tables}{{7}{15}{Indices and tables\relax }{chapter.7}{}}
     104\@writefile{toc}{\contentsline {chapter}{Index}{17}{section*.24}}

  • fact/tools/pyscripts/doc/_build/latex/pyfact.idx

    r13151 r13324  
     1\indexentry{RawData (class in pyfact)|hyperpage}{7}
     2\indexentry{baseline\_correct() (pyfact.RawData method)|hyperpage}{7}
     3\indexentry{baseline\_read\_values() (pyfact.RawData method)|hyperpage}{7}
     4\indexentry{board\_times (pyfact.RawData attribute)|hyperpage}{7}
     5\indexentry{calib\_file (pyfact.RawData attribute)|hyperpage}{7}
     6\indexentry{calibrate\_drs\_amplitude() (pyfact.RawData method)|hyperpage}{7}
     7\indexentry{data (pyfact.RawData attribute)|hyperpage}{7}
     8\indexentry{data\_file (pyfact.RawData attribute)|hyperpage}{7}
     9\indexentry{info() (pyfact.RawData method)|hyperpage}{7}
     10\indexentry{nevents (pyfact.RawData attribute)|hyperpage}{8}
     11\indexentry{next() (pyfact.RawData method)|hyperpage}{8}
     12\indexentry{next\_event() (pyfact.RawData method)|hyperpage}{8}
     13\indexentry{npix (pyfact.RawData attribute)|hyperpage}{8}
     14\indexentry{nroi (pyfact.RawData attribute)|hyperpage}{8}
     15\indexentry{start\_cells (pyfact.RawData attribute)|hyperpage}{8}
     16\indexentry{fnames (class in pyfact)|hyperpage}{8}
     17\indexentry{info() (pyfact.fnames method)|hyperpage}{8}
     18\indexentry{make() (pyfact.fnames method)|hyperpage}{8}
     19\indexentry{fnames (class in pyfact)|hyperpage}{9}
     20\indexentry{info() (pyfact.fnames method)|hyperpage}{9}
     21\indexentry{make() (pyfact.fnames method)|hyperpage}{9}

  • fact/tools/pyscripts/doc/_build/latex/pyfact.ilg

    r13151 r13324  
    11This is makeindex, version 2.14 [02-Oct-2002] (kpathsea + Thai support).
    22Scanning style file ./python.ist......done (6 attributes redefined, 0 ignored).
    3 Scanning input file pyfact.idx...done (0 entries accepted, 0 rejected).
    4 Nothing written in pyfact.ind.
     3Scanning input file pyfact.idx....done (21 entries accepted, 0 rejected).
     4Sorting entries....done (91 comparisons).
     5Generating output file pyfact.ind....done (48 lines written, 0 warnings).
     6Output written in pyfact.ind.
    57Transcript written in pyfact.ilg.

  • fact/tools/pyscripts/doc/_build/latex/pyfact.ind

    r13151 r13324  
     1\begin{theindex}
     2\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
     3
     4  \bigletter B
     5  \item baseline\_correct() (pyfact.RawData method), \hyperpage{7}
     6  \item baseline\_read\_values() (pyfact.RawData method), \hyperpage{7}
     7  \item board\_times (pyfact.RawData attribute), \hyperpage{7}
     8
     9  \indexspace
     10  \bigletter C
     11  \item calib\_file (pyfact.RawData attribute), \hyperpage{7}
     12  \item calibrate\_drs\_amplitude() (pyfact.RawData method), \hyperpage{7}
     13
     14  \indexspace
     15  \bigletter D
     16  \item data (pyfact.RawData attribute), \hyperpage{7}
     17  \item data\_file (pyfact.RawData attribute), \hyperpage{7}
     18
     19  \indexspace
     20  \bigletter F
     21  \item fnames (class in pyfact), \hyperpage{8, 9}
     22
     23  \indexspace
     24  \bigletter I
     25  \item info() (pyfact.fnames method), \hyperpage{8, 9}
     26  \item info() (pyfact.RawData method), \hyperpage{7}
     27
     28  \indexspace
     29  \bigletter M
     30  \item make() (pyfact.fnames method), \hyperpage{8, 9}
     31
     32  \indexspace
     33  \bigletter N
     34  \item nevents (pyfact.RawData attribute), \hyperpage{8}
     35  \item next() (pyfact.RawData method), \hyperpage{8}
     36  \item next\_event() (pyfact.RawData method), \hyperpage{8}
     37  \item npix (pyfact.RawData attribute), \hyperpage{8}
     38  \item nroi (pyfact.RawData attribute), \hyperpage{8}
     39
     40  \indexspace
     41  \bigletter R
     42  \item RawData (class in pyfact), \hyperpage{7}
     43
     44  \indexspace
     45  \bigletter S
     46  \item start\_cells (pyfact.RawData attribute), \hyperpage{8}
     47
     48\end{theindex}

  • fact/tools/pyscripts/doc/_build/latex/pyfact.log

    r13151 r13324  
    1 This is pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4) (format=pdflatex 2011.2.7)  9 FEB 2012 10:54
     1This is pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4) (format=pdflatex 2012.3.14)  5 APR 2012 18:22
    22entering extended mode
    33**pyfact.tex
    … …  
    853853]
    854854Chapter 2.
     855
     856Underfull \hbox (badness 10000) in paragraph at lines 185--187
     857[]\T1/ptm/m/n/10 here you find in-for-ma-tion
     858 []
     859
     860[5]
     861LaTeX Font Info:    Try loading font information for T1+pcr on input line 256.
     862 (/usr/share/texmf/tex/latex/psnfss/t1pcr.fd
     863File: t1pcr.fd 2001/06/04 font definitions for T1/pcr.
     864) [6]
     865Chapter 3.
    855866LaTeX Font Info:    Font shape `T1/phv/bx/n' in size <12> not available
    856 (Font)              Font shape `T1/phv/b/n' tried instead on input line 144.
    857 [5] [6
     867(Font)              Font shape `T1/phv/b/n' tried instead on input line 292.
     868LaTeX Font Info:    Font shape `T1/pcr/bx/n' in size <10> not available
     869(Font)              Font shape `T1/pcr/b/n' tried instead on input line 296.
     870[7
    858871
    859872]
    860 Chapter 3.
    861 LaTeX Font Info:    Try loading font information for T1+pcr on input line 157.
    862 (/usr/share/texmf/tex/latex/psnfss/t1pcr.fd
    863 File: t1pcr.fd 2001/06/04 font definitions for T1/pcr.
    864 )
    865 LaTeX Font Info:    Font shape `T1/pcr/bx/n' in size <9> not available
    866 (Font)              Font shape `T1/pcr/b/n' tried instead on input line 158.
    867  [7] [8
    868 
    869 ]
     873Underfull \hbox (badness 10000) in paragraph at lines 447--447
     874[]\T1/ptm/m/it/10 specifier=[`012', `023', `2011', `11', `24'], rpath='/scratch
     875_nfs/res/bsl/',
     876 []
     877
     878[8]
    870879Chapter 4.
    871 [9] [10
     880
     881Underfull \hbox (badness 10000) in paragraph at lines 496--496
     882[]\T1/ptm/m/it/10 specifier=[`012', `023', `2011', `11', `24'], rpath='/scratch
     883_nfs/res/bsl/',
     884 []
     885
     886[9
     887
     888] [10
    872889
    873890]
    874891Chapter 5.
    875 (./pyfact.ind) [11] (./pyfact.aux) )
     892LaTeX Font Info:    Font shape `T1/pcr/bx/n' in size <9> not available
     893(Font)              Font shape `T1/pcr/b/n' tried instead on input line 543.
     894[11] [12
     895
     896]
     897Chapter 6.
     898[13] [14
     899
     900]
     901Chapter 7.
     902(./pyfact.ind [15] [16
     903
     904] [17
     905
     906
     907]) (./pyfact.aux) )
    876908Here is how much of TeX's memory you used:
    877  6304 strings out of 94500
    878  79435 string characters out of 1176767
    879  141408 words of memory out of 1000000
    880  9299 multiletter control sequences out of 10000+50000
    881  55746 words of font info for 63 fonts, out of 500000 for 2000
     909 6427 strings out of 94500
     910 81642 string characters out of 1176766
     911 145035 words of memory out of 1000000
     912 9363 multiletter control sequences out of 10000+50000
     913 68581 words of font info for 82 fonts, out of 500000 for 2000
    882914 581 hyphenation exceptions out of 1000
    883  34i,11n,45p,294b,379s stack positions out of 1500i,500n,5000p,200000b,5000s
     915 34i,11n,49p,370b,453s stack positions out of 1500i,500n,5000p,200000b,5000s
    884916PDF statistics:
    885  131 PDF objects out of 300000
    886  23 named destinations out of 131072
    887  73 words of extra memory for PDF output out of 65536
    888 {/usr/share/texmf/fonts/enc/dvips/psnfss/8r
    889 .enc}</usr/share/texmf/fonts/type1/urw/times/utmri8a.pfb></usr/share/texmf/font
    890 s/type1/urw/courier/ucrr8a.pfb></usr/share/texmf/fonts/type1/urw/courier/ucrb8a
    891 .pfb></usr/share/texmf/fonts/type1/urw/times/utmb8a.pfb></usr/share/texmf/fonts
    892 /type1/urw/times/utmr8a.pfb></usr/share/texmf/fonts/type1/urw/helvetic/uhvbo8a.
    893 pfb></usr/share/texmf/fonts/type1/urw/helvetic/uhvb8a.pfb>
    894 Output written on pyfact.pdf (15 pages, 92569 bytes).
     917 281 PDF objects out of 300000
     918 69 named destinations out of 131072
     919 169 words of extra memory for PDF output out of 65536
     920{/usr/share/texmf/fonts/enc/dvips/psnfss/8r.enc}</usr/share/
     921texmf/fonts/type1/urw/helvetic/uhvr8a.pfb></usr/share/texmf/fonts/type1/urw/cou
     922rier/ucrb8a.pfb></usr/share/texmf/fonts/type1/urw/courier/ucrr8a.pfb></usr/shar
     923e/texmf/fonts/type1/urw/times/utmri8a.pfb></usr/share/texmf/fonts/type1/urw/tim
     924es/utmb8a.pfb></usr/share/texmf/fonts/type1/urw/times/utmr8a.pfb></usr/share/te
     925xmf/fonts/type1/urw/helvetic/uhvbo8a.pfb></usr/share/texmf/fonts/type1/urw/helv
     926etic/uhvb8a.pfb>
     927Output written on pyfact.pdf (21 pages, 154318 bytes).

  • fact/tools/pyscripts/doc/_build/latex/pyfact.out

    r13151 r13324  
    11\BOOKMARK [0][-]{chapter.1}{Introduction}{}
    2 \BOOKMARK [0][-]{chapter.2}{Classes}{}
    3 \BOOKMARK [1][-]{section.2.1}{pyfact.py}{chapter.2}
    4 \BOOKMARK [0][-]{chapter.3}{Examples}{}
    5 \BOOKMARK [1][-]{section.3.1}{calling a system command}{chapter.3}
    6 \BOOKMARK [0][-]{chapter.4}{phyton in FACT}{}
    7 \BOOKMARK [0][-]{chapter.5}{Indices and tables}{}
     2\BOOKMARK [1][-]{section.1.1}{Python version and modules used}{chapter.1}
     3\BOOKMARK [1][-]{section.1.2}{Style guide and coding conventions}{chapter.1}
     4\BOOKMARK [0][-]{chapter.2}{Getting Started}{}
     5\BOOKMARK [1][-]{section.2.1}{1. Important links}{chapter.2}
     6\BOOKMARK [1][-]{section.2.2}{2. Environment variables}{chapter.2}
     7\BOOKMARK [1][-]{section.2.3}{3. Check out the repository}{chapter.2}
     8\BOOKMARK [1][-]{section.2.4}{4. Create pyfits\137h.so library}{chapter.2}
     9\BOOKMARK [1][-]{section.2.5}{5. Run examples}{chapter.2}
     10\BOOKMARK [0][-]{chapter.3}{Classes}{}
     11\BOOKMARK [1][-]{section.3.1}{pyfact.py}{chapter.3}
     12\BOOKMARK [0][-]{chapter.4}{Classes}{}
     13\BOOKMARK [1][-]{section.4.1}{pyfact.py}{chapter.4}
     14\BOOKMARK [1][-]{section.4.2}{FIR filter functions}{chapter.4}
     15\BOOKMARK [0][-]{chapter.5}{Examples}{}
     16\BOOKMARK [1][-]{section.5.1}{calling a system command}{chapter.5}
     17\BOOKMARK [0][-]{chapter.6}{phyton in FACT}{}
     18\BOOKMARK [0][-]{chapter.7}{Indices and tables}{}
     19\BOOKMARK [0][-]{section*.24}{Index}{}

  • fact/tools/pyscripts/doc/_build/latex/pyfact.tex

    r13151 r13324  
    1313
    1414\title{pyfact Documentation}
    15 \date{February 09, 2012}
     15\date{April 05, 2012}
    1616\release{0.1}
    1717\author{Werner Lustermann}
    … …  
    135135\end{itemize}
    136136
     137If you are new to python you need to learn the basics. In any case it would be wise to study the following book:
     138
     139\emph{A Primer on Scientific Programming with Python - Hans Petter Langtangen}
     140
     141pyfact is supposed to follow closely the programming style thought in this book.
     142
     143\href{http://docs.python.org/}{python documentation pages}
     144
     145\href{http://www.astropython.org/resources}{astropython.org}
     146
     147
     148\section{Python version and modules used}
     149\label{introduction:python-version-and-modules-used}
     150As long as you work on the ISDC FACT cluster most things should be just fine.
     151{\color{red}\bfseries{}\textbar{}}python version: 2.6.6
     152{\color{red}\bfseries{}\textbar{}}--- add later: list of modules
     153
     154
     155\section{Style guide and coding conventions}
     156\label{introduction:style-guide-and-coding-conventions}
     157The 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{}.
     158
     159
     160\chapter{Getting Started}
     161\label{getting_started:getting-started}\label{getting_started::doc}\begin{enumerate}
     162\item {}
     163Get an account at the FACT data center at ISDC
     164
     165\item {}
     166Setup your environment variables
     167
     168\item {}
     169Checkout the pyfact software repository
     170
     171\item {}
     172Try a few examples
     173
     174\end{enumerate}
     175
     176
     177\section{1. Important links}
     178\label{getting_started:important-links}\begin{description}
     179\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
     180here you find instructions how to get an account, how to set it up and how to use it
     181
     182\item[{\textbf{SVN repository} \textless{}\href{https://fact.isdc.unige.ch/svn/fact/}{https://fact.isdc.unige.ch/svn/fact/}\textgreater{}}] \leavevmode
     183hosts all FACT software (including pyfact)
     184
     185\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
     186here you find information about all available runs
     187
     188\item[{\textbf{eLogbook} \textless{}\href{https://www.fact-project.org/logbook/}{https://www.fact-project.org/logbook/}\textgreater{}}] \leavevmode
     189telescope 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{}
     190
     191\item[{\textbf{FACT La Palma pages} \textless{}\href{https://www.fact-project.org/}{https://www.fact-project.org/}\textgreater{}}] \leavevmode
     192plenty of information concerning the telescope in La Palma
     193
     194\end{description}
     195
     196
     197\section{2. Environment variables}
     198\label{getting_started:environment-variables}
     199set the following env variables depending on the SHELL you are using, for instance in .bashrc or .tcshrc
     200\begin{itemize}
     201\item {}
     202\textbf{ROOTSYS}: /swdev\_nfs/root\_v5.28.00
     203
     204\item {}
     205\textbf{PATH}: add \$ROOTSYS/bin
     206
     207\item {}
     208\textbf{PATH}: add /swdev\_nfs/FACT++
     209
     210\item {}
     211\textbf{LD\_LIBRARY\_PATH}: \$ROOTSYS/lib:/swdev\_nfs/FACT++/.libs
     212
     213\item {}
     214\textbf{PYTHONPATH}: \$ROOTSYS/lib
     215
     216\item {} \begin{description}
     217\item[{\textbf{PYTHONPATH}: add all directories where python should search for modules. At least:}] \leavevmode\begin{itemize}
     218\item {}
     219pyscripts/pyfact
     220
     221\item {}
     222pyscript/tools
     223
     224\item {}
     225pyscripts/ecamples
     226
     227\end{itemize}
     228
     229\end{description}
     230
     231\end{itemize}
     232
     233the absolute path depends on where you have checked (or will check) out the pyscripts repository
     234
     235
     236\section{3. Check out the repository}
     237\label{getting_started:check-out-the-repository}
     238svn co \href{https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/}{https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/}
     239
     240
     241\section{4. Create pyfits\_h.so library}
     242\label{getting_started:create-pyfits-h-so-library}
     243FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the existing tools:
     244
     245\emph{pyfits \textless{}http://www.stsci.edu/institute/software\_hardware/pyfits\textgreater{}} which uses \href{http://heasarc.gsfc.nasa.gov/fitsio/}{cfitsio}.
     246
     247To mitigate this problem a C++ class defined in fits.h \footnote{
     248fits.h (here named pyfits.h) is part of MARS and was written by T.Bretz, it was added to this repository for convienience
     249} is used. A simple possibility to create an interface of this C++ class is to use ROOT and later to import it using the
     250\href{http://root.cern.ch/drupal/category/package-context/pyroot}{pyroot} module.
     251
     252got to the directory: pyscripts/pyfact
     253
     254simple:
     255
     256\begin{Verbatim}[commandchars=@\[\]]
     257@PYGZlb[]lusterma@PYGZat[]isdc-cn02 pyfact@PYGZrb[]@$ root
     258ROOT 5.28/00 (trunk@PYGZat[]37585, Dec 14 2010, 15:20:27 on linuxx8664gcc)
     259CINT/ROOT C/C++ Interpreter version 5.18.00, July 2, 2010
     260Type ? for help. Commands must be C++ statements.
     261Enclose multiple statements between { }.
     262
     263root @PYGZlb[]0@PYGZrb[] .L fits.h++
     264Info in @textless[]TUnixSystem::ACLiC@textgreater[]: creating shared library /home@_nfs/isdc/lusterma/pyscripts/pyfact/./fits@_h.so
     265root @PYGZlb[]1@PYGZrb[]
     266\end{Verbatim}
     267
     268This might not work for whatenver reason then it should be done like this:
     269
     270\begin{Verbatim}[commandchars=@\[\]]
     271@$rootcint -f my@_dict.C -c fits.h izstream.h
     272@$g++ -fPIC -c -I@$ROOTSYS/include my@_dict.C -o my@_dict.o
     273@$g++ -o fits@_h.so -shared my@_dict.o
     274\end{Verbatim}
     275
     276Now you can check if the reading rawdata is working:
     277
     278\$ pyfact.py
     279
     280this should print some data from a few events
     281
     282
     283\section{5. Run examples}
     284\label{getting_started:run-examples}
     285
     286\chapter{Classes}
     287\label{getting_started:classes}
     288
     289\section{pyfact.py}
     290\label{getting_started:pyfact-py}
     291
     292\subsection{rawdata access}
     293\label{getting_started:rawdata-access}\index{RawData (class in pyfact)}
     294
     295\begin{fulllineitems}
     296\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}}{}
     297raw data access and calibration
     298\begin{itemize}
     299\item {}
     300open raw data file and drs calibration file
     301
     302\item {}
     303performs amplitude calibration
     304
     305\item {}
     306performs baseline substraction if wanted
     307
     308\item {}
     309provides all data in an array:
     310row = number of pixel
     311col = length of region of interest
     312
     313\end{itemize}
     314
     315initialize object
     316
     317open data file and calibration data file
     318get basic information about the data in data\_file\_name
     319allocate buffers for data access
     320
     321data\_file\_name   : fits or fits.gz file of the data including the path
     322calib\_file\_name : fits or fits.gz file containing DRS calibration data
     323baseline\_file\_name : npy file containing the baseline values
     324\index{baseline\_correct() (pyfact.RawData method)}
     325
     326\begin{fulllineitems}
     327\phantomsection\label{getting_started:pyfact.RawData.baseline_correct}\pysiglinewithargsret{\bfcode{baseline\_correct}}{}{}
     328subtract baseline from the data
     329
     330\end{fulllineitems}
     331
     332\index{baseline\_read\_values() (pyfact.RawData method)}
     333
     334\begin{fulllineitems}
     335\phantomsection\label{getting_started:pyfact.RawData.baseline_read_values}\pysiglinewithargsret{\bfcode{baseline\_read\_values}}{\emph{file}, \emph{bsl\_hist='bsl\_sum/hplt\_mean'}}{}
     336open ROOT file with baseline histogram and read baseline values
     337file       name of the root file
     338bsl\_hist   path to the histogram containing the basline values
     339
     340\end{fulllineitems}
     341
     342\index{board\_times (pyfact.RawData attribute)}
     343
     344\begin{fulllineitems}
     345\phantomsection\label{getting_started:pyfact.RawData.board_times}\pysigline{\bfcode{board\_times}}{}
     346time when the FAD was triggered, in some strange units...
     347
     348\end{fulllineitems}
     349
     350\index{calib\_file (pyfact.RawData attribute)}
     351
     352\begin{fulllineitems}
     353\phantomsection\label{getting_started:pyfact.RawData.calib_file}\pysigline{\bfcode{calib\_file}}{}
     354drs calibration file
     355
     356\end{fulllineitems}
     357
     358\index{calibrate\_drs\_amplitude() (pyfact.RawData method)}
     359
     360\begin{fulllineitems}
     361\phantomsection\label{getting_started:pyfact.RawData.calibrate_drs_amplitude}\pysiglinewithargsret{\bfcode{calibrate\_drs\_amplitude}}{}{}
     362perform the drs amplitude calibration of the event data
     363
     364\end{fulllineitems}
     365
     366\index{data (pyfact.RawData attribute)}
     367
     368\begin{fulllineitems}
     369\phantomsection\label{getting_started:pyfact.RawData.data}\pysigline{\bfcode{data}}{}
     3701D array with raw data
     371
     372\end{fulllineitems}
     373
     374\index{data\_file (pyfact.RawData attribute)}
     375
     376\begin{fulllineitems}
     377\phantomsection\label{getting_started:pyfact.RawData.data_file}\pysigline{\bfcode{data\_file}}{}
     378data file (fits object)
     379
     380\end{fulllineitems}
     381
     382\index{info() (pyfact.RawData method)}
     383
     384\begin{fulllineitems}
     385\phantomsection\label{getting_started:pyfact.RawData.info}\pysiglinewithargsret{\bfcode{info}}{}{}
     386print run information
     387
     388\end{fulllineitems}
     389
     390\index{nevents (pyfact.RawData attribute)}
     391
     392\begin{fulllineitems}
     393\phantomsection\label{getting_started:pyfact.RawData.nevents}\pysigline{\bfcode{nevents}}{}
     394number of events in the data run
     395
     396\end{fulllineitems}
     397
     398\index{next() (pyfact.RawData method)}
     399
     400\begin{fulllineitems}
     401\phantomsection\label{getting_started:pyfact.RawData.next}\pysiglinewithargsret{\bfcode{next}}{}{}
     402used by \_\_iter\_\_
     403
     404\end{fulllineitems}
     405
     406\index{next\_event() (pyfact.RawData method)}
     407
     408\begin{fulllineitems}
     409\phantomsection\label{getting_started:pyfact.RawData.next_event}\pysiglinewithargsret{\bfcode{next\_event}}{}{}
     410load the next event from disk and calibrate it
     411
     412\end{fulllineitems}
     413
     414\index{npix (pyfact.RawData attribute)}
     415
     416\begin{fulllineitems}
     417\phantomsection\label{getting_started:pyfact.RawData.npix}\pysigline{\bfcode{npix}}{}
     418number of pixels (should be 1440)
     419
     420\end{fulllineitems}
     421
     422\index{nroi (pyfact.RawData attribute)}
     423
     424\begin{fulllineitems}
     425\phantomsection\label{getting_started:pyfact.RawData.nroi}\pysigline{\bfcode{nroi}}{}
     426region of interest (number of DRS slices read)
     427
     428\end{fulllineitems}
     429
     430\index{start\_cells (pyfact.RawData attribute)}
     431
     432\begin{fulllineitems}
     433\phantomsection\label{getting_started:pyfact.RawData.start_cells}\pysigline{\bfcode{start\_cells}}{}
     434slice where drs readout started
     435
     436\end{fulllineitems}
     437
     438
     439\end{fulllineitems}
     440
     441
     442
     443\subsection{fnames of a data run}
     444\label{getting_started:fnames-of-a-data-run}\index{fnames (class in pyfact)}
     445
     446\begin{fulllineitems}
     447\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}}{}
     448organize file names of a FACT data run
     449\begin{description}
     450\item[{specifier}] \leavevmode{[}list of strings defined as:{]}
     451{[} `DRS calibration file', `Data file', `YYYY', `MM', `DD'{]}
     452
     453\end{description}
     454
     455rpath     : directory path for the results; YYYYMMDD will be appended to rpath
     456zipped    : use zipped (True) or unzipped (Data)
     457\index{info() (pyfact.fnames method)}
     458
     459\begin{fulllineitems}
     460\phantomsection\label{getting_started:pyfact.fnames.info}\pysiglinewithargsret{\bfcode{info}}{}{}
     461print complete filenames
     462
     463\end{fulllineitems}
     464
     465\index{make() (pyfact.fnames method)}
     466
     467\begin{fulllineitems}
     468\phantomsection\label{getting_started:pyfact.fnames.make}\pysiglinewithargsret{\bfcode{make}}{\emph{specifier}, \emph{rpath}, \emph{zipped}}{}
     469create (make) the filenames
     470
     471names   : dictionary of filenames, tags \{ `data', `drscal', `results' \}
     472data    : name of the data file
     473drscal  : name of the drs calibration file
     474results : radikal of file name(s) for results (to be completed  by suffixes)
     475
     476\end{fulllineitems}
     477
     478
     479\end{fulllineitems}
     480
     481
    137482
    138483\chapter{Classes}
    … …  
    146491
    147492\subsection{fnames of a data run}
    148 \label{classes:fnames-of-a-data-run}
     493\label{classes:fnames-of-a-data-run}\index{fnames (class in pyfact)}
     494
     495\begin{fulllineitems}
     496\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}}{}
     497organize file names of a FACT data run
     498\begin{description}
     499\item[{specifier}] \leavevmode{[}list of strings defined as:{]}
     500{[} `DRS calibration file', `Data file', `YYYY', `MM', `DD'{]}
     501
     502\end{description}
     503
     504rpath     : directory path for the results; YYYYMMDD will be appended to rpath
     505zipped    : use zipped (True) or unzipped (Data)
     506\index{info() (pyfact.fnames method)}
     507
     508\begin{fulllineitems}
     509\phantomsection\label{classes:pyfact.fnames.info}\pysiglinewithargsret{\bfcode{info}}{}{}
     510print complete filenames
     511
     512\end{fulllineitems}
     513
     514\index{make() (pyfact.fnames method)}
     515
     516\begin{fulllineitems}
     517\phantomsection\label{classes:pyfact.fnames.make}\pysiglinewithargsret{\bfcode{make}}{\emph{specifier}, \emph{rpath}, \emph{zipped}}{}
     518create (make) the filenames
     519
     520names   : dictionary of filenames, tags \{ `data', `drscal', `results' \}
     521data    : name of the data file
     522drscal  : name of the drs calibration file
     523results : radikal of file name(s) for results (to be completed  by suffixes)
     524
     525\end{fulllineitems}
     526
     527
     528\end{fulllineitems}
     529
     530
     531
     532\section{FIR filter functions}
     533\label{classes:fir-filter-functions}
    149534
    150535\chapter{Examples}

  • fact/tools/pyscripts/doc/_build/latex/pyfact.toc

    r13151 r13324  
    11\select@language {english}
    22\contentsline {chapter}{\numberline {1}Introduction}{3}{chapter.1}
    3 \contentsline {chapter}{\numberline {2}Classes}{5}{chapter.2}
    4 \contentsline {section}{\numberline {2.1}pyfact.py}{5}{section.2.1}
    5 \contentsline {subsection}{\numberline {2.1.1}rawdata access}{5}{subsection.2.1.1}
    6 \contentsline {subsection}{\numberline {2.1.2}fnames of a data run}{5}{subsection.2.1.2}
    7 \contentsline {chapter}{\numberline {3}Examples}{7}{chapter.3}
    8 \contentsline {section}{\numberline {3.1}calling a system command}{7}{section.3.1}
    9 \contentsline {chapter}{\numberline {4}phyton in FACT}{9}{chapter.4}
    10 \contentsline {chapter}{\numberline {5}Indices and tables}{11}{chapter.5}
     3\contentsline {section}{\numberline {1.1}Python version and modules used}{3}{section.1.1}
     4\contentsline {section}{\numberline {1.2}Style guide and coding conventions}{3}{section.1.2}
     5\contentsline {chapter}{\numberline {2}Getting Started}{5}{chapter.2}
     6\contentsline {section}{\numberline {2.1}1. Important links}{5}{section.2.1}
     7\contentsline {section}{\numberline {2.2}2. Environment variables}{5}{section.2.2}
     8\contentsline {section}{\numberline {2.3}3. Check out the repository}{6}{section.2.3}
     9\contentsline {section}{\numberline {2.4}4. Create pyfits\_h.so library}{6}{section.2.4}
     10\contentsline {section}{\numberline {2.5}5. Run examples}{6}{section.2.5}
     11\contentsline {chapter}{\numberline {3}Classes}{7}{chapter.3}
     12\contentsline {section}{\numberline {3.1}pyfact.py}{7}{section.3.1}
     13\contentsline {subsection}{\numberline {3.1.1}rawdata access}{7}{subsection.3.1.1}
     14\contentsline {subsection}{\numberline {3.1.2}fnames of a data run}{8}{subsection.3.1.2}
     15\contentsline {chapter}{\numberline {4}Classes}{9}{chapter.4}
     16\contentsline {section}{\numberline {4.1}pyfact.py}{9}{section.4.1}
     17\contentsline {subsection}{\numberline {4.1.1}rawdata access}{9}{subsection.4.1.1}
     18\contentsline {subsection}{\numberline {4.1.2}fnames of a data run}{9}{subsection.4.1.2}
     19\contentsline {section}{\numberline {4.2}FIR filter functions}{9}{section.4.2}
     20\contentsline {chapter}{\numberline {5}Examples}{11}{chapter.5}
     21\contentsline {section}{\numberline {5.1}calling a system command}{11}{section.5.1}
     22\contentsline {chapter}{\numberline {6}phyton in FACT}{13}{chapter.6}
     23\contentsline {chapter}{\numberline {7}Indices and tables}{15}{chapter.7}
     24\contentsline {chapter}{Index}{17}{section*.24}
Note: See TracChangeset for help on using the changeset viewer.