python.Lumis Class Reference

## Lumis

More...

Public Member Functions
def	__del__ (self)
def	__init__ (self, inputFiles='', kwargs)
def	__iter__ (self)
def	aux (self)
def	getByLabel (self, args)
def	luminosityBlockAuxiliary (self)

Private Member Functions
def	_createFWLiteLumi (self)
	Private Member Functions ##. More...
def	_next (self)

Private Attributes
	_currFilename
	_filenames
	_lumi
	_lumiCounts
	_maxLumis
	Parse optional arguments ##. More...
	_secondaryFilenames
	_tfile
	_veryFirstTime

Detailed Description

## Lumis

Python interface to FWLite LuminosityBlock

Definition at line 141 of file __init__.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 143 of file __init__.py.

    def __init__ (self, inputFiles = '', **kwargs):
        self._lumi = None
        self._lumiCounts = 0
        self._tfile = None
        self._maxLumis = 0
        if isinstance (inputFiles, list):
            # it's a list
            self._filenames = inputFiles[:]
        elif isinstance (inputFiles, VarParsing):
            # it's a VarParsing object
            options = inputFiles
            self._maxLumis           = options.maxEvents
            self._filenames          = options.inputFiles
        else:
            # it's probably a single string
            self._filenames = [inputFiles]
        
        if 'maxEvents' in kwargs:
            self._maxLumis = kwargs['maxEvents']
            del kwargs['maxEvents']
        if 'options' in kwargs:
            options = kwargs ['options']
            self._maxLumis           = 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")
        if not self._createFWLiteLumi():
            # this shouldn't happen as you are getting nothing the
            # very first time out, but let's at least check to
            # avoid problems.
            raise RuntimeError("Never and information about Lumi")

__del__()

def python.Lumis.__del__

(

self

)

(Internal) Destructor

Definition at line 186 of file __init__.py.

References python.Lumis._lumi.

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

Member Function Documentation

__iter__()

def python.Lumis.__iter__

(

self

)

Definition at line 193 of file __init__.py.

References python.Lumis._next().

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

_createFWLiteLumi()

def python.Lumis._createFWLiteLumi (   self )

private

Private Member Functions ##.

(Internal) Creates an FWLite Lumi

Definition at line 257 of file __init__.py.

References python.Lumis._filenames, and python.Lumis._lumi.

Referenced by python.Lumis._next().

    def _createFWLiteLumi (self):
        """(Internal) Creates an FWLite Lumi"""
        # are there any files left?
        if not self._filenames:
            return False
        if self._lumi:
            del self._lumi
            self._lumi = None
        self._veryFirstTime = False
        self._currFilename = self._filenames.pop(0)
        #print "Opening file", self._currFilename
        if self._tfile:
            del self._tfile
        self._tfile = ROOT.TFile.Open (self._currFilename)
        self._lumi = ROOT.fwlite.LuminosityBlock (self._tfile);
        self._lumi.toBegin()
        return True

_next()

def python.Lumis._next (   self )

private

(Internal) Iterator internals

Definition at line 276 of file __init__.py.

References python.Lumis._createFWLiteLumi(), python.Lumis._lumi, python.Lumis._lumiCounts, and python.Lumis._maxLumis.

Referenced by python.Lumis.__iter__(), python.Runs.__iter__(), and python.Events.__iter__().

    def _next (self):
        """(Internal) Iterator internals"""
        while True:
            if self._lumi.atEnd():
                if not self._createFWLiteLumi():
                    # there are no more files here, so we are done
                    break
            yield self
            self._lumiCounts += 1
            if self._maxLumis > 0 and self._lumiCounts >= self._maxLumis:
                break
            self._lumi.__preinc__()
            
                    
        

aux()

def python.Lumis.aux

(

self

)

Definition at line 197 of file __init__.py.

References python.Lumis._lumi, and python.Lumis.luminosityBlockAuxiliary().

    def aux (self):
        try:
            return self._lumi.luminosityBlockAuxiliary()
        except:
            raise RuntimeError("Lumis.aux() called on object in invalid state")

getByLabel()

def python.Lumis.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 211 of file __init__.py.

References python.Lumis._lumi, 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)
        """
        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._lumi.getByLabel( handle._typeInfoGetter(),
                                                   moduleLabel,
                                                   productInstanceLabel,
                                                   processLabel,
                                                   handle._addressOf() ),
                            labelString )
        return handle.isValid()

luminosityBlockAuxiliary()

def python.Lumis.luminosityBlockAuxiliary

(

self

)

Definition at line 204 of file __init__.py.

References python.Lumis._lumi.

Referenced by python.Lumis.aux().

    def luminosityBlockAuxiliary (self):
        try:
            return self._lumi.luminosityBlockAuxiliary()
        except:
            raise RuntimeError("Lumis.luminosityBlockAuxiliary() called on object in invalid state")
        

Member Data Documentation

_currFilename

python.Lumis._currFilename

private

Definition at line 266 of file __init__.py.

_filenames

python.Lumis._filenames

private

Definition at line 150 of file __init__.py.

Referenced by python.Events._createFWLiteEvent(), python.Lumis._createFWLiteLumi(), and python.Runs._createFWLiteRun().

_lumi

python.Lumis._lumi

private

Definition at line 144 of file __init__.py.

Referenced by python.Lumis.__del__(), python.Lumis._createFWLiteLumi(), python.Lumis._next(), python.Lumis.aux(), python.Lumis.getByLabel(), and python.Lumis.luminosityBlockAuxiliary().

_lumiCounts

python.Lumis._lumiCounts

private

Definition at line 145 of file __init__.py.

Referenced by python.Lumis._next().

_maxLumis

python.Lumis._maxLumis

private

Parse optional arguments ##.

Definition at line 147 of file __init__.py.

Referenced by python.Lumis._next().

_secondaryFilenames

python.Lumis._secondaryFilenames

private

Definition at line 169 of file __init__.py.

_tfile

python.Lumis._tfile

private

Definition at line 146 of file __init__.py.

_veryFirstTime

python.Lumis._veryFirstTime

private

Definition at line 265 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().