Inheritance diagram for python.BeamSpotData.BeamSpotContainer:

Collaboration diagram for python.BeamSpotData.BeamSpotContainer:

Public Member Functions
	__init__ (self)
	initStatistics (self)
	__iter__ (self)
	next (self)
	__next__ (self)
	allData (self)
	selectedData (self)
	getDataCache (self)
	summary (self)
	cutSummary (self)

Public Attributes
int	runMin = 0
int	runMax = 9999999
list	runList = []
list	runListExclude = []
int	fillMin = 0
int	fillMax = 9999999
int	bcidMin = 0
int	bcidMax = 9999999
int	lbMin = 0
int	lbMax = 9999999999
int	timeMin = 0
int	timeMax = 2000000000
list	statusList = []
	acqFlag = None
str	grl = ''
	grlIOVs = None
int	previousGRLIndex = 0
	iter = None
int	nTot = 0
int	nSel = 0
int	selRunMin = 9999999
int	selRunMax = 0
int	selFillMin = 9999999
int	selFillMax = 0
int	selBcidMin = 9999999
int	selBcidMax = 0
int	selTimeMin = 2000000000
int	selTimeMax = -1

Detailed Description

Base class for containers of beam spot data such as ntuples or
   information stored in COOL. Derived classes must implement method
   allData() to iterate over all elements in the container.

Definition at line 745 of file BeamSpotData.py.

Constructor & Destructor Documentation

◆ init()

python.BeamSpotData.BeamSpotContainer.__init__ ( self )

Definition at line 750 of file BeamSpotData.py.

    def __init__(self):
        # Cuts for selecting entries in the container
        self.runMin = 0
        self.runMax = 9999999
        self.runList = []
        self.runListExclude = []        
        self.fillMin = 0
        self.fillMax = 9999999
        self.bcidMin = 0
        self.bcidMax = 9999999
        self.lbMin = 0
        self.lbMax = 9999999999
        self.timeMin = 0
        self.timeMax = 2000000000
        self.statusList = []
        self.acqFlag = None
        self.grl = ''
        self.grlIOVs = None
        self.previousGRLIndex = 0 # Cache last GRL index look up time
        
        # Iterator
        self.iter = None
 
        # Statistics on selected data
        self.initStatistics()
 

Member Function Documentation

◆ iter()

python.BeamSpotData.BeamSpotContainer.__iter__ ( self )

Iterator to iterate over selected elements in the container.

Definition at line 792 of file BeamSpotData.py.

    def __iter__(self):
        """Iterator to iterate over selected elements in the container."""
        self.iter = self.selectedData()
        return self
 

◆ next()

python.BeamSpotData.BeamSpotContainer.__next__ ( self )

Return next selected element in the container.

Definition at line 801 of file BeamSpotData.py.

    def __next__(self):
        """Return next selected element in the container."""
        return self.next()
 

◆ allData()

python.BeamSpotData.BeamSpotContainer.allData ( self )

Default generator to iterate over all data. Must be overridden by derived classes.

Reimplemented in python.BeamSpotData.BeamSpotCOOL, python.BeamSpotData.BeamSpotCSV, python.BeamSpotData.BeamSpotFinderNt, and python.BeamSpotData.BeamSpotNt.

Definition at line 805 of file BeamSpotData.py.

    def allData(self):
        """Default generator to iterate over all data. Must be overridden by derived classes."""
        raise StopIteration()
 

◆ cutSummary()

python.BeamSpotData.BeamSpotContainer.cutSummary ( self )

Get summary of cuts made when looping over selected data.

Definition at line 894 of file BeamSpotData.py.

    def cutSummary(self):
        """Get summary of cuts made when looping over selected data."""
        s = 'Cuts:\n'
        s += '    run                 %7i ... %7i\n' % (self.runMin,self.runMax)
        s += '    runList             %7s\n' % str(self.runList)
        s += '    runListExcluded     %7s\n' % str(self.runListExclude)        
        s += '    fill                %7i ... %7i\n' % (self.fillMin,self.fillMax)
        s += '    bcid                %7i ... %7i\n' % (self.bcidMin,self.bcidMax)
        s += '    LB                  %7i ... %7i\n' % (self.lbMin,self.lbMax)
        s += '    fit status          %7s\n' % str(self.statusList)
        s += '    %s - %s' % (time.strftime('%a %b %d %X %Z %Y',time.localtime(self.timeMin)),
                               time.strftime('%a %b %d %X %Z %Y',time.localtime(self.timeMax)))
        s += '   acquisition flag     %7s' % self.acqFlag 
        if self.grl:
            s += '    GRL                  %s\n' % self.grl
        return s
 
 
 

◆ getDataCache()

python.BeamSpotData.BeamSpotContainer.getDataCache ( self )

Get a cache of all data in the form of a dict of runs, where each element
   is a dict with a BeamSpotValue for each individual lumi blocks.

Definition at line 874 of file BeamSpotData.py.

    def getDataCache(self):
        """Get a cache of all data in the form of a dict of runs, where each element
           is a dict with a BeamSpotValue for each individual lumi blocks."""
        cache = {}
        for b in self:
            r = b.run
            if r not in cache:
                cache[r] = {}
            if b.lbEnd-b.lbStart > 500:
                print ('WARNING: Cannot cache LB range %i ... %i for run %i' % (b.lbStart,b.lbEnd,r))
            else:
                for i in range(b.lbStart,b.lbEnd+1):
                    if b.status in self.statusList or not self.statusList:
                        cache[r][i] = b
        return cache
 

◆ initStatistics()

python.BeamSpotData.BeamSpotContainer.initStatistics ( self )

Definition at line 776 of file BeamSpotData.py.

    def initStatistics(self):
        self.nTot = 0
        self.nSel = 0
        self.selRunMin = 9999999
        self.selRunMax = 0
        self.selFillMin = 9999999
        self.selFillMax = 0
        self.selBcidMin = 9999999
        self.selBcidMax = 0
        self.selTimeMin = 2000000000
        self.selTimeMax = -1
 

◆ next()

python.BeamSpotData.BeamSpotContainer.next ( self )

Return next selected element in the container.

Definition at line 797 of file BeamSpotData.py.

    def next(self):
        """Return next selected element in the container."""
        return next(self.iter)
 

◆ selectedData()

python.BeamSpotData.BeamSpotContainer.selectedData ( self )

Generator to iterate over selected elements in the container.

Definition at line 809 of file BeamSpotData.py.

    def selectedData(self):
        """Generator to iterate over selected elements in the container."""
        self.initStatistics()
 
        self.previousGRLIndex = 0
 
        for b in self.allData():
            self.nTot +=1
            if b.run<self.runMin: continue
            if b.run>self.runMax: continue
            if self.runList and b.run not in self.runList: continue
            if self.runListExclude and b.run in self.runListExclude: continue
            if b.fill<self.fillMin: continue
            if b.fill>self.fillMax: continue
            if b.bcid<self.bcidMin: continue
            if b.bcid>self.bcidMax: continue
            if b.lbStart<self.lbMin: continue
            if b.lbEnd-1>self.lbMax: continue   # lbEnd is exclusive
            if b.timeStart<self.timeMin: continue
            if b.timeEnd>self.timeMax: continue
            if self.statusList and b.status not in self.statusList: continue            
            #if self.acqFlag is not None and b.acquisitionFlag != self.acqFlag: continue
            
            if self.grl:
                # Check if in GRL
                from DQUtils.sugar import RANGEIOV_VAL, RunLumi
                from DQUtils import IOVSet
 
                # Get IoVs from GRL
                if self.grlIOVs is None:
                    self.grlIOVs = IOVSet.from_grl(self.grl)
 
                idx = self.previousGRLIndex
 
                # Get current IoV
                test_iov = RANGEIOV_VAL(RunLumi(b.run, b.lbStart), RunLumi(b.run, b.lbEnd)) # COOL convention, ie lbEnd is exclusive
 
                # Search for IoV in GRL IoVs
                for i, iov in enumerate(self.grlIOVs[idx:]):
                    if (test_iov.since >= iov.since and test_iov.until <= iov.until):
                        self.previousGRLIndex = idx + i
                        break
                else:
                    # Only if don't break ->  IOV not found so skip
                    continue
 
 
            self.nSel += 1
            self.selRunMin = min(self.selRunMin,b.run)
            self.selRunMax = max(self.selRunMax,b.run)
            self.selFillMin = min(self.selFillMin,b.fill)
            self.selFillMax = max(self.selFillMax,b.fill)
            self.selBcidMin = min(self.selBcidMin,b.bcid)
            self.selBcidMax = max(self.selBcidMax,b.bcid)
            self.selTimeMin = min(self.selTimeMin,b.timeStart)
            self.selTimeMax = max(self.selTimeMax,b.timeEnd)
            yield b
        print ('\n%i entries selected out of total of %i entries in ntuple:' % (self.nSel,self.nTot))
        print ('... runs   %6i - %6i' % (self.selRunMin,self.selRunMax))
        print ('... fills  %6i - %6i' % (self.selFillMin,self.selFillMax))
        print ('... bcids  %6i - %6i' % (self.selBcidMin,self.selBcidMax))
        print ('... %s - %s' % (time.strftime('%a %b %d %X %Z %Y',time.localtime(self.selTimeMin)),
                               time.strftime('%a %b %d %X %Z %Y',time.localtime(self.selTimeMax))))
        print()
 

◆ summary()

python.BeamSpotData.BeamSpotContainer.summary ( self )

Get one-line info of Ntuple. Should be overridden by derived classes.

Reimplemented in python.BeamSpotData.BeamSpotCOOL, python.BeamSpotData.BeamSpotCSV, python.BeamSpotData.BeamSpotFinderNt, and python.BeamSpotData.BeamSpotNt.

Definition at line 890 of file BeamSpotData.py.

    def summary(self):
        """Get one-line info of Ntuple. Should be overridden by derived classes."""
        return "BeamSpotContainer base class"
 

Member Data Documentation

◆ acqFlag

python.BeamSpotData.BeamSpotContainer.acqFlag = None

Definition at line 765 of file BeamSpotData.py.

◆ bcidMax

int python.BeamSpotData.BeamSpotContainer.bcidMax = 9999999

Definition at line 759 of file BeamSpotData.py.

◆ bcidMin

int python.BeamSpotData.BeamSpotContainer.bcidMin = 0

Definition at line 758 of file BeamSpotData.py.

◆ fillMax

int python.BeamSpotData.BeamSpotContainer.fillMax = 9999999

Definition at line 757 of file BeamSpotData.py.

◆ fillMin

int python.BeamSpotData.BeamSpotContainer.fillMin = 0

Definition at line 756 of file BeamSpotData.py.

◆ grl

str python.BeamSpotData.BeamSpotContainer.grl = ''

Definition at line 766 of file BeamSpotData.py.

◆ grlIOVs

python.BeamSpotData.BeamSpotContainer.grlIOVs = None

Definition at line 767 of file BeamSpotData.py.

◆ iter

python.BeamSpotData.BeamSpotContainer.iter = None

Definition at line 771 of file BeamSpotData.py.

◆ lbMax

int python.BeamSpotData.BeamSpotContainer.lbMax = 9999999999

Definition at line 761 of file BeamSpotData.py.

◆ lbMin

int python.BeamSpotData.BeamSpotContainer.lbMin = 0

Definition at line 760 of file BeamSpotData.py.

◆ nSel

python.BeamSpotData.BeamSpotContainer.nSel = 0

Definition at line 778 of file BeamSpotData.py.

◆ nTot

python.BeamSpotData.BeamSpotContainer.nTot = 0

Definition at line 777 of file BeamSpotData.py.

◆ previousGRLIndex

int python.BeamSpotData.BeamSpotContainer.previousGRLIndex = 0

Definition at line 768 of file BeamSpotData.py.

◆ runList

list python.BeamSpotData.BeamSpotContainer.runList = []

Definition at line 754 of file BeamSpotData.py.

◆ runListExclude

list python.BeamSpotData.BeamSpotContainer.runListExclude = []

Definition at line 755 of file BeamSpotData.py.

◆ runMax

int python.BeamSpotData.BeamSpotContainer.runMax = 9999999

Definition at line 753 of file BeamSpotData.py.

◆ runMin

int python.BeamSpotData.BeamSpotContainer.runMin = 0

Definition at line 752 of file BeamSpotData.py.

◆ selBcidMax

python.BeamSpotData.BeamSpotContainer.selBcidMax = 0

Definition at line 784 of file BeamSpotData.py.

◆ selBcidMin

python.BeamSpotData.BeamSpotContainer.selBcidMin = 9999999

Definition at line 783 of file BeamSpotData.py.

◆ selFillMax

python.BeamSpotData.BeamSpotContainer.selFillMax = 0

Definition at line 782 of file BeamSpotData.py.

◆ selFillMin

python.BeamSpotData.BeamSpotContainer.selFillMin = 9999999

Definition at line 781 of file BeamSpotData.py.

◆ selRunMax

python.BeamSpotData.BeamSpotContainer.selRunMax = 0

Definition at line 780 of file BeamSpotData.py.

◆ selRunMin

python.BeamSpotData.BeamSpotContainer.selRunMin = 9999999

Definition at line 779 of file BeamSpotData.py.

◆ selTimeMax

python.BeamSpotData.BeamSpotContainer.selTimeMax = -1

Definition at line 786 of file BeamSpotData.py.

◆ selTimeMin

python.BeamSpotData.BeamSpotContainer.selTimeMin = 2000000000

Definition at line 785 of file BeamSpotData.py.

◆ statusList

list python.BeamSpotData.BeamSpotContainer.statusList = []

Definition at line 764 of file BeamSpotData.py.

◆ timeMax

int python.BeamSpotData.BeamSpotContainer.timeMax = 2000000000

Definition at line 763 of file BeamSpotData.py.

◆ timeMin

int python.BeamSpotData.BeamSpotContainer.timeMin = 0

Definition at line 762 of file BeamSpotData.py.

The documentation for this class was generated from the following file:

BeamSpotData.py

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __iter__()

◆ __next__()

◆ allData()

◆ cutSummary()

◆ getDataCache()

◆ initStatistics()

◆ next()

◆ selectedData()

◆ summary()

Member Data Documentation

◆ acqFlag

◆ bcidMax

◆ bcidMin

◆ fillMax

◆ fillMin

◆ grl

◆ grlIOVs

◆ iter

◆ lbMax

◆ lbMin

◆ nSel

◆ nTot

◆ previousGRLIndex

◆ runList

◆ runListExclude

◆ runMax

◆ runMin

◆ selBcidMax

◆ selBcidMin

◆ selFillMax

◆ selFillMin

◆ selRunMax

◆ selRunMin

◆ selTimeMax

◆ selTimeMin

◆ statusList

◆ timeMax

◆ timeMin

◆ init()

◆ iter()

◆ next()