python.Events Class Reference

## Events

More...

Public Member Functions
def	__del__ (self)
def	__init__ (self, inputFiles='', kwargs)
def	__iter__ (self)
def	eventAuxiliary (self)
def	fileIndex (self)
def	fileIndicies (self)
def	getByLabel (self, args)
def	object (self)
def	secondaryFileIndex (self)
def	size (self)
def	to (self, entryIndex)
def	toBegin (self)

Private Member Functions
def	_createFWLiteEvent (self)
def	_next (self)
def	_parseOptions (self, options)
	Private Member Functions ##. More...
def	_toBeginCode (self)

Private Attributes
	_event
	_eventCounts
	_filenames
	_forceEvent
	_maxEvents
	Parse optional arguments ##. More...
	_mode
	_secondaryFilenames
	_tfile
	_toBegin
	_veryFirstTime

Detailed Description

## Events

Python interface to FWLite ChainEvent class

Definition at line 456 of file __init__.py.

Constructor & Destructor Documentation

__init__()

def python.Events.__init__	(		self,
			inputFiles = '',
			kwargs
	)

inputFiles    => Either a single filename or a list of filenames
Optional arguments:
forceEvent  => Use fwlite::Event IF there is only one file
maxEvents   => Maximum number of events to process

Definition at line 459 of file __init__.py.

    def __init__(self, inputFiles = '', **kwargs):
        """inputFiles    => Either a single filename or a list of filenames
        Optional arguments:
        forceEvent  => Use fwlite::Event IF there is only one file
        maxEvents   => Maximum number of events to process
        """        
        self._veryFirstTime      = True
        self._event              = 0
        self._eventCounts        = 0
        self._maxEvents          = 0
        self._forceEvent         = False
        self._mode               = None
        self._secondaryFilenames = None
        if isinstance (inputFiles, list):
            # it's a list
            self._filenames = inputFiles[:]
        elif isinstance (inputFiles, VarParsing):
            # it's a VarParsing object
            options = inputFiles
            self._maxEvents           = options.maxEvents
            self._filenames           = options.inputFiles
            self._secondaryFilenames  = options.secondaryInputFiles
        else:
            # it's probably a single string
            self._filenames = [inputFiles]
        
        if 'maxEvents' in kwargs:
            self._maxEvents = kwargs['maxEvents']
            del kwargs['maxEvents']
        if 'forceEvent' in kwargs:
            self._forceEvent = kwargs['forceEvent']
            del kwargs['forceEvent']
        if 'options' in kwargs:
            options = kwargs ['options']
            self._maxEvents           = options.maxEvents
            self._filenames           = options.inputFiles
            self._secondaryFilenames  = options.secondaryInputFiles
            del kwargs['options']
        # Since we deleted the options as we used them, that means
        # that kwargs should be empty.  If it's not, that means that
        # somebody passed in an argument that we're not using and we
        # should complain.
        if len (kwargs):
            raise RuntimeError("Unknown arguments %s" % kwargs)
        if not self._filenames:
            raise RuntimeError("No input files given")

__del__()

def python.Events.__del__

(

self

)

(Internal) Destructor

Definition at line 623 of file __init__.py.

References python.Events._event.

    def __del__ (self):
        """(Internal) Destructor"""
        # print "Goodbye cruel world, I'm leaving you today."
        del self._event
        # print "Goodbye, goodbye, goodbye."

Member Function Documentation

__iter__()

def python.Events.__iter__

(

self

)

Definition at line 585 of file __init__.py.

References python.Lumis._next(), python.Runs._next(), and python.Events._next().

    def __iter__ (self):
        return self._next()

_createFWLiteEvent()

def python.Events._createFWLiteEvent (   self )

private

(Internal) Creates an FWLite Event

Definition at line 630 of file __init__.py.

References python.Events._event, python.Lumis._filenames, python.Runs._filenames, python.Events._filenames, python.Events._forceEvent, python.Events._mode, python.Events._toBegin, python.Lumis._veryFirstTime, python.Runs._veryFirstTime, and python.Events._veryFirstTime.

Referenced by python.Events._next(), python.Events.getByLabel(), python.Events.size(), and python.Events.to().

    def _createFWLiteEvent (self):
        """(Internal) Creates an FWLite Event"""
        self._veryFirstTime = False
        self._toBegin = True
        if isinstance (self._filenames[0], ROOT.TFile):
            self._event = ROOT.fwlite.Event (self._filenames[0])
            self._mode = 'single'
            return self._mode
        if len (self._filenames) == 1 and self._forceEvent:
            self._tfile = ROOT.TFile.Open (self._filenames[0])
            self._event = ROOT.fwlite.Event (self._tfile)
            self._mode = 'single'
            return self._mode
        filenamesSVec = ROOT.vector("string") ()
        for name in self._filenames:
            filenamesSVec.push_back (name)
        if self._secondaryFilenames:
            secondarySVec =  ROOT.vector("string") ()
            for name in self._secondaryFilenames:
                secondarySVec.push_back (name)
            self._event = ROOT.fwlite.MultiChainEvent (filenamesSVec,
                                                       secondarySVec)
            self._mode = 'multi'
        else:
            self._event = ROOT.fwlite.ChainEvent (filenamesSVec)
            self._mode = 'chain'
        return self._mode

_next()

def python.Events._next (   self )

private

(Internal) Iterator internals

Definition at line 659 of file __init__.py.

References python.Events._createFWLiteEvent(), python.Events._event, python.Events._eventCounts, python.Events._maxEvents, python.Events._toBegin, python.Events._toBeginCode(), python.Lumis._veryFirstTime, python.Runs._veryFirstTime, and python.Events._veryFirstTime.

Referenced by python.Events.__iter__().

    def _next (self):
        """(Internal) Iterator internals"""
        if self._veryFirstTime:
            self._createFWLiteEvent()
        if self._toBegin:
            self._toBeginCode()
        while not self._event.atEnd() :
            yield self
            self._eventCounts += 1
            if self._maxEvents > 0 and self._eventCounts >= self._maxEvents:
                break
            # Have we been asked to go to the first event?
            if self._toBegin:
                self._toBeginCode()
            else:
                # if not, lets go to the next event
                self._event.__preinc__()
            

_parseOptions()

def python.Events._parseOptions (   self,   options  )

private

Private Member Functions ##.

(Internal) Parse options

Definition at line 612 of file __init__.py.

    def _parseOptions (self, options):
        """(Internal) Parse options"""

_toBeginCode()

def python.Events._toBeginCode (   self )

private

(Internal) Does actual work of toBegin() call

Definition at line 616 of file __init__.py.

Referenced by python.Events._next().

    def _toBeginCode (self):
        """(Internal) Does actual work of toBegin() call"""
        self._toBegin = False
        self._event.toBegin()
        self._eventCounts = 0

eventAuxiliary()

def python.Events.eventAuxiliary

(

self

)

Returns eventAuxiliary object

Definition at line 528 of file __init__.py.

References python.Events._event, python.Lumis._veryFirstTime, python.Runs._veryFirstTime, and python.Events._veryFirstTime.

    def eventAuxiliary (self):
        """Returns eventAuxiliary object"""
        if self._veryFirstTime:
            raise RuntimeError("eventAuxiliary() called before "\
                  "toBegin() or to()")
        return self._event.eventAuxiliary()

fileIndex()

def python.Events.fileIndex

(

self

)

Definition at line 589 of file __init__.py.

References python.Events._event.

Referenced by python.Events.fileIndicies().

    def fileIndex (self):
        if self._event:
            return self._event.fileIndex()
        else:
            # default non-existant value is -1.  Return something else
            return -2

fileIndicies()

def python.Events.fileIndicies

(

self

)

Definition at line 605 of file __init__.py.

References fwlite::LuminosityBlockBase.fileIndex(), fwlite::RunBase.fileIndex(), fwlite::EventBase.fileIndex(), fwlite::ChainEvent.fileIndex(), fwlite::MultiChainEvent.fileIndex(), python.Events.fileIndex(), fwlite::LuminosityBlockBase.secondaryFileIndex(), fwlite::RunBase.secondaryFileIndex(), fwlite::EventBase.secondaryFileIndex(), fwlite::MultiChainEvent.secondaryFileIndex(), and python.Events.secondaryFileIndex().

    def fileIndicies (self):
        return (self.fileIndex(), self.secondaryFileIndex())

getByLabel()

def python.Events.getByLabel	(		self,
			args
	)

Calls FWLite's getByLabel.  Called:
getByLabel (moduleLabel, handle)
getByLabel (moduleLabel, productInstanceLabel, handle),
getByLabel (moduleLabel, productInstanceLabel, processLabel, handle),
or
getByLabel ( (mL, pIL,pL), handle)

Definition at line 541 of file __init__.py.

References python.Events._createFWLiteEvent(), python.Events._event, python.Lumis._veryFirstTime, python.Runs._veryFirstTime, python.Events._veryFirstTime, submitPVResolutionJobs.count, caHitNtupletGeneratorKernels.if(), join(), and submitPVValidationJobs.split().

    def getByLabel (self, *args):
        """Calls FWLite's getByLabel.  Called:
        getByLabel (moduleLabel, handle)
        getByLabel (moduleLabel, productInstanceLabel, handle),
        getByLabel (moduleLabel, productInstanceLabel, processLabel, handle),
        or
        getByLabel ( (mL, pIL,pL), handle)
        """
        if self._veryFirstTime:
            self._createFWLiteEvent()        
        length = len (args)
        if length < 2 or length > 4:
            # not called correctly
            raise RuntimeError("Incorrect number of arguments")
        # handle is always the last argument
        argsList = list (args)
        handle = argsList.pop()
        if len(argsList)==1 :
            if( isinstance (argsList[0], tuple) or
                isinstance (argsList[0], list) ) :
                if len (argsList[0]) > 3:
                    raise RuntimeError("getByLabel Error: label tuple has too " \
                        "many arguments '%s'" % argsList[0])
                argsList = list(argsList[0])
            if( isinstance(argsList[0], str) and ":" in argsList[0] ):
                if argsList[0].count(":") > 3:
                    raise RuntimeError("getByLabel Error: label tuple has too " \
                        "many arguments '%s'" % argsList[0].split(":"))
                argsList = argsList[0].split(":")
        while len(argsList) < 3:
            argsList.append ('')
        (moduleLabel, productInstanceLabel, processLabel) = argsList
        labelString = "'" + "', '".join(argsList) + "'"
        if not handle._wrapper :
            handle._resetWrapper()
        handle._setStatus ( self._event.getByLabel( handle._typeInfoGetter(),
                                                    moduleLabel,
                                                    productInstanceLabel,
                                                    processLabel,
                                                    handle._addressOf() ),
                            labelString )
        return handle.isValid()

                    

object()

def python.Events.object

(

self

)

Returns event object

Definition at line 536 of file __init__.py.

References python.Events._event.

    def object (self):
        """Returns event object"""
        return self._event

secondaryFileIndex()

def python.Events.secondaryFileIndex

(

self

)

Definition at line 597 of file __init__.py.

References python.Events._event.

Referenced by python.Events.fileIndicies().

    def secondaryFileIndex (self):
        if self._event:
            return self._event.secondaryFileIndex()
        else:
            # default non-existant value is -1.  Return something else
            return -2

size()

def python.Events.size

(

self

)

Returns number of events

Definition at line 521 of file __init__.py.

References python.Events._createFWLiteEvent(), python.Events._event, python.Lumis._veryFirstTime, python.Runs._veryFirstTime, and python.Events._veryFirstTime.

Referenced by ntupleDataFormat._Collection.__iter__(), and ntupleDataFormat._Collection.__len__().

    def size (self):
        """Returns number of events"""
        if self._veryFirstTime:
            self._createFWLiteEvent()
        return self._event.size()

to()

def python.Events.to	(		self,
			entryIndex
	)

Jumps to event entryIndex

Definition at line 509 of file __init__.py.

References python.Events._createFWLiteEvent(), python.Events._event, python.Lumis._veryFirstTime, python.Runs._veryFirstTime, python.Events._veryFirstTime, and createfilelist.int.

    def to (self, entryIndex):
        """Jumps to event entryIndex"""
        if self._veryFirstTime:
            self._createFWLiteEvent()
        return self._event.to ( int(entryIndex) )

        

toBegin()

def python.Events.toBegin

(

self

)

Called to reset event loop to first event.

Definition at line 516 of file __init__.py.

    def toBegin (self):
        """Called to reset event loop to first event."""
        self._toBegin = True

Member Data Documentation

_event

python.Events._event

private

Definition at line 466 of file __init__.py.

Referenced by python.Events.__del__(), datamodel.Object.__getattr__(), datamodel.Collection.__getitem__(), python.Events._createFWLiteEvent(), python.Events._next(), python.Events.eventAuxiliary(), python.Events.fileIndex(), python.Events.getByLabel(), python.Events.object(), python.Events.secondaryFileIndex(), python.Events.size(), datamodel.Object.subObj(), and python.Events.to().

_eventCounts

python.Events._eventCounts

private

Definition at line 467 of file __init__.py.

Referenced by python.Events._next().

_filenames

python.Events._filenames

private

Definition at line 474 of file __init__.py.

Referenced by python.Events._createFWLiteEvent().

_forceEvent

python.Events._forceEvent

private

Definition at line 469 of file __init__.py.

Referenced by python.Events._createFWLiteEvent().

_maxEvents

python.Events._maxEvents

private

Parse optional arguments ##.

Definition at line 468 of file __init__.py.

Referenced by python.Events._next().

_mode

python.Events._mode

private

Definition at line 470 of file __init__.py.

Referenced by python.Events._createFWLiteEvent().

_secondaryFilenames

python.Events._secondaryFilenames

private

Definition at line 471 of file __init__.py.

_tfile

python.Events._tfile

private

Definition at line 639 of file __init__.py.

_toBegin

python.Events._toBegin

private

Definition at line 518 of file __init__.py.

Referenced by python.Events._createFWLiteEvent(), and python.Events._next().

_veryFirstTime

python.Events._veryFirstTime

private

Definition at line 465 of file __init__.py.

Referenced by python.Events._createFWLiteEvent(), python.Events._next(), python.Events.eventAuxiliary(), python.Events.getByLabel(), python.Events.size(), and python.Events.to().