hdrValid.py

Go to the documentation of this file.

#!/usr/bin/env python
'''

Check for expected tree/branch in input file using RootInputFile.
Designed to check validity of output of MC jobs, both premix and mixed.
Also can compare expected vs actual number of entries in input file.

usage parameters: 

To use pre-defined tree list
   nuwa.py -l 5 --no-history  -m"hdrValid -t mixed" file.root
   nuwa.py -l 5 --no-history  -m"hdrValid -t premix" file.root
To use user-specified tree list
   nuwa.py -l 5 --no-history  -m"hdrValid -u Gen -u Sim" file.root
Note that no events need be processed to examine the tree/branch list.


To give compare an expected number of entries NENTRIES with the actual number
of entries ON A SINGLE INPUT FILE (not a list)
   nuwa.py -l 5 -n -1 --no-history -m"hdrValid -E NENTRIES" file.root


Note suppression of spurious output by -l 5 --no-history.

Note that if you specify a list of input files, all files must have
the same tree/branch structure or RootInputFile will complain when
evoked by Control.py

For general help:
   nuwa.py -m"hdrValid --help"
'''
#
# basic hists and checks of output 

__all__ = ['basic']

from DybPython.DybPythonAlg import DybPythonAlg
from GaudiPython import SUCCESS, FAILURE
from GaudiPython import gbl, loaddict

from DybPython.Util import irange
from GaudiKernel import SystemOfUnits as units
import PyCintex

from DybPython.Control import nuwa

debuglevel = 0
nExec = 0

class hdrValid(DybPythonAlg):

    def __init__(self,name):

        DybPythonAlg.__init__(self,name)
        return

    
    def initialize(self):
        print "Initializing ", self.name()
        status = DybPythonAlg.initialize(self)
        if status.isFailure(): return status
        global debuglevel, filetype, userTrees, keepgoing, expected
        dbglvl = int( debuglevel )

        if dbglvl>0: print self.name()," filetype",filetype

        # compose treename from base and trees given input filetype
        # OR create an empty treename and ignore trees in input file(s)
        # OR given trees by user on command line
        base = '/Event'
        if userTrees is None :
            if filetype.lower() == 'premix' :
                trees= ['Gen','Sim','SimReadout']
            elif filetype.lower() ==  'mixed' :
                trees= ['Gen','Sim','Readout']
            elif (filetype.lower() == 'none') or (filetype.lower() == 'ignore'):
                trees = []
            else:
                print self.name()," ERROR. Invalid input file type",filetype
                return FAILURE
        else:
            ''' User specified trees take precedence '''
            trees = userTrees
            if dbglvl>0: print self.name()," userTrees=",userTrees

        path = []
        for tree in trees:
            path.append(base + '/' + tree + '/' + tree + 'Header')

        if dbglvl>1: print self.name(),"path",path

        # get input streams
        streams = nuwa.opts.input_streams
        
        # make sure that # of executions in nuwa.py line is "-n -1" iff
        # we expect a certain number of executions
        if expected>-1 :
            if nuwa.opts.executions == -1 :
                pass
            else:
                print self.name(),"WARNING You expect",expected,"execution cycles in input file,",\
                    " but you specified `-n",nuwa.opts.executions,"` instead of `-n -1`"
        
        if dbglvl>1: 
            print self.name(),"streams",streams

        RootInputFile = gbl.RootInputFile

        nBad = 0
        nFiles = 0

        for key in streams :
            if dbglvl>0 : print self.name(),"key",key,"has",len(streams[key]),"entries"
            for fname in streams[key]:
                if dbglvl>0 : print "fname",fname
                nFiles += 1
                for treename in path: 
                    branchname = treename.strip(base).replace("/","_")
                    istat = RootInputFile.TestForObject(fname,treename, branchname)
                    if dbglvl> 0: print "treename, branchname, ClassID",treename,branchname,istat
                    if istat == 0 :
                        print self.name(),"FATAL ERROR in hdrValid. File",fname,\
                            "\n",self.name(),"ERROR in hdrValid tree",treename,"branch",branchname
                        nBad += 1
                        if not keepgoing : 
                            return FAILURE

        if expected>-1 and nFiles>1 :
            print self.name(),"WARNING Have",nFiles,"input files. You claim there are",expected,\
                "execution cycles for the job, not the file. Is this what you want?"

        if nBad == 0:
            print self.name(),"SUCCESS judges all",nFiles,"input files OK"
        else:
            print self.name(),"FATAL ERROR Found",nBad,"files with invalid header in a total of",nFiles,"files"
            return FAILURE

        return SUCCESS


    def execute(self):

        # ensure that we're dealing with an integer as the debug flag
        global debuglevel, nExec
        dbglvl = int( debuglevel )


        nExec += 1
        if dbglvl>0 : 
            if (nExec <= 10) or (nExec <=100 and nExec%10 == 0) or (nExec <=1000 and nExec%100 == 0) or (nExec<=10000 and nExec%1000 == 0) or (nExec%10000 == 0) :
                print self.name(),"execute() nExec=",nExec
        return SUCCESS
    
    def finalize(self):
        global debuglevel, filetype, userTrees, keepgoing, expected, nExec
        status = DybPythonAlg.finalize(self)

        print self.name()," Observed",nExec,"execution cycles"
        if expected > -1 :
            print "Finalizing ", self.name()
            if nExec == expected :
                print self.name(),"SUCCESS Observed number of executions",nExec,"is equal to expectation"
            else:
                print self.name(),"FATAL Observed number of executions",nExec,"is NOT equal to expectation",expected
                if nuwa.opts.executions is not -1:print self.name(),\
                        "This FATAL ERROR is not surprising because you specified `nuwa.py -n",nuwa.opts.executions,\
                        "` instead of `-n -1`"
                return FAILURE
        return status

def configure(argv=[]) : #None) :
    # note: if argv=None is specified as the arguments to configure, then
    #      the parser expects to have at least one option explicitly specified.
    #      with argv=[], one does not have specify any arguments (the defaults are used)

    # deal with input arguments
    from optparse import OptionParser
    parser = OptionParser() #usage=self.__doc__)
    parser.add_option("-d","--debug-level",
                      default=0,
                      help="Debug level 0=none, 1=more. [default: %default]")


    parser.add_option("-t","--type",type="str",
                      default="premix",
                      help="Type of input file. [default: %default]\n If `none` or `ignore`, then NO trees are checked in inputfile")


    parser.add_option("-u","--user-tree",type="str",action="append",
                      help="User-specified expected trees. Overrides --type.")

    parser.add_option("-k","--keep-going",action="store_true",
                      help="Keep-going even if one file does not have the correct headers. Good for examining a list of files.")

    parser.add_option("-E","--expected-entries",type="int",
                      default="-1",
                      help="Expected number of execution cycles. Ignored if <0. Not good for examining a list of files. [default: %default]")

    (options,args) = parser.parse_args(args=argv)

    # pass arguments using global variable
    global debuglevel, filetype, userTrees, keepgoing, expected, nExec
    debuglevel = options.debug_level
    filetype = options.type
    userTrees = options.user_tree
    keepgoing = options.keep_going
    expected = options.expected_entries

    return

def run(app):
    '''Configure and add this algorithm to job'''
    import sys

    app.ExtSvc += []
    hVal = hdrValid("hdrValid")
    app.addAlgorithm( hVal )

    pass