python::rootplot::utilities Namespace Reference

Classes
class	Hist
class	Hist2D
	Define classes. More...
class	HistStack
class	RootFile
Functions
def	_rootglob0
def	_rootglob1
def	find_num_processors
def	get
def	has_glob_magic
def	irootglob
def	loadROOT
	Define additional helping functions.
def	ls
def	process_bin_labels
def	pwd
def	replace
def	rootglob
def	testfile
def	wilson_interval
Variables
string	__license__
tuple	glob_magic_check = re.compile('[*?[]')
	Functions for globbing within root files.

---

Detailed Description

Utilities for rootplot including histogram classes.

---

Function Documentation

def python::rootplot::utilities::_rootglob0	(		tdirectory,
			dirname,
			basename
	)		[private]

Definition at line 552 of file utilities.py.

                                             :
    if tdirectory.Get(os.path.join(dirname, basename)):
        return [basename]
    return []

def python::rootplot::utilities::_rootglob1	(		tdirectory,
			dirname,
			pattern
	)		[private]

Definition at line 545 of file utilities.py.

                                            :
    if not tdirectory.GetDirectory(dirname):
        return []
    names = [key.GetName() for key in 
             tdirectory.GetDirectory(dirname).GetListOfKeys()]
    return fnmatch.filter(names, pattern)

def python::rootplot::utilities::find_num_processors

(

)

Definition at line 510 of file utilities.py.

                         :
    import os
    try:
        num_processors = os.sysconf('SC_NPROCESSORS_ONLN')
    except:
        try:
            num_processors = os.environ['NUMBER_OF_PROCESSORS']
        except:
            num_processors = 1
    return num_processors

def python::rootplot::utilities::get

(

object_name

)

Return a Hist object with the given name.

Definition at line 426 of file utilities.py.

                    :
    """Return a Hist object with the given name."""
    return Hist(ROOT.gDirectory.Get(object_name))

def python::rootplot::utilities::has_glob_magic

(

s

)

Definition at line 537 of file utilities.py.

                     :
    return glob_magic_check.search(s) is not None

# These 2 helper functions non-recursively glob inside a literal directory.
# They return a list of basenames. `_rootglob1` accepts a pattern while 
# `_rootglob0` takes a literal basename (so it only has to check for its 
# existence).

def python::rootplot::utilities::irootglob	(		tdirectory,
			pathname
	)

Return an iterator which yields the paths matching a pathname pattern.

The pattern may contain simple shell-style wildcards a la fnmatch.

Definition at line 575 of file utilities.py.

                                   :
    """Return an iterator which yields the paths matching a pathname pattern.

    The pattern may contain simple shell-style wildcards a la fnmatch.

    """
    if not has_glob_magic(pathname):
        if tdirectory.Get(pathname):
            yield pathname
        return
    dirname, basename = os.path.split(pathname)
    if has_glob_magic(dirname):
        dirs = irootglob(tdirectory, dirname)
    else:
        dirs = [dirname]
    if has_glob_magic(basename):
        glob_in_dir = _rootglob1
    else:
        glob_in_dir = _rootglob0
    for dirname in dirs:
        for name in glob_in_dir(tdirectory, dirname, basename):
            yield os.path.join(dirname, name)

def python::rootplot::utilities::loadROOT

(

batch = True

)

Define additional helping functions.

Definition at line 433 of file utilities.py.

                        :
    ## We need to temporarily change sys.argv so that ROOT doesn't intercept 
    ## options from the command-line
    saved_argv = sys.argv[:]
    argstring = ' '.join(sys.argv)
    sys.argv = [sys.argv[0]]
    try:
        import ROOT
    except ImportError:
        print """\
The program was unable to access PyROOT.  Usually, this just requires switching
to the same major version of python that used when compiling ROOT.  To
determine which version that is, try the following command:
    root -config 2>&1 | tr ' ' '\\n' | egrep 'python|PYTHON'
If this is different from the python version you are currently using, try
changing your PATH to point to the new one."""
        sys.exit(1)
    ## Enter batch mode, unless outputting to C macros
    ## There is a bug in pyROOT that fails to export colors in batch mode
    if batch:
        ROOT.gROOT.SetBatch()
    ROOT.gErrorIgnoreLevel = ROOT.kWarning
    ## PyROOT picks up ~/.rootlogon if it exists, but not ./rootlogon.C 
    if os.path.exists('rootlogon.C'):
        ROOT.gROOT.Macro('rootlogon.C')
    sys.argv = saved_argv[:]
    return ROOT

def python::rootplot::utilities::ls

(

directory = None

)

Return a python list of ROOT object names from the given directory.

Definition at line 408 of file utilities.py.

Referenced by FWPFClusterRPZProxyBuilder::build(), FWBeamSpotProxyBuilder::build(), FWPFClusterRPZUtils::buildRhoPhiClusterLineSet(), FWPFClusterRPZUtils::buildRhoZClusterLineSet(), L1TSync::certifyLSBlock(), CompositeLogicalTrajectoryFilter::CompositeLogicalTrajectoryFilter(), L1TSync::doFractionInSync(), L1TRate::endLuminosityBlock(), FUShmReader::fillRawData(), IdealCastorTrapezoid::getCorners(), IdealZDCTrapezoid::getCorners(), evf::FWEPWrapper::getTriggerReport(), FWBeamSpotProxyBuilder::localModelChanges(), ls_cert_type(), lsbs_cert(), main(), nlumis(), AlpgenSource::readAlpgenEvent(), lumi::TRGScalers2DB::retrieveData(), BeamHaloPairGenerator::run(), GenericPairGenerator::run(), GenericTripletGenerator::run(), evf::FUShmRawCell::setLumiSection(), DIPLumiDetail::setOrigin(), DIPLumiSummary::setOrigin(), FWPFClusterRPZProxyBuilder::sharedBuild(), TT6CMNSubtractor::subtract_(), IteratedMedianCMNSubtractor::subtract_(), evf::FUEventProcessor::supervisor(), evf::fuep::TriggerReportHelpers::triggerReportUpdate(), SimpleCosmicBONSeeder::triplets(), stor::StreamsMonitorCollection::EndOfRunReport::updateLatestWrittenLumiSection(), and DTTimeEvolutionHisto::updateTimeSlot().

                      :
    """Return a python list of ROOT object names from the given directory."""
    if directory == None:
        keys = ROOT.gDirectory.GetListOfKeys()
    else:
        keys = ROOT.gDirectory.GetDirectory(directory).GetListOfKeys()
    key = keys[0]
    names = []
    while key:
        obj = key.ReadObj()
        key = keys.After(key)
        names.append(obj.GetName())
    return names

def python::rootplot::utilities::process_bin_labels

(

binlabels

)

Definition at line 484 of file utilities.py.

                                 :
    has_labels = False
    for binlabel in binlabels:
        if binlabel:
            has_labels = True
    if has_labels:
        return binlabels
    else:
        return None

def python::rootplot::utilities::pwd

(

)

Return ROOT's present working directory.

Definition at line 422 of file utilities.py.

         :
    """Return ROOT's present working directory."""
    return ROOT.gDirectory.GetPath()

def python::rootplot::utilities::replace	(		string,
			replacements
	)

Modify a string based on a list of patterns and substitutions.

replacements should be a list of two-entry tuples, the first entry giving
a string to search for and the second entry giving the string with which
to replace it.  If replacements includes a pattern entry containing
'use_regexp', then all patterns will be treated as regular expressions
using re.sub.

Definition at line 461 of file utilities.py.

                                 :
    """
    Modify a string based on a list of patterns and substitutions.

    replacements should be a list of two-entry tuples, the first entry giving
    a string to search for and the second entry giving the string with which
    to replace it.  If replacements includes a pattern entry containing
    'use_regexp', then all patterns will be treated as regular expressions
    using re.sub.
    """
    if not replacements:
        return string
    if 'use_regexp' in [x for x,y in replacements]:
        for pattern, repl in [x for x in replacements
                              if x[0] != 'use_regexp']:
            string = re.sub(pattern, repl, string)
    else:
        for pattern, repl in replacements:
            string = string.replace(pattern, repl)
    if re.match(_all_whitespace_string, string):
        return ""
    return string

def python::rootplot::utilities::rootglob	(		tdirectory,
			pathname
	)

Return a list of paths matching a pathname pattern.

The pattern may contain simple shell-style wildcards a la fnmatch.

>>> import rootplot.utilities
>>> f = rootplot.utilities.testfile()
>>> rootglob(f, '*')
['dir1', 'dir2', 'dir3', 'dir4']
>>> rootglob(f, 'dir1/*')
['dir1/hist1', 'dir1/hist2', 'dir1/hist3', 'dir1/hist4']
>>> rootglob(f, '*/hist1')
['dir1/hist1', 'dir2/hist1', 'dir3/hist1', 'dir4/hist1']
>>> rootglob(f, 'dir1/hist[1-2]')
['dir1/hist1', 'dir1/hist2']

Definition at line 557 of file utilities.py.

                                  :
    """Return a list of paths matching a pathname pattern.

    The pattern may contain simple shell-style wildcards a la fnmatch.

    >>> import rootplot.utilities
    >>> f = rootplot.utilities.testfile()
    >>> rootglob(f, '*')
    ['dir1', 'dir2', 'dir3', 'dir4']
    >>> rootglob(f, 'dir1/*')
    ['dir1/hist1', 'dir1/hist2', 'dir1/hist3', 'dir1/hist4']
    >>> rootglob(f, '*/hist1')
    ['dir1/hist1', 'dir2/hist1', 'dir3/hist1', 'dir4/hist1']
    >>> rootglob(f, 'dir1/hist[1-2]')
    ['dir1/hist1', 'dir1/hist2']
    """
    return list(irootglob(tdirectory, pathname))

def python::rootplot::utilities::testfile

(

)

Definition at line 521 of file utilities.py.

              :
    outfile = ROOT.TFile("test.root", "recreate")
    for i in range(4):
        d = outfile.mkdir("dir%i" % (i + 1))
        d.cd()
        for j in range(4):
            hist = ROOT.TH1F("hist%i" % (j + 1), "A Histogram", 10, 0, 10)
            hist.Fill(j)
            hist.Write()
    outfile.Write()
    return outfile

def python::rootplot::utilities::wilson_interval	(		numerator_array,
			denominator_array
	)

Definition at line 494 of file utilities.py.

                                                       :
    eff, upper_err, lower_err = [], [], []
    for n, d in zip(numerator_array, denominator_array):
        try:
            p = float(n) / d
            s = math.sqrt(p * (1 - p) / d + 1 / (4 * d * d))
            t = p + 1 / (2 * d)
            eff.append(p)
            upper_err.append(-p + 1/(1 + 1/d) * (t + s))
            lower_err.append(+p - 1/(1 + 1/d) * (t - s))
        except ZeroDivisionError:
            eff.append(0)
            upper_err.append(0)
            lower_err.append(0)
    return eff, upper_err, lower_err

---

Variable Documentation

string python::rootplot::utilities::__license__

Initial value:

'''\
Copyright (c) 2009-2010 Jeff Klukas <klukas@wisc.edu>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
'''

Definition at line 5 of file utilities.py.

tuple python::rootplot::utilities::glob_magic_check = re.compile('[*?[]')

Functions for globbing within root files.

Definition at line 535 of file utilities.py.