CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Public Attributes | Private Member Functions
LumiList.LumiList Class Reference
Inheritance diagram for LumiList.LumiList:

Public Member Functions

def __add__
 
def __and__
 
def __contains__
 
def __init__
 
def __len__
 
def __or__
 
def __str__
 
def __sub__
 
def contains
 
def filterLumis
 
def getCMSSWString
 
def getCompactList
 
def getDuplicates
 
def getLumis
 
def getRuns
 
def getVLuminosityBlockRange
 
def removeRuns
 
def selectRuns
 
def writeJSON
 

Public Attributes

 compactList
 
 duplicates
 
 filename
 
 url
 

Private Member Functions

def _getLumiParts
 

Detailed Description

Deal with lists of lumis in several different forms:
Compact list:
    {
    '1': [[1, 33], [35, 35], [37, 47], [49, 75], [77, 130], [133, 136]],
    '2':[[1,45],[50,80]]
    }
    where the first key is the run number, subsequent pairs are
    ranges of lumis within that run that are desired
Runs and lumis:
    {
    '1': [1,2,3,4,6,7,8,9,10],
    '2': [1,4,5,20]
    }
    where the first key is the run number and the list is a list of
    individual lumi sections. This form also takes a list of these objects
    which can be much faster than LumiList += LumiList
Run  lumi pairs:
    [[1,1], [1,2],[1,4], [2,1], [2,5], [1,10]]
    where each pair in the list is an individual run&lumi
CMSSW representation:
    '1:1-1:33,1:35,1:37-1:47,2:1-2:45,2:50-2:80'
    The string used by CMSSW in lumisToProcess or lumisToSkip
    is a subset of the compactList example above

Definition at line 18 of file LumiList.py.

Constructor & Destructor Documentation

def LumiList.LumiList.__init__ (   self,
  filename = None,
  lumis = None,
  runsAndLumis = None,
  runs = None,
  compactList = None,
  url = None 
)
Constructor takes filename (JSON), a list of run/lumi pairs,
or a dict with run #'s as the keys and a list of lumis as the values, or just a list of runs

Definition at line 46 of file LumiList.py.

Member Function Documentation

def LumiList.LumiList.__add__ (   self,
  other 
)

Definition at line 192 of file LumiList.py.

Referenced by counter.Counter.__iadd__(), and average.Average.__iadd__().

def LumiList.LumiList.__and__ (   self,
  other 
)

Definition at line 144 of file LumiList.py.

def LumiList.LumiList.__contains__ (   self,
  runTuple 
)

Definition at line 373 of file LumiList.py.

def LumiList.LumiList.__len__ (   self)
Returns number of runs in list

Definition at line 196 of file LumiList.py.

def LumiList.LumiList.__or__ (   self,
  other 
)

Definition at line 175 of file LumiList.py.

def LumiList.LumiList.__str__ (   self)

Definition at line 216 of file LumiList.py.

def LumiList.LumiList.__sub__ (   self,
  other 
)

Definition at line 116 of file LumiList.py.

def LumiList.LumiList._getLumiParts (   self)
private
Turn compactList into a list of the format
[ 'R1:L1', 'R2:L2-R2:L3' ] which is used by getCMSSWString and getVLuminosityBlockRange

Definition at line 259 of file LumiList.py.

def LumiList.LumiList.contains (   self,
  run,
  lumiSection = None 
)
returns true if the run, lumi section passed in is contained
in this lumiList.  Input can be either:
- a single tuple of (run, lumi),
- separate run and lumi numbers
- a single run number (returns true if any lumi sections exist)

Definition at line 338 of file LumiList.py.

def LumiList.LumiList.filterLumis (   self,
  lumiList 
)
Return a list of lumis that are in compactList.
lumilist is of the simple form
[(run1,lumi1),(run1,lumi2),(run2,lumi1)]

Definition at line 200 of file LumiList.py.

def LumiList.LumiList.getCMSSWString (   self)
Turn compactList into a list of the format
R1:L1,R2:L2-R2:L3 which is acceptable to CMSSW LumiBlockRange variable

Definition at line 279 of file LumiList.py.

def LumiList.LumiList.getCompactList (   self)
Return the compact list representation

Definition at line 222 of file LumiList.py.

def LumiList.LumiList.getDuplicates (   self)
Return the list of duplicates found during construction as a LumiList

Definition at line 229 of file LumiList.py.

def LumiList.LumiList.getLumis (   self)
Return the list of pairs representation

Definition at line 236 of file LumiList.py.

def LumiList.LumiList.getRuns (   self)
return the sorted list of runs contained

Definition at line 252 of file LumiList.py.

def LumiList.LumiList.getVLuminosityBlockRange (   self,
  tracked = False 
)
Turn compactList into an (optionally tracked) VLuminosityBlockRange

Definition at line 290 of file LumiList.py.

def LumiList.LumiList.removeRuns (   self,
  runList 
)
removes runs from runList from collection

Definition at line 312 of file LumiList.py.

def LumiList.LumiList.selectRuns (   self,
  runList 
)
Selects only runs from runList in collection

Definition at line 324 of file LumiList.py.

def LumiList.LumiList.writeJSON (   self,
  fileName 
)
Write out a JSON file representation of the object

Definition at line 303 of file LumiList.py.

Member Data Documentation

LumiList.LumiList.compactList

Definition at line 51 of file LumiList.py.

LumiList.LumiList.duplicates

Definition at line 52 of file LumiList.py.

LumiList.LumiList.filename

Definition at line 54 of file LumiList.py.

LumiList.LumiList.url

Definition at line 58 of file LumiList.py.