Table of Contents

• Package pyana
  • Module pyana.calib
  • Module pyana.config
    • Class pyana.config.config
  • Module pyana.event
  • Module pyana.event_keys
    • Class pyana.event_keys.event_keys
  • Module pyana.expname
  • Module pyana.histo
    • Class pyana.histo.HistoMgrRoot
    • Function pyana.histo.HistoMgr
  • Module pyana.input
  • Module pyana.merger
    • Class pyana.merger.merger
  • Module pyana.mp_proto
  • Module pyana.pyanamod
  • Module pyana.userana
  • Module pyana.xtc_output

Package pyana

This package collects code which deals with various aspects of the analysis tasks.

Module pyana.calib

Module pyana.config

Job configuration for pyana

This software was developed for the LUSI project. If you use all or part of it, please give an appropriate acknowledgment.

See also: RelatedModule

Version: $Id: config.py 5534 2013-02-27 22:30:02Z salnikov@SLAC.STANFORD.EDU $

Author: Andrei Salnikov

Class pyana.config.config

class pyana.config.config(args=None)

files()

Returns the list of input file names

getJobConfig(option, default=None)

Gets configuration option from one of many sections

getModuleConfig(module)

Gets configuration options for a module as a dictionary

Module pyana.event

Module pyana.event_keys

User analysis module for pyana framework.

This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.

Version: $Id: event_keys.py 3020 2012-03-06 22:22:18Z salnikov@SLAC.STANFORD.EDU $

Author: Andy Salnikov

Class pyana.event_keys.event_keys

class pyana.event_keys.event_keys

Pyana module which prints event keys.

begincalibcycle(evt, env)

beginjob(evt, env)

beginrun(evt, env)

endcalibcycle(evt, env)

endjob(evt, env)

endrun(evt, env)

event(evt, env)

Module pyana.expname

Module pyana.histo

This module is a collection classes and methods to create and manage histograms from user analysis modules. Current implementation is based on ROOT package (http://root.cern.ch/). Histograms objects produced byt this package are actually ROOT objects. For detailed description of their interfaces consult ROOT documentation.

Class pyana.histo.HistoMgrRoot

class pyana.histo.HistoMgrRoot(**kw)

This class is histogram manager implementation based on ROOT library. Histograms that are created by this manager reside either in memory or in a ROOT file.

Creates new histogram manager object. Users should not instantiate new objects, instead the environment method hmgr() should be used to obtain existing manager object.

Keyword arguments: file - name of the ROOT file to store histograms, if missing then histograms will be memory-resident.

close()

Write everything to file and close the file.

file() → TFile

Returns ROOT file object for this manager, or None if histograms are stored in memory.

h1d(*args, **kw) → TH1D

Creates 1-dimensional histogram with bin contents stored as double precision numbers.

Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH1D. The returned Python object also inherits most of the methods of the C++ class.

h1f(*args, **kw) → TH1F

Creates 1-dimensional histogram with bin contents stored as single precision numbers.

Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH1F. The returned Python object also inherits most of the methods of the C++ class.

h1i(*args, **kw) → TH1I

Creates 1-dimensional histogram with bin contents stored as integer numbers.

Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH1I. The returned Python object also inherits most of the methods of the C++ class.

h2d(*args, **kw) → TH2D

Creates 2-dimensional histogram with bin contents stored as double precision numbers.

Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH2D. The returned Python object also inherits most of the methods of the C++ class.

h2f(*args, **kw) → TH2F

Creates 2-dimensional histogram with bin contents stored as single precision numbers.

Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH2D. The returned Python object also inherits most of the methods of the C++ class.

h2i(*args, **kw) → TH2I

Creates 2-dimensional histogram with bin contents stored as integer numbers.

Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH2I. The returned Python object also inherits most of the methods of the C++ class.

histos() → list

Returns the list of histograms in the current ROOT directory. User code does not need to use this methods, for framework implementation only.

prof(*args, **kw) → TProfile

Creates 1-dimensional profile histogram with bin contents stored as double precision numbers.

Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TProfile. The returned Python object also inherits most of the methods of the C++ class.

prof2d(*args, **kw) → TProfile2D

Creates 2-dimensional profile histogram with bin contents stored as double precision numbers.

Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TProfile2D. The returned Python object also inherits most of the methods of the C++ class.

Function pyana.histo.HistoMgr

pyana.histo.HistoMgr() → HistoMgrRoot

Factory method which returns an instance of the histogram manager. Current implementation always returns the same ROOT manager instance.

Module pyana.input

Module pyana.merger

Code that merges results of processing from individual jobs

This software was developed for the LUSI project. If you use all or part of it, please give an appropriate acknowledgment.

See also: RelatedModule

Version: $Id: merger.py 1091 2010-07-07 22:45:39Z salnikov $

Author: Andrei Salnikov

Class pyana.merger.merger

class pyana.merger.merger

_merger__mergeFiles(files)

_merger__mergeHistos(histos)

finish(env)

merge(result)

Module pyana.mp_proto

Module pyana.pyanamod

Module pyana.userana

Module pyana.xtc_output