Index: /fact/tools/pyscripts/doc/_build/html/.buildinfo =================================================================== --- /fact/tools/pyscripts/doc/_build/html/.buildinfo (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/.buildinfo (revision 13316) @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 4ccce79467c3c1e26dd2c30bdca24749 +config: ba772b99f74f3e46a3c0f95d44c9931e tags: fbb0d17656682115ca4d033fb2f83ba1 Index: /fact/tools/pyscripts/doc/_build/html/_sources/classes.txt =================================================================== --- /fact/tools/pyscripts/doc/_build/html/_sources/classes.txt (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/_sources/classes.txt (revision 13316) @@ -18,5 +18,5 @@ FIR filter functions --------------------- +===================== .. autoclass:: fir_filter :members: Index: /fact/tools/pyscripts/doc/_build/html/_sources/getting_started.txt =================================================================== --- /fact/tools/pyscripts/doc/_build/html/_sources/getting_started.txt (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/_sources/getting_started.txt (revision 13316) @@ -1,2 +1,77 @@ +=============== +Getting Started +=============== + +1) Get an account at the FACT data center at ISDC +2) Setup your environment variables +3) Checkout the pyfact software repository +4) Try a few examples + +1. Important links +================================= + +**FACT data center at ISDC** ** + here you find instructions how to get an account, how to set it up and how to use it + +**SVN repository** + hosts all FACT software (including pyfact) + +**FACT run database** + here you find information about all available runs + +**eLogbook** + telescope logbook used since Dec. 1, 2012; for logbook information before this date have a look here: + +**FACT La Palma pages** + plenty of information concerning the telescope in La Palma + +2. Environment variables +===================== +set the following env variables depending on the SHELL you are using, for instance in .bashrc or .tcshrc + +* **ROOTSYS**: /swdev_nfs/root_v5.28.00 +* **PATH**: add $ROOTSYS/bin +* **PATH**: add /swdev_nfs/FACT++ +* **LD_LIBRARY_PATH**: $ROOTSYS/lib:/swdev_nfs/FACT++/.libs +* **PYTHONPATH**: $ROOTSYS/lib +* **PYTHONPATH**: add all directories where python should search for modules. At least: + * pyscripts/pyfact + * pyscript/tools + * pyscripts/ecamples + * py + +the absolute path depends on where you have checked (or will check) out the pyscripts repository + +3. Check out the repository +======================== +svn co https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/ + +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 `. + +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. + +simple:: + + [pceth118] /home/luster/py > root + ROOT 5.28/00h (branches/v5-28-00-patches@42209, Feb 13 2012, 23:52:00 on linux) + 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 + root [1] + + + +5. Run examples +============ + + ======= Classes @@ -8,5 +83,5 @@ rawdata access ------- -.. autoclass:: pyfact.rawdata +.. autoclass:: pyfact.RawData :members: Index: /fact/tools/pyscripts/doc/_build/html/_sources/index.txt =================================================================== --- /fact/tools/pyscripts/doc/_build/html/_sources/index.txt (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/_sources/index.txt (revision 13316) @@ -13,4 +13,5 @@ introduction + getting_started classes examples Index: /fact/tools/pyscripts/doc/_build/html/_sources/introduction.txt =================================================================== --- /fact/tools/pyscripts/doc/_build/html/_sources/introduction.txt (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/_sources/introduction.txt (revision 13316) @@ -9,3 +9,21 @@ * examples -The code of pyfact follows the `Style Guide for python code _. +If you are new to python you need to learn the basics. In any case it would be wise to study the following book: + +*A Primer on Scientific Programming with Python - Hans Petter Langtangen* + +pyfact is supposed to follow closely the programming style thought in this book. + +`python documentation pages `_ + +`astropython.org `_ + +Python version and modules used +------------------------------- +As long as you work on the ISDC FACT cluster most things should be just fine. +|python version: 2.6.6 +|--- add later: list of modules + +Style guide and coding conventions +---------------------------------- +The code of pyfact follows the `Style Guide for python code . Index: /fact/tools/pyscripts/doc/_build/html/_static/basic.css =================================================================== --- /fact/tools/pyscripts/doc/_build/html/_static/basic.css (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/_static/basic.css (revision 13316) @@ -5,5 +5,5 @@ * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * @@ -78,12 +78,4 @@ font-family: sans-serif; font-size: 1em; -} - -div.sphinxsidebar input[type="text"] { - width: 170px; -} - -div.sphinxsidebar input[type="submit"] { - width: 30px; } @@ -222,22 +214,4 @@ } -img.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - .align-left { text-align: left; @@ -245,4 +219,5 @@ .align-center { + clear: both; text-align: center; } @@ -421,5 +396,5 @@ .footnote:target { - background-color: #ffa; + background-color: #ffa } @@ -448,14 +423,8 @@ } -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - /* -- code displays --------------------------------------------------------- */ pre { overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ } Index: /fact/tools/pyscripts/doc/_build/html/_static/default.css =================================================================== --- /fact/tools/pyscripts/doc/_build/html/_static/default.css (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/_static/default.css (revision 13316) @@ -5,5 +5,5 @@ * Sphinx stylesheet -- default theme. * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * Index: /fact/tools/pyscripts/doc/_build/html/_static/doctools.js =================================================================== --- /fact/tools/pyscripts/doc/_build/html/_static/doctools.js (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/_static/doctools.js (revision 13316) @@ -3,7 +3,7 @@ * ~~~~~~~~~~~ * - * Sphinx JavaScript utilities for all documentation. + * Sphinx JavaScript utilties for all documentation. * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * @@ -186,7 +186,7 @@ }); }, 10); - $('

' + _('Hide Search Matches') + '

') - .appendTo($('#searchbox')); + $('
  • ' + _('Hide Search Matches') + '
    • ') + .appendTo($('.sidebar .this-page-menu')); } }, @@ -214,5 +214,5 @@ */ hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); + $('.sidebar .this-page-menu li.highlight-link').fadeOut(300); $('span.highlighted').removeClass('highlighted'); }, Index: /fact/tools/pyscripts/doc/_build/html/_static/pygments.css =================================================================== --- /fact/tools/pyscripts/doc/_build/html/_static/pygments.css (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/_static/pygments.css (revision 13316) Index: /fact/tools/pyscripts/doc/_build/html/_static/searchtools.js =================================================================== --- /fact/tools/pyscripts/doc/_build/html/_static/searchtools.js (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/_static/searchtools.js (revision 13316) @@ -1,9 +1,9 @@ /* - * searchtools.js_t - * ~~~~~~~~~~~~~~~~ + * searchtools.js + * ~~~~~~~~~~~~~~ * * Sphinx JavaScript utilties for the full-text search. * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * @@ -37,9 +37,8 @@ } - /** * Porter Stemmer */ -var Stemmer = function() { +var PorterStemmer = function() { var step2list = { @@ -302,18 +301,18 @@ query : function(query) { - var stopwords = ["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"]; - - // Stem the searchterms and add them to the correct list - var stemmer = new Stemmer(); + var stopwords = ['and', 'then', 'into', 'it', 'as', 'are', 'in', + 'if', 'for', 'no', 'there', 'their', 'was', 'is', + 'be', 'to', 'that', 'but', 'they', 'not', 'such', + 'with', 'by', 'a', 'on', 'these', 'of', 'will', + 'this', 'near', 'the', 'or', 'at']; + + // stem the searchterms and add them to the correct list + var stemmer = new PorterStemmer(); var searchterms = []; var excluded = []; var hlterms = []; var tmp = query.split(/\s+/); - var objectterms = []; + var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null; for (var i = 0; i < tmp.length; i++) { - if (tmp[i] != "") { - objectterms.push(tmp[i].toLowerCase()); - } - if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || tmp[i] == "") { @@ -346,4 +345,7 @@ var titles = this._index.titles; var terms = this._index.terms; + var objects = this._index.objects; + var objtypes = this._index.objtypes; + var objnames = this._index.objnames; var fileMap = {}; var files = null; @@ -356,16 +358,37 @@ // lookup as object - for (var i = 0; i < objectterms.length; i++) { - var others = [].concat(objectterms.slice(0,i), - objectterms.slice(i+1, objectterms.length)) - var results = this.performObjectSearch(objectterms[i], others); - // Assume first word is most likely to be the object, - // other words more likely to be in description. - // Therefore put matches for earlier words first. - // (Results are eventually used in reverse order). - objectResults = results[0].concat(objectResults); - importantResults = results[1].concat(importantResults); - unimportantResults = results[2].concat(unimportantResults); - } + if (object != null) { + for (var prefix in objects) { + for (var name in objects[prefix]) { + var fullname = (prefix ? prefix + '.' : '') + name; + if (fullname.toLowerCase().indexOf(object) > -1) { + match = objects[prefix][name]; + descr = objnames[match[1]] + _(', in ') + titles[match[0]]; + // XXX the generated anchors are not generally correct + // XXX there may be custom prefixes + result = [filenames[match[0]], fullname, '#'+fullname, descr]; + switch (match[2]) { + case 1: objectResults.push(result); break; + case 0: importantResults.push(result); break; + case 2: unimportantResults.push(result); break; + } + } + } + } + } + + // sort results descending + objectResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + importantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + unimportantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + // perform the search on the required terms @@ -467,5 +490,5 @@ displayNextItem(); }); - }, "text"); + }); } else { // no source available, just display title @@ -488,69 +511,4 @@ } displayNextItem(); - }, - - performObjectSearch : function(object, otherterms) { - var filenames = this._index.filenames; - var objects = this._index.objects; - var objnames = this._index.objnames; - var titles = this._index.titles; - - var importantResults = []; - var objectResults = []; - var unimportantResults = []; - - for (var prefix in objects) { - for (var name in objects[prefix]) { - var fullname = (prefix ? prefix + '.' : '') + name; - if (fullname.toLowerCase().indexOf(object) > -1) { - var match = objects[prefix][name]; - var objname = objnames[match[1]][2]; - var title = titles[match[0]]; - // If more than one term searched for, we require other words to be - // found in the name/title/description - if (otherterms.length > 0) { - var haystack = (prefix + ' ' + name + ' ' + - objname + ' ' + title).toLowerCase(); - var allfound = true; - for (var i = 0; i < otherterms.length; i++) { - if (haystack.indexOf(otherterms[i]) == -1) { - allfound = false; - break; - } - } - if (!allfound) { - continue; - } - } - var descr = objname + _(', in ') + title; - anchor = match[3]; - if (anchor == '') - anchor = fullname; - else if (anchor == '-') - anchor = objnames[match[1]][1] + '-' + fullname; - result = [filenames[match[0]], fullname, '#'+anchor, descr]; - switch (match[2]) { - case 1: objectResults.push(result); break; - case 0: importantResults.push(result); break; - case 2: unimportantResults.push(result); break; - } - } - } - } - - // sort results descending - objectResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - importantResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - unimportantResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); - - return [importantResults, objectResults, unimportantResults] } } Index: /fact/tools/pyscripts/doc/_build/html/_static/sidebar.js =================================================================== --- /fact/tools/pyscripts/doc/_build/html/_static/sidebar.js (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/_static/sidebar.js (revision 13316) @@ -17,5 +17,5 @@ * reset to the default (expanded). * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * @@ -29,7 +29,4 @@ var sidebar = $('.sphinxsidebar'); var sidebarwrapper = $('.sphinxsidebarwrapper'); - - // for some reason, the document has no sidebar; do not run into errors - if (!sidebar.length) return; // original margin-left of the bodywrapper and width of the sidebar Index: /fact/tools/pyscripts/doc/_build/html/_static/underscore.js =================================================================== --- /fact/tools/pyscripts/doc/_build/html/_static/underscore.js (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/_static/underscore.js (revision 13316) @@ -1,9 +1,2 @@ -// Underscore.js 0.5.5 -// (c) 2009 Jeremy Ashkenas, DocumentCloud Inc. -// Underscore is freely distributable under the terms of the MIT license. -// Portions of Underscore are inspired by or borrowed from Prototype.js, -// Oliver Steele's Functional, and John Resig's Micro-Templating. -// For all details and documentation: -// http://documentcloud.github.com/underscore/ (function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e - - Classes — pyfact 0.1 documentation - + Classes — pyfact v0.1 documentation - - + @@ -43,5 +40,5 @@ previous | -
  • pyfact 0.1 documentation »
    • +
  • pyfact v0.1 documentation »
    • @@ -61,8 +58,36 @@

    fnames of a data run

    +
    +
    +class pyfact.fnames(specifier=['012', '023', '2011', '11', '24'], rpath='/scratch_nfs/res/bsl/', zipped=True)
    +

    organize file names of a FACT data run

    +
    +
    specifier : list of strings defined as:
    +
    [ ‘DRS calibration file’, ‘Data file’, ‘YYYY’, ‘MM’, ‘DD’]
    +
    +

    rpath : directory path for the results; YYYYMMDD will be appended to rpath +zipped : use zipped (True) or unzipped (Data)

    +
    +
    +info()
    +

    print complete filenames

    +
    + +
    +
    +make(specifier, rpath, 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)

    +
    + +
    + +
    -

    FIR filter functions

    -
    +

    FIR filter functions

    @@ -80,7 +105,7 @@
  • rawdata access
  • fnames of a data run
    • -
  • FIR filter functions
    • +
  • FIR filter functions
    • @@ -101,5 +126,5 @@

    Quick search

    - + @@ -127,10 +152,10 @@ previous | -
  • pyfact 0.1 documentation »
    • +
  • pyfact v0.1 documentation »
    • © Copyright 2012, Werner Lustermann. - Created using Sphinx 1.1.2. + Created using Sphinx 1.0.4.
    Index: /fact/tools/pyscripts/doc/_build/html/examples.html =================================================================== --- /fact/tools/pyscripts/doc/_build/html/examples.html (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/examples.html (revision 13316) @@ -4,14 +4,11 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - - Examples — pyfact 0.1 documentation - + Examples — pyfact v0.1 documentation - - + @@ -43,5 +40,5 @@ previous | -
  • pyfact 0.1 documentation »
    • +
  • pyfact v0.1 documentation »
    • @@ -97,5 +94,5 @@

    Quick search

    - + @@ -123,10 +120,10 @@ previous | -
  • pyfact 0.1 documentation »
    • +
  • pyfact v0.1 documentation »
    • © Copyright 2012, Werner Lustermann. - Created using Sphinx 1.1.2. + Created using Sphinx 1.0.4.
    Index: /fact/tools/pyscripts/doc/_build/html/genindex.html =================================================================== --- /fact/tools/pyscripts/doc/_build/html/genindex.html (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/genindex.html (revision 13316) @@ -1,4 +1,2 @@ - - @@ -6,14 +4,11 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - - Index — pyfact 0.1 documentation - + Index — pyfact v0.1 documentation - - + @@ -37,5 +32,5 @@ index -
  • pyfact 0.1 documentation »
    • +
  • pyfact v0.1 documentation »
    • @@ -47,9 +42,91 @@ -

    Index

    +

    Index

    -
    - -
    +
    + B | C | D | F | I | M | N | R | S +
    +

    B

    + + + +
    +
    baseline_correct() (pyfact.RawData method)
    +
    baseline_read_values() (pyfact.RawData method)
    +
    +
    board_times (pyfact.RawData attribute)
    +
    + +

    C

    + + + +
    +
    calib_file (pyfact.RawData attribute)
    +
    +
    calibrate_drs_amplitude() (pyfact.RawData method)
    +
    + +

    D

    + + + +
    +
    data (pyfact.RawData attribute)
    +
    +
    data_file (pyfact.RawData attribute)
    +
    + +

    F

    + + +
    +
    fnames (class in pyfact), [1]
    +
    + +

    I

    + + +
    +
    info() (pyfact.fnames method), [1]
    +
    +
    (pyfact.RawData method)
    +
    +
    + +

    M

    + + +
    +
    make() (pyfact.fnames method), [1]
    +
    + +

    N

    + + + +
    +
    nevents (pyfact.RawData attribute)
    +
    next() (pyfact.RawData method)
    +
    next_event() (pyfact.RawData method)
    +
    +
    npix (pyfact.RawData attribute)
    +
    nroi (pyfact.RawData attribute)
    +
    + +

    R

    + + +
    +
    RawData (class in pyfact)
    +
    + +

    S

    + + +
    +
    start_cells (pyfact.RawData attribute)
    +
    + @@ -65,5 +142,5 @@

    Quick search

    - + @@ -85,10 +162,10 @@ index -
  • pyfact 0.1 documentation »
    • +
  • pyfact v0.1 documentation »
    • © Copyright 2012, Werner Lustermann. - Created using Sphinx 1.1.2. + Created using Sphinx 1.0.4.
    Index: /fact/tools/pyscripts/doc/_build/html/getting_started.html =================================================================== --- /fact/tools/pyscripts/doc/_build/html/getting_started.html (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/getting_started.html (revision 13316) @@ -3,5 +3,4 @@ - @@ -9,9 +8,7 @@ - Classes — pyfact 0.1 documentation - + Getting Started — pyfact v0.1 documentation - - + + + @@ -35,5 +34,11 @@ index -
  • pyfact 0.1 documentation »
    • +
  • + next |
    • +
  • + previous |
    • +
  • pyfact v0.1 documentation »
    • @@ -44,5 +49,81 @@
    -
    +
    +

    Getting Started

    +
      +
    1. Get an account at the FACT data center at ISDC
      2. +
    2. Setup your environment variables
      3. +
    3. Checkout the pyfact software repository
      4. +
    4. Try a few examples
      5. +
    + +
    +

    2. Environment variables

    +

    set the following env variables depending on the SHELL you are using, for instance in .bashrc or .tcshrc

    +
      +

    • ROOTSYS: /swdev_nfs/root_v5.28.00

      +
      • +

    • PATH: add $ROOTSYS/bin

      +
      • +

    • PATH: add /swdev_nfs/FACT++

      +
      • +

    • LD_LIBRARY_PATH: $ROOTSYS/lib:/swdev_nfs/FACT++/.libs

      +
      • +

    • PYTHONPATH: $ROOTSYS/lib

      +
      • +
    • +
      PYTHONPATH: add all directories where python should search for modules. At least:
      +
        +
      • pyscripts/pyfact
        • +
      • pyscript/tools
        • +
      • pyscripts/ecamples
        • +
      • py
        • +
      +
      +
      +
      • +
    +

    the absolute path depends on where you have checked (or will check) out the pyscripts repository

    +
    +
    +

    3. Check out the repository

    +

    svn co https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/

    +
    +
    +

    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.

    +

    simple:

    +
    [pceth118] /home/luster/py > root
+ROOT 5.28/00h (branches/v5-28-00-patches@42209, Feb 13 2012, 23:52:00 on linux)
+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
+root [1]
    +
    +
    +
    +

    5. Run examples

    +
    +
    +

    Classes

    @@ -50,7 +131,142 @@

    rawdata access

    +
    +
    +class pyfact.RawData(data_file_name, calib_file_name, user_action_calib=<function <lambda> at 0xa818844>, baseline_file_name='', return_dict=None)
    +

    raw data access and calibration

    +
      +
    • open raw data file and drs calibration file
      • +
    • performs amplitude calibration
      • +
    • performs baseline substraction if wanted
      • +
    • provides all data in an array: +row = number of pixel +col = length of region of interest
      • +
    +

    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

    +
    +
    +baseline_correct()
    +

    subtract baseline from the data

    +
    + +
    +
    +baseline_read_values(file, 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

    +
    + +
    +
    +board_times
    +

    time when the FAD was triggered, in some strange units...

    +
    + +
    +
    +calib_file
    +

    drs calibration file

    +
    + +
    +
    +calibrate_drs_amplitude()
    +

    perform the drs amplitude calibration of the event data

    +
    + +
    +
    +data
    +

    1D array with raw data

    +
    + +
    +
    +data_file
    +

    data file (fits object)

    +
    + +
    +
    +info()
    +

    print run information

    +
    + +
    +
    +nevents
    +

    number of events in the data run

    +
    + +
    +
    +next()
    +

    used by __iter__

    +
    + +
    +
    +next_event()
    +

    load the next event from disk and calibrate it

    +
    + +
    +
    +npix
    +

    number of pixels (should be 1440)

    +
    + +
    +
    +nroi
    +

    region of interest (number of DRS slices read)

    +
    + +
    +
    +start_cells
    +

    slice where drs readout started

    +
    + +
    +

    fnames of a data run

    +
    +
    +class pyfact.fnames(specifier=['012', '023', '2011', '11', '24'], rpath='/scratch_nfs/res/bsl/', zipped=True)
    +

    organize file names of a FACT data run

    +
    +
    specifier : list of strings defined as:
    +
    [ ‘DRS calibration file’, ‘Data file’, ‘YYYY’, ‘MM’, ‘DD’]
    +
    +

    rpath : directory path for the results; YYYYMMDD will be appended to rpath +zipped : use zipped (True) or unzipped (Data)

    +
    +
    +info()
    +

    print complete filenames

    +
    + +
    +
    +make(specifier, rpath, 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)

    +
    + +
    +
    @@ -65,5 +281,13 @@

    Table Of Contents

    © Copyright 2012, Werner Lustermann. - Created using Sphinx 1.1.2. + Created using Sphinx 1.0.4.
    Index: /fact/tools/pyscripts/doc/_build/html/index.html =================================================================== --- /fact/tools/pyscripts/doc/_build/html/index.html (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/index.html (revision 13316) @@ -4,14 +4,11 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - - Welcome to pyfact’s documentation! — pyfact 0.1 documentation - + Welcome to pyfact’s documentation! — pyfact v0.1 documentation - - + @@ -39,5 +36,5 @@ next | -
  • pyfact 0.1 documentation »
    • +
  • pyfact v0.1 documentation »
    • @@ -53,12 +50,32 @@
    © Copyright 2012, Werner Lustermann. - Created using Sphinx 1.1.2. + Created using Sphinx 1.0.4.
    Index: /fact/tools/pyscripts/doc/_build/html/introduction.html =================================================================== --- /fact/tools/pyscripts/doc/_build/html/introduction.html (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/introduction.html (revision 13316) @@ -4,14 +4,11 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - - Introduction — pyfact 0.1 documentation - + Introduction — pyfact v0.1 documentation - - - + + @@ -38,10 +35,10 @@ accesskey="I">index
  • - next |
  • previous |
    • -
  • pyfact 0.1 documentation »
    • +
  • pyfact v0.1 documentation »
    • @@ -61,5 +58,19 @@
  • examples
    • -

    The code of pyfact follows the `Style Guide for python code <http://www.python.org/dev/peps/pep-0008/>_.

    +

    If you are new to python you need to learn the basics. In any case it would be wise to study the following book:

    +

    A Primer on Scientific Programming with Python - Hans Petter Langtangen

    +

    pyfact is supposed to follow closely the programming style thought in this book.

    +

    python documentation pages

    +

    astropython.org

    +
    +

    Python version and modules used

    +

    As long as you work on the ISDC FACT cluster most things should be just fine. +|python version: 2.6.6 +|— add later: list of modules

    +
    +
    +

    Style guide and coding conventions

    +

    The code of pyfact follows the `Style Guide for python code <http://www.python.org/dev/peps/pep-0008/>.

    +
    @@ -70,10 +81,19 @@
    +

    Table Of Contents

    + +

    Previous topic

    Welcome to pyfact’s documentation!

    Next topic

    -

    Classes

    +

    Getting Started

    This Page

    © Copyright 2012, Werner Lustermann. - Created using Sphinx 1.1.2. + Created using Sphinx 1.0.4.
    Index: /fact/tools/pyscripts/doc/_build/html/python.html =================================================================== --- /fact/tools/pyscripts/doc/_build/html/python.html (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/python.html (revision 13316) @@ -4,14 +4,11 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - - phyton in FACT — pyfact 0.1 documentation - + phyton in FACT — pyfact v0.1 documentation - - + @@ -39,5 +36,5 @@ previous | -
  • pyfact 0.1 documentation »
    • +
  • pyfact v0.1 documentation »
    • @@ -82,5 +79,5 @@

    Quick search

    - + @@ -105,10 +102,10 @@ previous | -
  • pyfact 0.1 documentation »
    • +
  • pyfact v0.1 documentation »
    • © Copyright 2012, Werner Lustermann. - Created using Sphinx 1.1.2. + Created using Sphinx 1.0.4.
    Index: /fact/tools/pyscripts/doc/_build/html/search.html =================================================================== --- /fact/tools/pyscripts/doc/_build/html/search.html (revision 13315) +++ /fact/tools/pyscripts/doc/_build/html/search.html (revision 13316) @@ -4,14 +4,11 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - - Search — pyfact 0.1 documentation - + Search — pyfact v0.1 documentation - - +